删除指定用户发送的消息

最近更新时间:2024-10-10 17:53:12

我的收藏

功能说明

该 API 接口的作用是撤回最近1000条消息中指定用户发送的消息。
此接口通过打标记实现SDK无法拉取的效果,并没有真的执行删除操作,属于撤回消息的一种,因此下文中将使用“撤回”一词描述“删除”操作。

接口调用说明

适用的群组类型

群组类型 ID
是否支持此 REST API
Private
支持,同新版本中的 Work(好友工作群)
Public
支持
ChatRoom
支持,同新版本中的 Meeting(临时会议群)
AVChatRoom
不支持
Community(社群)
支持
即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统
说明
AVChatRoom(直播群)不支持历史消息存储(此处撤回消息指撤回历史消息存储中的消息),对此类型群组中的用户撤回消息是无效的(但是不会返回错误)。
该接口目前只支持静默撤回,在服务端对该消息打上撤回标记,并不会通知到客户端,只有拉漫游时才知道该消息被撤回。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/delete_group_msg_by_sender?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/group_open_http_svc/delete_group_msg_by_sender
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

撤回群消息,撤回最近1000条消息内某个人发送的消息。
{
"GroupId": "@TGS#2C5SZEAEF", //必填
"Sender_Account": "leckie" //必填
}

请求包字段说明

字段
类型
属性
说明
GroupId
String
必填
要撤回消息的群 ID
Sender_Account
String
必填
被撤回消息的发送者 ID
TopicId
String
选填
话题的 ID,若具有此选项表示撤回的是对应话题中的消息,仅支持话题的社群适用此选项

应答包体示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,
OK 表示处理成功
FAIL 表示失败
ErrorInfo
String
错误信息
ErrorCode
Integer
错误码,
0表示成功
非0表示失败

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
描述
10002
服务器内部错误,请重试
10003
请求命令字非法
10004
参数非法,请根据错误描述检查请求是否正确
10007
操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限
10010
群组不存在,或者曾经存在过,但是目前已经被解散
10015
群组 ID 非法,请检查群组 ID 是否填写正确

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考