删除快捷评论
更新时间: 2025/08/21 17:27:49
网易云信服务端支持对指定的消息(包括单聊消息、高级群消息和超大群消息)删除快捷评论。
调用添加消息快捷评论接口前,请至网易云信控制台 开通消息快捷评论。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
DELETE https://{endpoint}/im/v2/messages/actions/quick_comment
请求 URL 中的 {endpoint}
代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。
请求头参数
请求 Header 的参数说明请参考 请求 Header。
请求体参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
operator_id |
String | 是 | 进行删除快捷评论操作的用户账号 ID。 |
-
message |
Object | 是 | 被指定的消息对象。 |
conversation_type |
Integer | 是 | 会话类型。1:单聊。2:高级群。3:超大群。 |
sender_id |
String | 是 | 消息的发送者 ID。 |
receiver_id |
String | 是 | 消息的接收者 ID。 |
message_server_id |
Long | 是 | 消息的服务器 ID。 |
message_client_id |
String | 是 | 消息的客户端 ID。 |
create_time |
Long | 是 | 消息的发送时间。 |
extension |
String | 否 | 快捷评论的扩展字段,JSON 格式。例如:"{"k":"v"}"。 该字段长度上限以使用的 IM 套餐为准。IM 旗舰版及以上套餐才支持配置字段上限。 |
index |
Long | 是 | 快捷评论类型,必须大于 0。可在本地自定义映射关系,例如: |
-
push_config |
Object | 否 | 推送相关配置项。 |
push_enabled |
Boolean | 否 | 该消息是否需要 APNs 推送或 Android 系统通知栏推送,默认为 true(推送)。只有该字段为 true 时,推送相关参数才会生效。 |
push_content |
String | 否 | 推送文案,长度上限 500 位字符。如果不填,则使用默认推送文案。 |
push_payload |
String | 否 | 推送对应的 payload,必须是 JSON 格式,长度上限 2048 位字符。详情请参考 推送 payload 配置。 |
请求体示例
JSON{
"operator_id": "zhangsan",
"index": 1,
"extension": "",
"message": {
"message_server_id": 9899821270208,
"receiver_id": "apiv2test",
"create_time": 1707035841692,
"sender_id": "yx",
"conversation_type": 1,
},
"push_config": {
"push_enabled": false,
"push_content": "",
"push_payload": ""
}
}
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
参数名称 | 类型 | 说明 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
-
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
time |
Long | 删除快捷评论的服务器时间。 | 是 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {
"time": 1233333
}
}
错误码
本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码。
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
102404 | 用户不存在 | account not exist |
107404 | 消息不存在 | message not exist |
107347 | 定向消息不支持快捷评论 | target message not allowed quick comment |
107326 | 快捷评论功能未开通 | quick comment service disabled |
108404 | 群组不存在 | team not exist |
500 | 服务器内部错误 | internal server error |
此文档是否对你有帮助?