获取会话消息
1. 接口描述
1.
2.
3.
4.
2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetThreadMessage。 |
| Version | 是 | String | 公共参数，本接口取值：2023-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ThreadID | 是 | String | 会话 ID 示例值：thread_QPH2Z6DpBhc46V3ylE1JEqTv 取值可参考： 创建会话 |
| MessageID | 是 | String | 消息 ID 示例值：msg_jtO6oVZmFtIi4T43eswXk6lJ 取值可参考： 会话消息列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ID | String | 消息 ID 示例值：msg_pYmfqfAkOcN5bM1rjdEjbVZV |
| Object | String | 对象类型 示例值：thread.message |
| CreatedAt | Integer | 创建时间 示例值：1727269943 |
| ThreadID | String | 会话 ID 示例值：thread_OteLtAcmh7prn7tb8uQ3SJzh |
| Status | String | 状态，处理中 in_progress，已完成 completed，未完成 incomplete。 示例值：completed |
| InCompleteDetails | ThreadMessageInCompleteDetailsObject | 未完成原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Reason": ""} |
| CompletedAt | Integer | 完成时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1727264847 |
| InCompleteAt | Integer | 未完成时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1727264847 |
| Role | String | 角色 示例值：user |
| Content | String | 内容 示例值：你好 |
| AssistantID | String | 助手 ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：asst_LhSU47qcQcFEItggpGEx5eh1 |
| RunID | String | 运行 ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：run_SR0cPyidY0vBWy7mcYN5loSR |
| Attachments | Array of ThreadMessageAttachmentObject | 附件 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"FileID":"file-tMjt0CQnvU25GwUDkih4tU4H"}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。 |
4. 示例
示例1 获取会话消息
输入示例
POST / HTTP/1.1
Host: hunyuan.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetThreadMessage
<公共请求参数>
{
"ThreadID": "thread_QPH2Z6DpBhc46V3ylE1JEqTv",
"MessageID": "msg_jtO6oVZmFtIi4T43eswXk6lJ"
}输出示例
{
"Response": {
"RequestId": "585adb49-e89c-4f58-868a-ca0438e23a17",
"ID": "msg_jtO6oVZmFtIi4T43eswXk6lJ",
"Object": "thread.message",
"CreatedAt": 1727303115,
"ThreadID": "thread_QPH2Z6DpBhc46V3ylE1JEqTv",
"Status": "completed",
"InCompleteDetails": {
"Reason": ""
},
"CompletedAt": 1727331915,
"InCompleteAt": null,
"Role": "assistant",
"Content": [
{
"Index": 0,
"Type": "text",
"Text": {
"Value": "您好！非常高兴与您交流，今天有什么有趣的事情想和我分享呢"
}
}
],
"AssistantID": "",
"RunID": "run_XmeUGzgrzTE82Yh7p8mZWRcJ",
"Attachments": null,
"Metadata": {}
}
}5. 开发者资源
腾讯云 API 平台
API Inspector
SDK
命令行工具
6. 错误码
| 错误码 | 描述 |
|---|---|
| FailedOperation.EngineRequestTimeout | 引擎层请求超时；请稍后重试。 |
| FailedOperation.EngineServerError | 引擎层内部错误；请稍后重试。 |
| FailedOperation.EngineServerLimitExceeded | 引擎层请求超过限额；请稍后重试。 |
| FailedOperation.FreeResourcePackExhausted | 免费资源包余量已用尽，请购买资源包或开通后付费。 |
| FailedOperation.ResourcePackExhausted | 资源包余量已用尽，请购买资源包或开通后付费。 |
| FailedOperation.ServiceNotActivated | 服务未开通，请前往控制台申请试用。 |
| FailedOperation.ServiceStop | 用户主动停服。 |
| FailedOperation.ServiceStopArrears | 欠费停服。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Model | 模型不存在。 |
修改于 2025-03-05 10:10:28