tencent cloud

Feature Description

This API is used by the app backend to operate users' one-to-one messages in real time, including:

• Records one-to-one messages in real time, for example, by recording a log or synchronizing the messages to other systems.
• Collects statistics on one-to-one messages, for example, in terms of the number of users or the number of messages.

Notes

• To enable this callback, you must configure the 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 HTTPS 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.
• If the callback before sending one-to-one messages and the callback after sending one-to-one messages are both enabled and forbidding message sending is returned for the callback before sending one-to-one messages, the callback after sending one-to-one messages cannot be triggered.
• If the callback before sending one-to-one messages and the callback after sending one-to-one messages are both enabled and the message body is modified during the callback before sending one-to-one messages, the callback after sending one-to-one messages will use the modified message for callback.
• For more security considerations, see the Security Considerations section in Third-Party Callback Overview.

Callback Trigger Scenarios

• An app user sends a one-to-one message on the client.
• The app admin sends a one-to-one message by calling the sendmsg RESTful API.

Callback Trigger Time

The callback is triggered after the IM backend receives a one-to-one message sent by a user and sends the message to the target user.

Note：

If the IM backend fails to send the message, for example, due to filtering of restricted words, the callback is still triggered.

API Calling Description

Sample request URL

In the following sample, 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

Sample requests

{
    "CallbackCommand": "C2C.CallbackAfterSendMsg", // Callback command
    "From_Account": "jared", // Sender
    "To_Account": "Jonh", // Recipient
    "MsgSeq": 48374, // Sequence number of the message
    "MsgRandom": 2837546, // Random number of the message
    "MsgTime": 1557481126, // Timestamp in seconds indicating when the message is sent 
    "MsgKey": "48374_2837546_1557481126", // Unique identifier of the message. It can be used to recall the message via a RESTful API call.
    "OnlineOnlyFlag":1, // The value is `1` if it is an online message and `0` if it's not
    "SendMsgResult": 0, // Message sending result
    "ErrorInfo": "send msg succeed", // Error information related to the failure to send the message. If the message is sent successfully, the value of this field is `send msg succeed`.
    "UnreadMsgNum": 7, // Total number of unread one-to-one messages of `To_Account`
    "MsgBody": [ // Message body
        {
            "MsgType": "TIMTextElem", // Text
            "MsgContent": {
                "Text": "red packet"
            }
        }
    ],
    "CloudCustomData": "your cloud custom data"
}

Request fields

Sample response

{
    "ActionStatus":"OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // `0`: callback succeeds; `1`: an error occurs during callback.
}

Response fields

References

• Third-Party Callback Overview
• Callback Before Sending a One-to-One Message
• Sending One-to-One Messages to One User
• Sending One-to-One Messages to Multiple Users