Feature Description

This API is used by app admins to recall messages of a specified group. The messages must be within the roaming validity period.

API Calling Description

Applicable group types

These are the 4 built-in group types in IM. For detailed information, see the Group System.

Sample request URL

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

Request parameters

The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 calls per second.

Sample request packet

Messages that have been recalled cannot be restored. Therefore, use this API with caution.

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

Request packet fields

Sample response packet body

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

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response packet fields such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:

API Debugging Tool

Use the online debugging tool for RESTful APIs to debug this API.

Reference

Sending system messages in a group (v4/group_open_http_svc/send_group_system_notification)