撤回聊天室消息
更新时间: 2024/07/17 17:57:35
网易云信 IM 服务端支持撤回聊天室消息。
功能描述
撤回聊天室内发送的消息后对应消息的云端历史记录也将一并删除。
8.7.0 及以上版本的客户端 SDK,才会收到消息撤回的通知。
URL
httpPOST https://api.netease.im/nimserver/chatroom/recall.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参考API 调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
roomid | Long | 是 | 聊天室 ID |
msgTimetag | Long | 是 | 被撤回消息的时间戳,毫秒级 |
msgId | String | 是 | 被撤回的消息 ID |
fromAcc | String | 是 | 被撤回的消息的发送者账号,accid |
operatorAcc | String | 是 | 撤回消息的操作者账号,accid |
notifyExt | String | 否 | 撤回消息的通知扩展字段,最大长度 1024 位字符 |
示例
请求示例(curl)
curlcurl -X POST -H "CheckSum: 51eb13ea**85c7866c366" -H "AppKey: f54166405***6ad7799&fromAcc=acc01&" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=123&msgId=c9e6c306573778829419&msgTimetag=1212121&operatorAcc=acc01&fromAcc=acc02' 'https://api.netease.im/nimserver/chatroom/recall.action'
请求成功返回示例
json"Content-Type": "application/json; charset=utf-8"
{
"code":200
}
请求失败返回示例
"Content-Type": "application/json; charset=utf-8"
{
"code":414
"desc":"msgidclient is null" // msgId 字段为空
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 频控限制,访问频率过高 | 降低访问频率 |
500 | 服务出错 | - |
此文档是否对你有帮助?