导入群消息

最近更新时间:2019-08-02 18:36:48

功能说明

  • 该 API 接口的作用是导入群组的消息,不会触发回调、不会下发通知。
  • 当 App 需要从其他即时通信系统迁移到即时通信 IM 时,使用该协议导入存量群消息数据。

接口调用说明

适用的群组类型

群组类型 支持此 REST API
私有群(Private)
公开群(Public)
聊天室(ChatRoom)
音视频聊天室(AVChatRoom) 否(见下方说明)
在线成员广播大群(BChatRoom) 否(见下方说明)

即时通信 IM 内置以上五种群组类型,详情请参阅 群组系统

说明:

音视频聊天室和在线成员广播大群不支持导入群消息,对这两种类型的群组进行操作时会返回10007错误;因为这两种类型群组所适用的场景一般不需要历史消息,所以没有提供这一功能。

请求 URL 示例

https://console.tim.qq.com/v4/group_open_http_svc/import_group_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/group_open_http_svc/import_group_msg 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

批量导入群消息,一次最多导入20条。
使用本接口导入消息后所有成员的未读计数都会变成0,如果要保留未读计数,请在导入所有消息后再导入群成员或者设置成员未读计数。
导入的消息必须按照时间戳递增的顺序导入,且导入消息的时间戳必须小于当前时间,并大于建群时间和当前群内最新一条消息的时间,否则会失败。

{
    "GroupId": "@TGS#2C5SZEAEF",
    "MsgList": [
        {
            "From_Account": "leckie", // 指定消息发送者
            "SendTime":1448357837,
            "Random": 8912345, // 消息随机数(可选)
            "MsgBody": [ // 消息体,由一个 element 数组组成,详见 TIMMessage 消息对象
                {
                    "MsgType": "TIMTextElem", // 文本
                    "MsgContent": {
                        "Text": "red packet"
                    }
                },
                {
                    "MsgType": "TIMFaceElem", // 表情
                    "MsgContent": {
                        "Index": 6,
                        "Data": "abc\u0000\u0001"
                    }
                }
            ]
        },
        {
            "From_Account": "peter", // 指定消息发送者
            "SendTime":1448357837,
            "MsgBody": [ // 消息体,由一个 element 数组组成,详见 TIMMessage 消息对象
                {
                    "MsgType": "TIMTextElem", // 文本
                    "MsgContent": {
                        "Text": "red packet"
                    }
                }
            ]
        }

    ]
}

请求包字段说明

字段 类型 属性 说明
GroupId String 必填 要导入消息的群 ID
MsgList String 必填 导入的消息列表
From_Account String 必填 指定消息发送者
SendTime Integer 必填 消息发送时间
Random Integer 选填 32 位随机数;如果5分钟内两条消息的随机值相同,后一条消息将被当做重复消息而丢弃
MsgBody Object 必填 TIM 消息,详情请参阅 TIMMsgElement对象的定义
MsgType String 必填 TIM 消息对象类型,目前支持的消息对象包括: TIMTextElem(文本消息),TIMFaceElem(表情消息),TIMLocationElem(位置消息),TIMCustomElem(自定义消息)
MsgContent Object 必填 MsgContent 为 TIM 消息对象, 详情可参阅 TIMMsgElement对象的定义

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ImportMsgResult": [
        {
            "Result": 0,
            "MsgSeq": 1,
            "MsgTime": 1449454106
        },
        {
            "Result": 0,
            "MsgSeq": 2,
            "MsgTime": 1449454116
        },
        {
            "Result": 0,
            "MsgSeq": 3,
            "MsgTime": 1449454106
        },
        {
            "Result": 0,
            "MsgSeq": 4,
            "MsgTime": 1449454116
        }
    ]
}

应答包字段说明

字段 类型 说明
ActionStatus String 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorInfo String 错误信息
ErrorCode Integer 错误码,0表示成功,非0表示失败
ImportMsgResult Array 具体的消息导入结果
Result Integer 单条消息导入结果
  • 0表示单条消息成功
  • 10004表示单条消息发送时间无效
  • 80001表示单条消息包含脏字,拒绝存储此消息
  • 80002表示为消息内容过长,目前支持8000字节的消息,请调整消息长度
MsgSeq Integer 给消息分配的 seq
MsgTime Integer 消息的时间戳

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 含义说明
10004 参数非法,请根据错误描述检查请求是否正确
10007 操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限
10010 群组不存在,或者曾经存在过,但是目前已经被解散
10015 操群组 ID 非法,请检查群组 ID 是否填写正确
10020 消息内容过长,目前最大支持8000字节的消息,请调整消息长度

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

设置成员未读消息计数(v4/group_open_http_svc/set_unread_msg_num