tencent cloud

功能说明

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

接口调用说明

适用的群组类型

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

说明：

AVChatRoom（直播群）不支持导入群消息，对此类型的群组进行操作时会返回10007错误；因为此类型群组所适用的场景不支持查看入群前的历史消息，所以没有提供这一功能。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/import_group_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

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

{
    "GroupId": "@TGS#2C5SZEAEF",
    "RecentContactFlag":1,// 表示会触发会话更新（avchatroom 群不支持）
    "MsgList": [
        {
            "From_Account": "leckie", // 指定消息发送者
            "SendTime":1620808101,
            "Random": 8912345, // 消息随机数（可选）
            "MsgBody": [ // 消息体，由一个 element 数组组成，详见 TIMMessage 消息对象
                {
                    "MsgType": "TIMTextElem", // 文本
                    "MsgContent": {
                        "Text": "red packet"
                    }
                },
                {
                    "MsgType": "TIMFaceElem", // 表情
                    "MsgContent": {
                        "Index": 6,
                        "Data": "abc\u0000\u0001"
                    }
                }
            ]
        },
        {
            "From_Account": "peter", // 指定消息发送者
            "SendTime":1620892821,
            "MsgBody": [ // 消息体，由一个 element 数组组成，详见 TIMMessage 消息对象
                {
                    "MsgType": "TIMTextElem", // 文本
                    "MsgContent": {
                        "Text": "red packet"
                    }
                }
            ]
        }

    ]
}

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ImportMsgResult": [
        {
            "MsgSeq": 1,
            "MsgTime": 1620808101,
            "Result": 0
        },
        {
            "MsgSeq": 2,
            "MsgTime": 1620892821,
            "Result": 0
        },
    ]
}

应答包字段说明

错误码说明

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

接口调试工具

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

参考

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