群组消息撤回

最近更新时间:2019-08-23 14:55:02

功能说明

App 管理员通过该接口撤回指定群组的消息,消息需要在漫游有效期以内。

接口调用说明

适用的群组类型

群组类型 支持群消息撤回
私有群(Private)
公开群(Public)
聊天室(ChatRoom)
音视频聊天室(AVChatRoom)
在线成员广播大群(BChatRoom)

即时通信 IM 内置以上五种群组类型,详情请参阅 群组系统

请求 URL 示例

https://console.tim.qq.com/v4/group_open_http_svc/group_msg_recall?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/group_open_http_svc/group_msg_recall 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

消息撤回之后将无法恢复,请谨慎调用该接口。

{
    "GroupId": "@TGS#2J4SZEAEL",
    "MsgSeqList":[
        {
            "MsgSeq":100
        },
        {
            "MsgSeq":101
        }
    ]
}

请求包字段说明

字段 类型 属性 说明
GroupId String 必填 操作的群 ID
MsgSeqList Array 必填 被撤回的消息 seq 列表,一次请求最多可以撤回10条消息 seq
MsgSeq Integer 必填 请求撤回的消息 seq

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RecallRetList":[
        {
            "MsgSeq":100,
            "RetCode":10030
        },
        {
            "MsgSeq":101,
            "RetCode":0
        }
    ]
}

应答包字段说明

字段 类型 说明
ActionStatus String 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode Integer 错误码,0表示成功,非0表示失败
ErrorInfo String 错误信息
RecallRetList Array 消息撤回请求的详细结果
MsgSeq String 单个被撤回消息的 seq
RetCode String 单个消息的被撤回结果:0表示成功;其它表示失败,参考下文错误码说明

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 描述
10002 服务器内部错误,请重试
10003 请求命令字非法
10004 参数非法,请根据错误描述检查请求是否正确
10007 操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限
10010 群组不存在,或者曾经存在过,但是目前已经被解散
10015 群组 ID 非法,请检查群组 ID 是否填写正确
10030 请求撤回的消息不存在
10031 请求撤回的消息超出时间限制
10032 请求撤回的消息不支持撤回操作
10033 群组类型不支持消息撤回操作
10041 该应用(SDKAppID)已配置不支持群消息撤回

接口调试工具

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

参考

在群组中发送系统通知(v4/group_open_http_svc/send_group_system_notification)。