查询消息

描述

本接口支持查询单个指定会话（群聊、单聊）中的多条消息。

接口原型

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

注意
本接口的频率限制是 20 条消息/秒，而非 20 次/秒。

请求参数

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

参数	类型	是否必选	描述
FromUserId	String	是	用户的 UserID（已在客户端调用 `login` 方法登录 ZIM 服务，或已调用服务端 API 完成注册）。查询单聊会话消息时，此处填入任一参与用户的 userID。查询群聊会话消息时，此处可填入任意已注册用户的 userID。
ConvId	String	是	会话 ID。查询单聊会话消息时，此处填入另一参与用户的 userID（已在客户端调用 `login` 方法登录 ZIM 服务，或已调用服务端 API 完成注册）。查询群聊会话消息时，此处填入目标群组的 groupID。
ConvType	Number	是	会话类型： 0：单聊。 2：群聊。
MsgSeqList	Array of Number	是	待查询消息的 seq 列表。列表长度上限为 20。说明如需上调，请联系 ZEGO 技术支持。 seq 获取方式：若需要查询由客户端发出的消息，通过消息发送后回调获取 MsgSeq。若需要查询由服务端 API SendPeerMessage 发出的单聊消息，通过接口响应数据获取 MsgSeq。若需要查询由服务端 API SendGroupMessage 发出的群聊消息，通过接口响应数据获取 MsgSeq。

请求示例

请求地址 URL：

Untitled

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

Copied!

请求消息体：

Untitled

{
    "FromUserId": "user0",
    "ConvId": "user1",
    "ConvType": 0,
    "MsgSeqList": [
        1,
        2,
        3
    ]
}

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
MessageList	Array of Object	返回的消息内容列表，详情请参考 MessageList 结构。

MessageList 结构

参数	类型	描述
Sender	String	消息发送者。
MsgType	Number	消息类型： 1：文本。 10：组合。 11：图片。 12：文件。 13：音频。 14：视频。 31：撤回消息。 32：Tips 消息。 200：自定义。
SubMsgType	Number	具体的自定义类型。值由用户发送自定义消息时填写，取值范围为 [0,200]。只有当 MsgType 为 200（自定义类型）时，此参数才有意义。
MsgBody	String	消息内容。当 MsgType 为 1（文本类型）或 200（自定义类型），MsgBody 为发送消息时传入的消息内容，开发者可直接阅读消息内容。当 MsgType 为下列类型时，MsgBody 为 JSON 字符串。请使用 URLDecode 对此 JSON 字符串解码，并按照对应结构获取消息中各字段数据：当 MsgType 为 11、12、13、14（多媒体消息）：MsgBody JSON 字符串解析结果参数说明 - 多媒体消息。当 MsgType 为 10（组合消息）：MsgBody JSON 字符串解析结果参数说明 - 组合消息。当 MsgType 为 31（消息已被撤回）：MsgBody JSON 字符串解析结果参数说明 - 撤回消息当 MsgType 为 32（Tips 消息）：MsgBody JSON 字符串解析结果参数说明 - Tips 消息。
MsgId	Number	消息 ID，可借此确定消息的唯一性。
MsgSeq	Number	消息 Seq。
Payload	String	消息扩展字段。
MsgTime	Number	服务端收到消息的时间，Unix 时间戳，单位为毫秒（ms）。
IsEmpty	Number	是否是空消息： 0：不是空消息。 1：消息已被删除（查询不到或者客户调用接口删除此消息），此时其他参数均为空。 2：消息已被撤回。

MsgBody JSON 字符串解析结果参数说明

多媒体消息

展开查看详细内容

组合消息

展开查看详细内容

撤回消息

展开查看详细内容

Tips 消息

展开查看详细内容

响应示例

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "MessageList": [
        {
            "Sender": "userA",
            "MsgType": 1,
            "MsgBody": "this is a message",
            "MsgId": 971503777289036700,
            "MsgSeq": 1,
            "Payload": "this is a payload",
            "MsgTime": 1705895412000,
            "IsEmpty": 0
        }
    ]
}

Copied!

返回码

返回码	说明	处理建议
660000001	服务端出错。	请重试，或联系 ZEGO 技术支持。
660000002	输入的参数缺失或不合法。	请检查输入的参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试，或参考相关文档了解调用频率。
660700008	获取用户信息出错。	请检查用户 ID 是否正确。
660700015	用户未注册。	请先注册用户。