请求方式	GET
请求地址	`https://api.coze.cn/v1/conversation/retrieve`
权限	`retrieveConversation` 确保调用该接口使用的访问令牌开通了 `retrieveConversation` 权限，详细信息参考鉴权方式。
接口说明	通过会话 ID 查看会话信息。

请求参数

参数	取值	说明
Authorization	Bearer $Access_Token	用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考准备工作。
Content-Type	application/json	解释请求正文的方式。

Query

参数	类型	是否必选	示例	说明
conversation_id	Integer	必选	737989918257****	Conversation ID，用于查询指定会话的详细信息。你可以在发起对话接口的 Response 中通过 `conversation_id` 字段获取会话 ID。

返回参数

参数	类型	示例	说明
data	Object of ConversationData	\	会话的详细信息。
detail	Object of ResponseDetail	20241210152726467C48D89D6DB2****	响应的详细信息。
code	Long	0	调用状态码。0 表示调用成功，其他值表示调用失败，你可以通过 msg 字段判断详细的错误原因。
msg	String	""	状态信息。API 调用失败时可通过此字段查看详细错误信息。状态码为 0 时，msg 默认为空。

ConversationData

参数	类型	示例	说明
id	String	737999610479815****	Conversation ID，即会话的唯一标识。
name	String	推荐杭州美食	会话的名称，用于标识和区分不同的会话。
meta_data	JSON Map	{ "uuid": "newid1234" }	附加信息，通常用于封装一些业务相关的字段。查看会话信息时，扣子编程会透传此附加信息，查看消息列表时不会返回该附加信息。自定义键值对，应指定为 Map 对象格式。长度为 16 对键值对，其中键（key）的长度范围为 1～64 个字符，值（value）的长度范围为 1～512 个字符。
creator_id	String	247877439325****	会话创建者的扣子 UID，用于标识创建该会话的用户。
created_at	Long	1718289297	会话创建的时间。格式为 10 位的 Unixtime 时间戳，单位为秒。
updated_at	Long	1718289297	会话的最后更新时间，格式为 10 位的 Unix 时间戳，单位为秒。
last_section_id	String	749566434761695***	会话中最新的一个上下文片段 ID。
connector_id	String	1024	该会话在哪个渠道创建。目前支持如下渠道： API：1024 ChatSDK：999 自定义渠道：自定义渠道 ID。自定义渠道 ID 的获取方式如下：在扣子编程左下角单击头像，在账号设置 > 发布渠道 > 企业自定义渠道管理页面查看渠道 ID。

ResponseDetail

参数	类型	示例	说明
logid	String	20241210152726467C48D89D6DB2****	本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。

示例

请求示例

curl --location --request GET 'https://api.coze.cn/v1/conversation/retrieve?conversation_id=737989918257****' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \

返回示例

{
  "data": {
    "id": "737999610479815****",
    "name": "推荐杭州美食",
    "meta_data": {
      "uuid": "newid1234"
    },
    "created_at": 1718289297,
    "creator_id": "247877439325****",
    "connector_id": "1024",
    "updated_at": 1718289297,
    "last_section_id": "7495664347616952360"
  },
  "detail": {
    "logid": "20241210152726467C48D89D6DB2****"
  },
  "code": 0,
  "msg": ""
}

错误码

如果成功调用扣子编程的 API，返回信息中 code 字段为 0。如果状态码为其他值，则表示接口调用失败。此时 msg 字段中包含详细错误信息，你可以参考错误码文档查看对应的解决方法。

文档对您有帮助吗?