tencent cloud

功能说明

• 管理员撤回群聊消息。
• 该接口可以撤回所有漫游有效期内的群聊消息，包括客户端发出的群聊消息，由 REST API 接口发出的群聊消息。
• 若需要撤回由客户端发出的群聊消息，您可以开通 群内发言之后回调 ，通过该回调接口记录每条群聊消息的 GroupId 和 MsgSeq，然后填在本接口的 GroupId 和 MsgSeqList 参数里进行撤回。您也可以通过 拉取群历史消息 查询出待撤回的群聊消息的相关信息后，使用本接口进行撤回。
• 若需要撤回由 REST API 在群组中发送普通消息 接口发出的群聊消息，需要记录这些接口回包里的 MsgSeq 字段以进行撤回。
• 调用该接口撤回消息后，该条消息的发送方和接收方的客户端的本地缓存都会被撤回。
• 该接口可撤回的群聊消息没有时间限制，即可以撤回任何时间的群聊消息，但是群聊消息的漫游时间需要在有效期内。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

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

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

请求包字段说明

应答包体示例

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

应答包字段说明

错误码说明

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

接口调试工具

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

参考

在群组中发送系统通知（v4/group_open_http_svc/send_group_system_notification）。