logo
即时通讯
机器人
ZIM Audio
当前页

导入单聊消息

POST

https://zim-api.zego.im/

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

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

说明

参数 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 版本,则无法收到自定义消息,也不会收到未知消息。

说明
调用频率限制:20 次/秒。

验证效果

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

Request

Query Parameters

    Action string必填

    可选值: [ImportPeerMsg]

    接口原型参数

    https://zim-api.zego.im/?Action=ImportPeerMsg

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    消息发送方的用户 ID。

    ToUserId string必填

    可选值: <= 32 characters

    消息接收方的用户 ID。

    MessageType number必填

    消息类型,单聊会话的适用类型请参考 MessageBody 说明

    注意

    不支持信令消息。

    Priority number必填

    可选值: [1, 2, 3]

    消息优先级(详情请参考 基本概念介绍 - 消息优先级),取值如下:

    • 1:低。
    • 2:中。
    • 3:高。
    MessageBody object必填

    消息内容,具体参数格式请参考 MessageBody 说明

    注意

    不支持 OfflinePushHasReceipt 字段。

    SubMsgType number

    具体的自定义类型。值由您定义,取值范围为 [0,200]。当 MessageType 为自定义消息时,必填。

    SearchedContent string

    自定义消息的检索字段。当 MessageType 为自定义消息时,才可填写此字段,长度上限默认为 64 字节。此字段作用于客户端,除非填写了此字段,否则无法通过客户端搜索到关联的自定义消息。

    SendMessageTime number

    消息发送时间戳(Unix,毫秒级别)。请按照发送时间从前到后的顺序进行导入。

    • 传 0 或不传:取"当前时间"。
    • 其他值:最早可取"当前时间 - 套餐包规定的历史消息保存天数(详情请参考 计费说明 - 版本差异) * 86400000",最晚不得晚于"当前时间"。

    不能早于套餐包规定的历史消息保存天数(详情请参考 计费说明 - 版本差异),也不能晚于当前时间。

    ImportedUserId string必填

    必须是 FromUserId 或 ToUserId中的一个,代表导入的是谁的单聊会话消息列表。

Responses

OK
Schema
    Code number

    返回码。

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

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

    请求结果的说明信息。

    RequestId string

    请求 ID。

    MsgId string

    消息 ID。

    MsgSeq number

    消息 seq。


ZEGO 签名生成器
Request
折叠所有
Base URL
https://zim-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
Body必填
{
"FromUserId": "u1",
"ToUserId": "u2",
"MessageType": 200,
"Priority": 1,
"MessageBody": {
"Message": "hello world",
"ExtendedData": "s"
},
"SubMsgType": 110,
"SearchedContent": "ex",
"SendMessageTime": 123,
"ImportedUserId": "u1"
}
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

撤回房间消息

Next

导入群聊消息

当前页

返回到顶部