助手
扣子 AI 帮助与支持
你好,我是 扣子 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
如何快速了解这个空间的核心内容?
有哪些近期更新的重点文档?
我应该从哪些文档开始阅读?
文档反馈
低代码项目
快速开始
智能体
工作流
应用
资源
发布
模型
多人协作
开发工具
Coze CLI
API 参考
SDK 参考
音视频
推广与变现

查看消息详情

更新于: 2026-06-25 19:29:14

查看指定消息的详细信息。

基础信息

请求方式

GET

请求地址

https://api.coze.cn/v1/conversation/message/retrieve

权限

retrieveMessage
确保调用该接口使用的访问令牌开通了 retrieveMessage 权限,详细信息参考鉴权方式

接口说明

查看指定消息的详细信息。

请求参数

参数

取值

说明

Authorization

Bearer $AccessToken

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息,参考准备工作

Content-Type

application/json

解释请求正文的方式。

Query

参数

类型

是否必选

示例

说明

conversation_id

Integer

必选

737549035601767****

Conversation ID,即会话的唯一标识。你可以在发起对话接口 Response 中查看 conversation_id 字段的值。

message_id

Integer

必选

737549035601806****

Message ID,即消息的唯一标识。

返回参数

参数

类型

示例

说明

data

Object of OpenMessageApi

{ “bot_id”: “747999610479815****”, “chat_id”: “757999610479815****”, “content”: “早上好,今天星期几?”, “content_type”: “text”, “conversation_id”: “737999610479815****”, “created_at”: 1718595518, “id”: “738131140595115****”, “meta_data”: {}, “role”: “user”, “type”: “”, “updated_at”: “1718595518” }

消息详情。

detail

Object of ResponseDetail

{ “logid”: “20250106172024B5F607030EFFAD***” }

响应详情。

code

Long

0

调用状态码。0 表示调用成功,其他值表示调用失败,你可以通过 msg 字段判断详细的错误原因。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时,msg 默认为空。

OpenMessageApi

参数

类型

示例

说明

id

String

738130009748252****

Message ID,即消息的唯一标识。

conversation_id

String

737999610479815****

此消息所在的会话 ID。

bot_id

String

747363834493437****

编写此消息的智能体 ID。此参数仅在对话产生的消息中返回。

chat_id

String

757363834493437****

Chat ID。此参数仅在对话产生的消息中返回。
不同的对话中,系统会生成新的chat_id。同一个用户在第一次对话和第二次对话时,chat_id不一样。

meta_data

JSON Map

{“source”:“mobile_app”,“location”:“Beijing”,“custom_flag”:“high_priority”}

创建消息时的附加信息,以键值对形式存储,获取消息时会原样返回。可用于存储与业务相关的自定义数据。

role

String

user

发送这条消息的实体。取值:

  • user:代表该条消息内容是用户发送的。
  • assistant:代表该条消息内容是 Bot 发送的。

content

String

早上好,今天星期几?

消息的内容,支持纯文本、多模态(文本、图片、文件混合输入)、卡片等多种类型的内容。

content_type

String

text

消息内容的类型,取值包括:

  • text:文本。
  • object_string:多模态内容,即文本和文件的组合、文本和图片的组合。
  • card:卡片。此枚举值仅在接口响应中出现,不支持作为入参。

created_at

Long

1718592898

消息的创建时间,格式为 10 位的 Unixtime 时间戳,单位为秒(s)。

updated_at

Long

1718592898

消息的更新时间,格式为 10 位的 Unixtime 时间戳,单位为秒(s)。

type

String

question

消息类型。

  • question:用户输入内容。
  • answer:智能体返回给用户的消息内容,支持增量返回。如果工作流绑定了 messge 节点,可能会存在多 answer 场景,此时可以用流式返回的结束标志来判断所有 answer 完成。
  • function_call:智能体对话过程中调用函数(function call)的中间结果。
  • tool_response:调用工具 (function call)后返回的结果。
  • follow_up:如果在 Bot 上配置打开了用户问题建议开关,则会返回推荐问题相关的回复内容。
  • verbose:多 answer 场景下,服务端会返回一个 verbose 包,对应的 content 为 JSON 格式,content.msg_type =generate_answer_finish 代表全部 answer 回复完成。

Tip

仅发起对话(v3)接口支持将此参数作为入参,且:

  • 如果 autoSaveHistory=true,type 支持设置为 question 或 answer。
  • 如果 autoSaveHistory=false,type 支持设置为 question、answer、function_call、tool_output、tool_response。

其中,type=question 只能和 role=user 对应,即仅用户角色可以且只能发起 question 类型的消息。详细说明可参考消息 type 说明

section_id

String

757363834493437****

上下文片段 ID。每次清除上下文都会生成一个新的 section_id。

reasoning_content

String

好的,我现在需要给一个13岁的大学生提供学习建议。首先,我得考虑用户的情况……

模型的思维链(CoT),展示模型如何将复杂问题逐步分解为多个简单步骤并推导出最终答案。仅当模型支持深度思考、且智能体开启了深度思考时返回该字段,当前支持深度思考的模型请参考模型能力差异

ResponseDetail

参数

类型

示例

说明

logid

String

20241210152726467C48D89D6DB2****

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

示例

请求示例

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

返回示例

{
  "code": 0,
  "data": {
    "bot_id": "747999610479815****",
    "chat_id": "757999610479815****",
    "content": "早上好,今天星期几?",
    "content_type": "text",
    "conversation_id": "737999610479815****",
    "created_at": 1718595518,
    "id": "738131140595115****",
    "meta_data": {},
    "role": "user",
    "type": "",
    "updated_at": "1718595518"
  },
  "msg": "",
  "detail": {
    "logid": "20250106172024B5F607030EFFAD653960"
  }
}

{
  "code": 0,
  "data": {
    "bot_id": "747549035601767****",
    "chat_id": "757549035601767****",
    "content": "[{\"type\":\"text\",\"text\":\"你好\"},{\"type\":\"image\",\"file_id\":\"7372175029901787180\"}]",
    "content_type": "object_string",
    "conversation_id": "737549035601767****",
    "created_at": "1717240253",
    "id": "737549035601770****",
    "meta_data": {
      "KEY": "value"
    },
    "role": "user",
    "type": "",
    "updated_at": "1717240253"
  },
  "msg": "",
  "detail": {
    "logid": "20250106172024B5F607030EFFAD653960"
  }
}

错误码

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