该接口用于查询指定会话的信息。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2.1/conversations/{conversation_id}

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

路径参数

参数名称	类型	是否必选	说明	示例
conversation_id	String	是	需要查询的会话 ID，若传入的会话 ID 不存在会返回 414 错误码。	单聊会话：account_id1|1|account_id2 高级群会话：account_id1|2|team_id 超大群会话：account_id1|3|team_id

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
conversation_id	String	会话 ID。	是
sender_id	String	会话消息发送者的账号 ID。	是
receiver_id	String	接收会话消息的账号 ID 或群组 ID。	是
type	Integer	会话类型，1：单聊会话；2：高级群会话；3：超大群会话。	是
stick_top	Boolean	是否为置顶会话。	是
group_ids	Array of longs	会话所属分组列表。	是
server_extension	String	服务端扩展字段。	是
message_state	Integer	0：表示普通消息；1：表示撤回消息。	是
- last_message	Object	会话中的最后一条消息。如果是撤回消息，该字段为空，具体内容参考 revoke_notification。	否
message_server_id	Long	服务端消息ID。	否
message_client_id	String	客户端消息 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：地址位置；6：文件；10：提示；12：音视频话单，100：自定义。	否
sub_type	Integer	自定义消息子类型，大于 0。message_type = 100 时该字段才有效。	否
create_time	Long	消息创建时间（毫秒）。	否
text	String	消息文本内容。	否
attachment	Object	多媒体消息的属性或自定义消息内容。	否
extension	String	消息扩展字段。	否
sender_client_type	Integer	发送者客户端类型。1：AOS；2：iOS；4：PC；16：WEB；32：REST；64：MAC；65：HARMONY。	否
- revoke_notification	Object	消息撤回通知。message_state 为 1 时返回。	否
server_id	Long	被撤回的消息 ID。	否
attach	String	被撤回的消息的附件信息。	否
revoke_id	String	消息撤回者的账号 ID。	否
custom_info	String	服务端撤回填入的自定义信息。	否
revoke_type	Integer	消息撤回类型。0：未定义；1：单聊双向撤回；2：群聊双向撤回；3：单聊单向撤回；4：群聊单向撤回。	否
unread_count	Integer	会话消息未读数。	是
sort_order	Long	会话排序字段，默认将置顶会话排首位，如有多条置顶会话，则按其创建时间进行排序。	是
create_time	Long	会话创建时间（毫秒）。	是
update_time	Long	会话更新时间（毫秒）。	是
last_read_time	Long	会话最近已读时间（毫秒）。	是

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "type": 1,
    "conversation_id": "qaz|1|qaz1",
    "sender_id": "qaz",
    "receiver_id": "qaz1",
    "server_extension": "server_extension-obdvd",
    "group_ids": [],
    "last_message": {
      "text": "{\"msg\":\"2025-07-31T18:35:07.888文本消息测试-单聊-检索检索jin\"}",
      "extension": "ext",
      "message_server_id": 158844561857183746,
      "sender_id": "yytest3",
      "message_client_id": "902da5***22578b8",
      "conversation_type": 2,
      "receiver_id": "2366968421",
      "create_time": 1753958108323,
      "message_type": 0,
      "sender_client_type": 32
    },
    "message_state": 0,
    "unread_count": 1,
    "stick_top": false,
    "sort_order": 1753262877657,
    "create_time": 1753262876364,
    "update_time": 1753262877776,
    "last_read_time": 1753262704802
  }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
500	服务器内部错误	internal server error