删除单条消息
更新时间: 2024/07/17 17:57:35
本文介绍如何通过云信服务端 API 删除单条消息。
功能描述
删除某一条消息(删除对应的离线消息、漫游消息和历史消息)。删除消息时,客户端无感知。
API 使用限制
单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。
URL
POST http://api.netease.im/nimserver/msg/delMsg.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API调用方式。
-
POST 请求中 Body 的设置如下:
参数 |
类型 |
必填 |
说明 |
---|---|---|---|
deleteMsgid | String | 是 | 待删除的消息的 ID |
timetag | Long | 是 | 要删除消息的创建时间(指云信服务器返回的消息发送时间) |
type | int | 是 | 只能传入 7 或 8,7 表示删除单聊消息,8 表示删除群消息,传入其他值均判定为参数错误 |
from | String | 是 | 消息发送方的云信 IM 账号(accid) |
to | String | 是 | 如果待删除的是单聊消息,需传入接收者的云信 IM 账号(accid)。如果待删除的是群消息,需传入对应的群 ID(即 tid) |
示例
cURL 请求示例
curl -X POST -H "AppKey: go9dnk4**glw0803mgq3" -H "Nonce: 4tggge**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'deleteMsgid=10386192&timetag=1481528155741&type=7&from=t1&to=t4' 'https://api.netease.im/nimserver/msg/delMsg.action'
请求成功返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code": 200
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code":414
"desc":"illegal type!" // type值不合法
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 请求失败原因可能为:
|
查看对应提示信息做出处理 |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?