QueryMessagesByMsgSeq
https://zim-api.zego.im/
本接口支持查询单个指定会话（群聊、单聊）中的多条消息。
Request
Query Parameters
可选值: [QueryMessagesByMsgSeq]
接口原型参数
https://zim-api.zego.im/?Action=QueryMessagesByMsgSeq
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
- application/json
Body
required
- 查询单聊会话消息时，此处填入任一参与用户的 userID。
- 查询群聊会话消息时，此处可填入任意已注册用户的 userID。
- 查询单聊会话消息时，此处填入另一参与用户的 userID（已在客户端调用 login 方法登录 ZIM 服务，或已调用 服务端 API 完成注册）。
- 查询群聊会话消息时，此处填入目标群组的 groupID。
- 0：单聊。
- 2：群聊。
- 若需要查询由客户端发出的消息，通过 消息发送后回调 获取 MsgSeq。
- 若需要查询由 服务端 API SendPeerMessage 发出的单聊消息，通过接口响应数据获取 MsgSeq。
- 若需要查询由 服务端 API SendGroupMessage 发出的群聊消息，通过接口响应数据获取 MsgSeq。
可选值: <= 32 characters
用户的 UserID（已在客户端调用 login 方法登录 ZIM 服务，或已调用 服务端 API 完成注册）。
可选值: <= 32 characters
会话 ID。
可选值: [0, 2]
会话类型：
可选值: <= 20
待查询消息的 seq 列表。列表长度上限为 20。
说明
如需上调，请联系 ZEGO 技术支持。
seq 获取方式：
Responses
- 200
- application/json
- 数据结构
- 按数据结构生成的示例
Schema
- Array[
- 1：文本。
- 10：组合。
- 11：图片。
- 12：文件。
- 13：音频。
- 14：视频。
- 31：撤回消息。
- 32：Tips 消息。
- 200：自定义。
- 当 MsgType 为 1（文本类型）或 200（自定义类型），MsgBody 为发送消息时传入的消息内容，开发者可直接阅读消息内容。
- 当 MsgType 为 下列类型时，MsgBody 为 JSON 字符串。请使用 URLDecode 对此 JSON 字符串解码，并按照对应结构获取消息中各字段数据：
- 当 MsgType 为 11、12、13、14（多媒体消息）：参考多媒体消息结构。
- 当 MsgType 为 10（组合消息）：参考组合消息结构。
- 当 MsgType 为 31（消息已被撤回）：参考撤回消息结构。
- 当 MsgType 为 32（Tips 消息）：参考 Tips 消息结构。
- 多媒体消息
- 组合消息
- 撤回消息
- Tips 消息
- Array[
- 1：文本。
- 11：图片。
- 12：文档。
- 13：音频。
- 14：视频。
- 200：自定义消息类型。
- 仅当 msg_type 为 1 或 200 时，可直接在此参数阅读消息内容。
- 当 Item 为 11、12、13 或 14，请参考多媒体消息结构了解消息的各个字段数据。
- ]
- 4：由用户自行撤回。
- 8：由系统撤回。
- 12：通过服务端 API 撤回。
- 16：由群管理员撤回。
- 20：由群主撤回。
- 24：因未通过审核而遭撤回。
- 群成员变更：
- 1：群创建。
- 2：群解散。
- 3：用户主动加群。
- 4：群内成员邀请群外用户加入群组。
- 5：群成员主动离开。
- 6：群内成员被踢出。
- 群成员资料变更：
- 11：群主转移。
- 12：群成员角色变更。
- 13：群成员禁言状态变更。
- 群资料变更：
- 30：群名、群头像、群公告变更。
- 34：群组禁言状态变更。
- 1：群主。
- 2：群管理员。
- 3：群成员。
- Array[
- 1：群主。
- 2：群管理员。
- 3：群成员。
- ]
- 1：群名称。
- 2：群公告。
- 4：群头像。
- false：不是。
- true：是。
- 1：群主。
- 2：群管理员。
- 3：群成员。
- 0：不是空消息。
- 1：消息已被删除（查询不到或者客户调用接口删除此消息），此时其他参数均为空。
- 2：消息已被撤回。
- ]
返回码。
以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考 全局返回码。
| 返回码 | 说明 | 处理建议 |
|---|---|---|
| 660000001 | 服务端出错。 | 请重试，或联系 ZEGO 技术支持。 |
| 660000002 | 输入的参数缺失或不合法。 | 请检查输入的参数。 |
| 660300005 | 调用接口的频率超出了 AppID 级别限制。 | 请稍后再试，或参考相关文档了解调用频率。 |
| 660700008 | 获取用户信息出错。 | 请检查用户 ID 是否正确。 |
| 660700015 | 用户未注册。 | 请先注册用户。 |
操作结果描述。
请求 ID。
MessageList object[]
消息发送者。
消息类型：
具体的自定义类型。值由用户发送自定义消息时填写，取值范围为 [0,200]。只有当 MsgType 为 200（自定义类型）时，此参数才有意义。
MsgBody object
消息内容。
文件的 MD5 值。
文件名称。
文件大小，单位为字节（B）。
下载地址。
音视频时长，单位为秒（s）。
🏞️如果是图片消息则包含此属性。原图的宽度，单位为像素（px）。
🏞️如果是图片消息则包含此属性。原图的高度，单位为像素（px）。
🏞️如果是图片消息则包含此属性。大图下载地址。
🏞️如果是图片消息则包含此属性。大图的宽度，单位为像素（px）。
🏞️如果是图片消息则包含此属性。大图的高度，单位为像素（px）。
🏞️如果是图片消息则包含此属性。缩略图下载地址。
🏞️如果是图片消息则包含此属性。缩略图的宽度，单位为像素（px）。
🏞️如果是图片消息则包含此属性。缩略图的高度，单位为像素（px）。
🎬如果是视频消息则包含此属性。视频首帧图的下载地址。
🎬如果是视频消息则包含此属性。视频首帧图的宽度，单位为像素（px）。
🎬如果是视频消息则包含此属性。视频首帧图的高度，单位为像素（px）。
multi_msg object[]
可选值: [1, 11, 12, 13, 14, 200]
Item 类型：
仅当 msg_type 为 200 时，返回此参数。
Item 内容。
撤回发起用户的 userID。
撤回操作的时间戳，单位为毫秒。
原消息类型。
撤回操作时携带的扩展字段。
撤回的对应状态：
Tips 消息类型：
op_user_info object
用户 ID。
用户的群成员角色。
用户名。
用户的群成员昵称。
target_users object[]
用户 ID。
用户的群成员角色。
用户名。
用户的群成员昵称。
当 type 为 30 时，此参数有意义，表示被修改的群资料项目。
群公告。
群名称。
群头像。
forbid object
是否全员禁言：
被禁言的群成员角色。
禁言到期时间戳，单位为毫秒。
当 type 为 13 时，此参数表示群成员禁言到期时间戳，单位为毫秒。
当 type 为 12 时，此参数表示变更后的群成员角色。
消息 ID，可借此确定消息的唯一性。
消息 seq。
消息扩展字段。
服务端收到消息的时间，Unix 时间戳，单位为毫秒（ms）。
是否是空消息：
{
"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
}
]
}{
"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
}
]
}