Features

• When the admin sends a message to an account, the recipient will see that the message sender is the admin.
• When the admin specifies an account to batch send a message to target accounts, the sender displayed to the recipients is not the admin, but is the account specified by the admin.
• This API does not check whether the sender and the recipient are friends or blocked by either party or whether the recipient is muted.

Note：

When the server uses this RESTful API to send one-to-one messages, you can choose whether to synchronize the messages to the sender (admin account or the account specified by the admin). The synchronization methods include online terminals and the roaming server. The RESTful API provides the SyncOtherMachine parameter to determine whether to synchronize the messages. For details, see “Sample request packets”.

API Call Description

Sample request URL

https://console.tim.qq.com/v4/openim/sendmsg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table lists and describes only the parameters to be modified when this API is called. For more parameters, see the RESTful API Overview.

Maximum call frequency

200 calls per second

Sample request packet

Here, we use sending text messages as an example. To send messages of other types, set MsgBody to the corresponding message type. For details, see Message Format Description.

The admin sends messages to another account

Note：

If you do not want to synchronize messages to From_Account, set SyncOtherMachine to 2. To synchronize messages to From_Account, set SyncOtherMachine to 1.

{
    "SyncOtherMachine": 2, // Do not synchronize messages to the sender.
    "To_Account": "lumotuwe2",
    "MsgLifeTime":60, // Messages are retained for 60 seconds.
    "MsgRandom": 1287657,
    "MsgTimeStamp": 1557387418,
    "MsgBody": [
        {
            "MsgType": "TIMTextElem",
            "MsgContent": {
                "Text": "hi, beauty"
            }
        }
    ]
}

The admin sends messages to another account and forbids callbacks for the messages

Note：

If you do not want to synchronize messages to From_Account, set SyncOtherMachine to 2. To synchronize messages to From_Account, set SyncOtherMachine to 1.

{
    "SyncOtherMachine": 2, // Do not synchronize messages to the sender.
    "To_Account": "lumotuwe2",
    "MsgLifeTime":60, // Messages are retained for 60 seconds.
    "MsgRandom": 1287657,
    "MsgTimeStamp": 1557387418,
    "ForbidCallbackControl":[
        "ForbidBeforeSendMsgCallback",
        "ForbidAfterSendMsgCallback"], // Callback forbidding control options
    "MsgBody": [
        {
            "MsgType": "TIMTextElem",
            "MsgContent": {
                "Text": "hi, beauty"
            }
        }
    ]
}

The admin specifies an account to send messages to another account and enables offline information push, without synchronizing the messages to From_Account

Note：

If you do not want to synchronize messages to From_Account, set SyncOtherMachine to 2.

{
    "SyncOtherMachine": 2,
    "From_Account": "lumotuwe1",
    "To_Account": "lumotuwe2",
    "MsgLifeTime":3600, // Messages are retained for one hour.
    "MsgRandom": 1287657,
    "MsgTimeStamp": 1557387418,
    "MsgBody": [
        {
            "MsgType": "TIMTextElem",
            "MsgContent": {
                "Text": "hi, beauty"
            }
        }
    ],
    "OfflinePushInfo": {
        "PushFlag": 0,
        "Desc": "The content that is pushed offline",
        "Ext": "The passthrough content",
        "AndroidInfo": {
            "Sound": "android.mp3"
        },
        "ApnsInfo": {
            "Sound": "apns.mp3",
            "BadgeMode": 1, // If this parameter is not specified or is set to 0, the message is counted. If this parameter is set to 1, the message is not counted, that is, the icon number in the upper-right corner does not increase by 1.
            "Title":"apns title", // apns title
            "SubTitle":"apns subtitle", // apns subtitle
            "Image":"www.image.com" // image url
        }
    }
}

The admin specifies an account to send messages to another account and enables synchronization of the messages to From_Account (the sender’s terminal)

Note：

To synchronize messages to From_Account, set SyncOtherMachine to 1.

{
    "SyncOtherMachine": 1, // Synchronize messages to the sender.
    "From_Account": "lumotuwe1",
    "To_Account": "lumotuwe2",
    "MsgRandom": 1287657,
    "MsgTimeStamp": 1557387418,
    "MsgBody": [
        {
            "MsgType": "TIMTextElem",
            "MsgContent": {
                "Text": "hi, beauty"
            }
        }
    ]
}

Request packet fields

Sample response packets

• Normal response

  {
    "ActionStatus":"OK", 
    "ErrorInfo":"", 
    "ErrorCode": 0, 
    "MsgTime": 1497238162,
    "MsgKey": "89541_2574206_1572870301"
  }

• Exceptional response

  {
    "ActionStatus": "FAIL", 
    "ErrorInfo": "Fail to Parse json data of body, Please check it", 
    "ErrorCode": 90001
  }

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet indicate the actual error code and error information, respectively.
For public error codes (60000 to 79999), see Error Codes.
The list below contains only error codes specific to this API:

API Debugging Tool

Use the online RESTful API debugging tool to debug this API.

References

Batch sending one-to-one messages (v4/openim/batchsendmsg)
Querying one-to-one messages (v4/openim/admin_getroammsg)
Recalling one-to-one messages (v4/openim/admin_msgwithdraw)

Possible Callbacks

• Callback before sending one-to-one messages
• Callback after sending one-to-one messages