在开放平台，消息是指用户与智能体会话过程中，一个轮次内的问答内容。通过调用本接口，开发者可以查询由开放平台 API 或 SDK 发起的，指定会话过程中的消息列表。
前提条件
- 在调用本接口前，请先完成应用的发布，若无，请参见：发布应用，完成相关事项。
请求地址
GEThttps://api.tbox.cn/api/conversation/messages
请求头
参数名 |
是否必填 |
类型 |
说明 |
示例 |
Authorization |
是 |
String |
用于验证客户端身份的访问令牌，你可以在百宝箱中获取，获取方式可参见：授权管理。 |
|
请求参数
参数名 |
是否必填 |
类型 |
说明 |
示例 |
conversationId |
是 |
String |
会话 ID，通过开放平台提供的开放能力发起的会话动作的唯一标识。 |
2025*****4259 |
pageNum |
否 |
Integer |
分页页码，从 1 开始，默认为 1。 |
1 |
pageSize |
否 |
Integer |
分页条数，默认为 50，最大 50。 |
50 |
sortOrder |
否 |
Enum<String> |
会话列表排序方式，默认 DESC。
|
DESC |
请求示例
curl --location 'https://api.tbox.cn/api/conversation/messages?conversationId={your_conversationId}&pageNum=1&pageSize=5&sortOrder=DESC' \ --header 'Authorization: {your_token}' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --data ''
返回参数
通用参数
参数名 |
类型 |
说明 |
示例 |
errorCode |
String |
错误码，为 0 表示成功。 |
0 |
errorMsg |
String |
错误信息。 |
success |
data |
List<Message> |
消息列表，列表内参数定义可参见：Message 定义。 |
- |
traceId |
String |
traceId，用于排查问题 |
12djdfj2jedjj4rf |
Message 定义
参数名 |
类型 |
说明 |
示例 |
messageId |
String |
消息ID |
2025******4628 |
conversationId |
String |
会话ID |
2025******9611 |
appId |
String |
智能体ID |
2025******9418 |
query |
String |
用户发给智能体的问题内容 |
图片里面有什么 |
answers |
List<Answer> |
智能体的回答列表，列表内参数定义可参见：Answer 定义。 |
- |
files |
List<File> |
用户上传的文件集合列表，列表内参数定义可以参见：File 定义。 |
- |
createAt |
Long |
消息创建时间，时间戳，单位为 s |
1753155912 |
updateAt |
Lone |
消息更新时间，时间戳，单位为 s |
1753155918 |
status |
Enum<String> |
消息状态
|
success |
Answer 定义
参数名 |
类型 |
说明 |
示例 |
lane |
String |
流水线标识，默认为 |
default |
mediaType |
Enum<String> |
输出的内容类型
|
text |
text |
String |
文本内容 |
这张图片展示了一直橘色的小猫... |
url |
List<String> |
图片链接（有效期 24 h） |
https://mass.alipay.com/doraemon_chatfile/afts/file/*****EAAAAA |
expireAt |
Lone |
链接过期时间，时间戳，单位 s |
1754121123 |
File 定义
参数名 |
类型 |
说明 |
示例 |
type |
String |
文件类型：
|
IMAGE |
url |
String |
预览链接（有效期 24 h） |
https://mass.alipay.com/doraemon_chatfile/afts/file/*****EAAAAA |
expireAt |
Lone |
链接过期时间，时间戳，单位 s |
1754121123 |
返回示例
成功返回
{ "data": { "currentPage": 1, "messages": [ { "answers": [ { "lane": "default", "mediaType": "text", "text": "这张图片展示了一位年轻女性，她有着长长的黑发，穿着一件浅色的短袖上衣。背景中可以看到一些绿色的植物，阳光透过树叶洒在她的脸上和头发上，营造出一种温暖而自然的氛围。图片右下角有“图片由AI生成”的字样，表明这是一张由人工智能生成的图像。整体感觉清新、自然且充满生机。" } ], "appId": "2025******9418", "conversationId": "2025******9611", "createAt": 1753155912, "files": [ { "expireAt": 1754121123, "type": "IMAGE", "url": "https://mass.alipay.com/doraemon_chatfile/afts/file/0Zq1R7emvIYAAAAAS0AAAAgAehe3AABr?t=QC46N1PZzc1toAmP63ePivIP-USt6qHdWOnbQ585apYDAAAAZAABPIEAAAAA" } ], "messageId": "2025******4628", "query": "图片里面有什么", "status": "success", "updateAt": 1753155918 }, { "answers": [ { "lane": "default", "mediaType": "text", "text": "请问有什么可以帮忙的吗，尽管问我哦~" } ], "appId": "2025******9418", "conversationId": "2025******9611", "createAt": 1753155912, "files": [ { "expireAt": 1754121123, "type": "IMAGE", "url": "https://mass.alipay.com/doraemon_chatfile/afts/file/0Zq1R7emvIYAAAAAS0AAAAgAehe3AABr?t=QC46N1PZzc1toAmP63ePivIP-USt6qHdWOnbQ585apYDAAAAZAABPIEAAAAA" } ], "messageId": "2025******4492", "query": "", "status": "success" } ], "pageSize": 5, "total": 2 }, "errorCode": "0", "errorMsg": "success", "traceId": "0a42******9267" }
失败返回
{ "errorCode": "P_1_02_111", "errorMsg": "会话不存在", "solution": "请检查入参：conversationId 是否有效" }
