tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    After a One-to-One Message Is Sent

    Last updated: 2024-06-25 16:45:14
    Download PDF

      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

      Parameter
      Description
      https
      The request protocol is HTTPS and the request method is POST.
      www.example.com
      Callback URL
      SdkAppid
      SDKAppID assigned by the IM console when an app is created
      CallbackCommand
      The value is always C2C.CallbackAfterSendMsg.
      contenttype
      The value is always JSON.
      ClientIP
      IP address of the client, such as 127.0.0.1
      OptPlatform
      Platform of the client. For more information about valid values, see the description of OptPlatform in the Callback Protocols section of Third-Party Callback Overview.

      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

      Field
      Type
      Description
      CallbackCommand
      String
      Callback command
      From_Account
      String
      UserID of the message sender
      To_Account
      String
      UserID of the message recipient
      MsgSeq
      Integer
      Sequence number of the message. It is used to identify the message and the value is a random 32-bit unsigned integer.
      MsgRandom
      Integer
      Random number of the message. It is used to identify the message and the value is a random 32-bit unsigned integer.
      MsgTime
      Integer
      Timestamp in seconds indicating when the message is sent.
      One-to-one messages are preferentially sorted by MsgTime. Messages sent in the same second are sorted by MsgSeq. Messages with larger values of MsgSeq are after those with smaller values of MsgSeq.
      MsgKey
      String
      Unique identifier of the message. It can be used to recall the message via a RESTful API call.
      MsgId
      String
      Unique identifier of the message on the client.
      OnlineOnlyFlag
      Integer
      The value is 1 if it means only to online users and 0 if it's not.
      SendMsgResult
      Integer
      Message sending result. 0: successful; other values: failed. For more information, see Error Codes.
      ErrorInfo
      String
      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
      Integer
      Total number of unread one-to-one messages of To_Account (including all one-to-one conversations). If the message fails to be sent, for example, due to filtering of restricted words, the value of this field is -1.
      MsgBody
      Array
      Message body. For more information, see Message Formats.
      CloudCustomData
      String
      Custom message data. It is saved in the cloud and will be sent to the peer end. Such data can be pulled after the app is uninstalled and reinstalled.

      Sample response

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

      Response fields

      Field
      Type
      Required
      Description
      ActionStatus
      String
      Yes
      Request result. OK: successful; FAIL: failed
      ErrorCode
      Integer
      Yes
      Error code. 0: callback succeeds; 1: an error occurs during callback.
      ErrorInfo
      String
      Yes
      Error information
      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
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy