在线调试

查询单条消息

更新时间: 2024/10/29 15:55:37

该接口可以在会话中查询某条消息的详细信息,包括消息发送者 ID,消息 ID,消息类型,消息内容等。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

GET https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages/:{message_server_id}

请求 Header 的参数说明请参见请求 Header

路径参数

参数名称 类型 是否必选 描述 示例
conversation_id String 必选 会话 ID。会话 ID 需要用户自行拼装,拼装规则:
owner_id|conversation_type|other_idowner_id|conversation_type|team_id
  • owner_id:操作者账号 ID
  • conversation_type:会话类型,1:单聊会话;2:高级群会话;3:超大群会话
  • other_id:对方账号 ID(单聊对话)
  • team_id:群组 ID(群组会话)
单聊会话:Accid1|1|Accid2
高级群会话:Accid1|2|tid
超大群会话:Accid1|3|tid
message_server_id Long 必选 需要查询的服务端消息 ID。 1231231123145

查询参数

参数名称 类型 是否必选 描述
message_time Long 可选 消息发送时间戳。
check_team_valid Boolean 可选 是否校验群有有效性,true:校验,false(默认):不校验。
check_team_member_valid Boolean 可选 是否校验群成员的有效性,true:校验,false(默认):不校验。

响应

Header

响应 Header 的参数说明请参见 响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
message_server_id Long 服务端消息 ID。
sender_id String 消息发送方帐号 ID。
conversation_type Integer 会话类型,1:单聊会话;2:高级群会话;3:超大群会话。
receiver_id String 消息接收方账号 ID。
team_id Long 群组 ID。team_id 与 receiver_id 只会返回其一。
message_type Integer 消息类型。0:文本;1:图片;2:语音;3:视频;4:地址位置;5:通知;6:文件;10:提示;11:机器人;100:自定义。
sub_type Integer 自定义消息子类型。
create_time Long 消息发送时间戳。
text String 文本/提示消息内容或多媒体消息的描述文本(该描述信息可用于云端历史消息关键词检索)。
attachment Object 多媒体消息的属性或自定义消息内容。
extension String 消息发送时传入的第三方扩展字段。
modifyAccountId String 消息更新者的用户账号 ID。
只有消息被更新才会返回该字段。
modifyTime Long 消息的更新时间。
只有消息被更新才会返回该字段。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "text": "aaa",
        "message_server_id": 502714177945601,
        "sender_id": "dog1",
        "conversation_type": 3,
        "team_id": 7491025,
        "create_time": 1698752272248,
        "message_type": 0
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
107404 消息不存在 message not exist
108404 群不存在 team not exist
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码