tencent cloud

Overview

This API is used by the app backend to view the recalls of group messages in real time.

Notes

• To enable this callback, you must configure a callback URL and enable the corresponding switch for this callback. For more information on the configuration method, see Callback Configuration.
• During this callback, the IM backend initiates an HTTP POST request to the app backend.
• After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
• For more security considerations, see the Security Considerations section in Third-Party Callback Overview.

Callback Trigger Scenarios

• An app user recalls a group message on the client.
• An app admin recalls a group message via calling the RESTful API.

Callback Trigger Timing

After a group message is recalled successfully

API Calling Description

Sample request URL

In the following sample, the callback URL configured in the app is https://www.example.com.
Sample:

https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request parameters

Sample request

{
  "CallbackCommand":"Group.CallbackAfterRecallMsg", // Callback command
  "Operator_Account":"admin", // Operator
  "Type": "Public", // Group type
  "GroupId":"1213456", // Group ID
  "MsgSeqList":[ // `MsgSeq` list of recalled messages           
      {"MsgSeq":130}
  ]
}

Request fields

Sample response

{
  "ActionStatus": "OK",
  "ErrorInfo":"",
  "ErrorCode": 0 //The value `0` indicates that the callback result is ignored.
}

Response fields

References

• Third-Party Callback Overview
• Restful API: Recalling Group Messages