Feature Description

The app backend can use this callback to monitor users’ group messages in real time. Through this callback, the app backend can be notified of the successfully sent group messages so that it can perform required data synchronization.

Precautions

• To enable this callback, you must configure the callback URL and toggle on the corresponding protocol. For details on the configuration method, see Third-Party Callback Configuration.
• Callback direction: 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 consistent with its own SDKAppID.
• For other security-related issues, see Third-Party Callback Overview: Security Considerations.

Callback Triggering Scenarios

• An app user sends a group message through the client.
• The app admin sends a group message through a RESTful API.

Callback Triggering Time

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

API Description

Request URL example

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

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

Request parameters

Request packet example

{
    "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, // Message sequence number
    "MsgTime": 1490686222, // Message sending time
    "MsgBody": [ // Message body. For more information, see the TIMMessage message object.
        {
            "MsgType": "TIMTextElem", // Text
            "MsgContent": {
                "Text": "red packet"
            }
        }
    ]
}

Request packet fields

Response packet example

After data synchronization, the app backend sends a callback response packet.

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // The result in the response is ignored.
}

Response packet fields

References

• Third-party callback overview
• RESTful APIs: Sending common messages in a group