开发工具/API 参考/会话与消息/删除消息
删除消息
更新于: 2026-06-25 19:29:14
调用接口在指定会话中删除消息。
说明
|
请求方式 |
POST |
|---|---|
|
请求地址 |
|
|
权限 |
|
|
接口说明 |
调用接口在指定会话中删除消息。 |
|
参数 |
取值 |
说明 |
|---|---|---|
|
Authorization |
Bearer $Access_Token |
用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息,参考准备工作。 |
|
Content-Type |
application/json |
解释请求正文的方式。 |
|
参数 |
类型 |
是否必选 |
示例 |
说明 |
|---|---|---|---|---|
|
conversation_id |
String |
必选 |
74076802623535***** |
待删除的消息所属的会话 ID。 |
|
message_id |
String |
必选 |
74076856761178**** |
待删除的消息 ID,你可以选择删除会话中的 question 消息和 answer 消息。
|
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
data |
Object of OpenMessageApi |
{ “bot_id”: “73250261716436*****”, “chat_id”: “74076802623535*****”, “content”: “您好呀!今天感觉怎么样?”, “content_type”: “text”, “conversation_id”: “74076802623535*****”, “created_at”: 1724734970, “id”: “74076802623536*****”, “meta_data”: {}, “role”: “assistant”, “type”: “answer”, “updated_at”: 1724734971 } |
已删除的 Message 详情。 |
|
detail |
Object of ResponseDetail |
{ “logid”: “20250106172024B5F60***” } |
响应详情。 |
|
code |
Long |
0 |
调用状态码。0 表示调用成功,其他值表示调用失败,你可以通过 msg 字段判断详细的错误原因。 |
|
msg |
String |
“” |
状态信息。API 调用失败时可通过此字段查看详细错误信息。 |
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
id |
String |
738130009748252**** |
Message ID,即消息的唯一标识。 |
|
conversation_id |
String |
737999610479815**** |
此消息所在的会话 ID。 |
|
bot_id |
String |
747363834493437**** |
编写此消息的智能体 ID。此参数仅在对话产生的消息中返回。 |
|
chat_id |
String |
757363834493437**** |
Chat ID。此参数仅在对话产生的消息中返回。 |
|
meta_data |
JSON Map |
{“source”:“mobile_app”,“location”:“Beijing”,“custom_flag”:“high_priority”} |
创建消息时的附加信息,以键值对形式存储,获取消息时会原样返回。可用于存储与业务相关的自定义数据。 |
|
role |
String |
user |
发送这条消息的实体。取值:
|
|
content |
String |
早上好,今天星期几? |
消息的内容,支持纯文本、多模态(文本、图片、文件混合输入)、卡片等多种类型的内容。 |
|
content_type |
String |
text |
消息内容的类型,取值包括:
|
|
created_at |
Long |
1718592898 |
消息的创建时间,格式为 10 位的 Unixtime 时间戳,单位为秒(s)。 |
|
updated_at |
Long |
1718592898 |
消息的更新时间,格式为 10 位的 Unixtime 时间戳,单位为秒(s)。 |
|
type |
String |
question |
消息类型。
Tip 仅发起对话(v3)接口支持将此参数作为入参,且:
其中,type=question 只能和 role=user 对应,即仅用户角色可以且只能发起 question 类型的消息。详细说明可参考消息 type 说明。 |
|
section_id |
String |
757363834493437**** |
上下文片段 ID。每次清除上下文都会生成一个新的 section_id。 |
|
reasoning_content |
String |
好的,我现在需要给一个13岁的大学生提供学习建议。首先,我得考虑用户的情况…… |
模型的思维链(CoT),展示模型如何将复杂问题逐步分解为多个简单步骤并推导出最终答案。仅当模型支持深度思考、且智能体开启了深度思考时返回该字段,当前支持深度思考的模型请参考模型能力差异。 |
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
logid |
String |
20241210152726467C48D89D6DB2**** |
本次请求的日志 ID。如果遇到异常报错场景,且反复重试仍然报错,可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。 |
curl --location --request POST 'https://api.coze.cn/v1/conversation/message/delete?conversation_id=74076802623535*****&message_id=74076856761178****' \
--header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
--header 'Content-Type: application/json' \
{
"code": 0,
"data": {
"bot_id": "73250261716436*****",
"chat_id": "74076802623535*****",
"content": "您好呀!今天感觉怎么样?",
"content_type": "text",
"conversation_id": "74076802623535*****",
"created_at": 1724734970,
"id": "74076802623536*****",
"meta_data": {},
"role": "assistant",
"type": "answer",
"updated_at": 1724734971
},
"msg": ""
}
如果成功调用扣子编程的 API,返回信息中 code 字段为 0。如果状态码为其他值,则表示接口调用失败。此时 msg 字段中包含详细错误信息,你可以参考错误码文档查看对应的解决方法。