文档中心
即时通讯
服务端 API
消息相关
导入单聊消息

导入单聊消息

更新时间：2024-04-30 10:55

描述

如果您正使用其他即时通讯服务并希望接入 ZIM，可调用此接口，向 ZIM 导入用户的历史单聊消息（按时间顺序）。

一个单聊会话存在两个用户（用户 A、B）。用户 A 可能删除了部分消息，导致用户 A 在此会话可以看到的消息列表与用户 B 的不同，因此，对于同一个单聊会话，需要为用户 A、B 分别调用此接口。

接口原型

请求方法：POST
请求地址：https://zim-api.zego.im/?Action=ImportPeerMsg
传输协议：HTTPS
调用频率限制：20 次/秒。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
FromUserId	String	是	消息发送方的用户 ID（已注册）。
ToUserId	String	是	消息接收方的用户 ID（已注册）。
MessageType	Number	是	消息类型，单聊会话的适用类型请参考 MessageBody 说明，导入消息时不支持信令消息。
Priority	Number	是	消息优先级，取值如下： 1：低。 2：中。 3：高。
MessageBody	Object	是	消息内容，具体参数格式请参考 MessageBody 说明，不支持离线推送 OfflinePush。
SubMsgType	Number	否（但当 MessageType 为自定义消息时，必选）	具体的自定义类型。值由您定义，取值范围为 [0,200]。
SearchedContent	String	否	自定义消息的检索字段。当 MessageType 为自定义消息时，才可填写此字段，长度上限默认为 64 字节。此字段作用于客户端，除非填写了此字段，否则无法通过客户端搜索到关联的自定义消息。
SendMessageTime	Number	否	消息发送时间戳（Unix，毫秒级别）。请按照发送时间从前到后的顺序进行导入。传 0 或不传：取“当前时间”。其他值：最早可取“当前时间 - 套餐包规定的历史消息保存天数（详情请参考计费说明 - 版本说明） * 86400000”，最晚不得晚于“当前时间”。不能早于套餐包规定的历史消息保存天数（详情请参考计费说明 - 版本说明），也不能晚于当前时间。
ImportedUserId	String	是	必须是 FromUserId 或 ToUserId中的一个，代表导入的是谁的单聊会话消息列表。

FromUserId、ToUserId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。

FromUserId、ToUserId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。
为了给开发者带来更好的体验，ZEGO 推荐开发者使用最新版本的 SDK。
如果发送方请求发送 MessageType 为 1 的文本消息，则发送方对应的客户端（SDK 版本需为 2.7.0 或以上）也会收到该消息。
对于发送和接收 MessageType 为 200 的自定义消息，发送方和接收放对应的客户端的 SDK 版本需为 2.8.0 或以上。
如果接收端的 SDK 版本介乎 [2.0.0, 2.8.0) 区间，可以收到自定义消息时，但会显示此消息类型为未知，且无法获取信息内容。如需获取此条消息，请将 SDK 升级为 2.8.0 或以上版本。
如果接收端的 SDK 版本为 1.x.x 版本，则无法收到自定义消息，也不会收到未知消息。

请求示例

请求地址 URL：

https://zim-api.zego.im/?Action=ImportPeerMsg
&<公共请求参数>

请求消息体：

{
    "FromUserId": "u1",
    "ToUserId": "u2",
    "MessageType": 200,
    "Priority": 1,
    "MessageBody": {
        "Message": "hello world",
        "ExtendedData": "s"
    },
    "SubMsgType": 110,
    "SearchedContent": "ex",
    "SendMessageTime": 123,
    "ImportedUserId": "u1"
}

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
MsgId	String	消息 ID。
MsgSeq	Number	消息 seq。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "MsgId": "6654861479614",
    "MsgSeq": 1
}

验证效果

成功导入消息后，可调用 ZIM 服务端接口查询单聊会话消息列表，确认用户的单聊会话消息是否导入完整。

返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
660400001	输入的消息大小超出限制。	请检查输入的消息大小。