tencent cloud

Feature Description

This API is used by the app backend to monitor users' group messages in real time. The app backend can be notified when a group message is sent successfully and can synchronize the data as required.

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 of Third-Party Callback Overview.

Callback Trigger Scenarios

• An app user sends a group message on the client.
• The app admin sends a group message via a RESTful API call.

Callback Trigger Time

The callback is triggered after a group message is sent successfully.

API Call 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.CallbackAfterSendMsg", // Callback command
  "GroupId": "@TGS#2J4SZEAEL", // Group ID
  "Type": "Public", // Group type
  "From_Account": "jared", // Sender
  "Operator_Account":"admin", // Request initiator
  "Random": 123456, // Random number
  "MsgSeq": 123, // Sequence number of the message
  "MsgTime": 1490686222, // Time of the message
  "OnlineOnlyFlag": 1, // The value is `1` if it is an online message and `0` (default) if it’s not. For audio-video groups, the value is `0`.
  "MsgBody": [ // Message body. For more information, see the `TIMMessage` message object.
      {
          "MsgType": "TIMTextElem", // Text
          "MsgContent": {
              "Text": "red packet"
          }
      }
  ],
  "CloudCustomData": "your cloud custom data"
}

Request fields

Sample response

A response is sent after the app backend synchronizes the data.

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

Response fields

References

• Third-Party Callback Overview
• RESTful API: Sending Ordinary Messages in a Group