Feature Description

• When the administrator sends a message to an account, the sender displayed to the recipient is the administrator.
• When the administrator specifies an account to send a message to another account, the sender displayed to the recipient is not the administrator, but the account specified by the administrator.
• This API does not check whether the sender and the recipient are friends or blocklisted by either party or whether the recipient is muted.

Note：

When calling this API to send a one-to-one message, you must specify whether to synchronize the message to the sender, which is the administrator account or the account specified by the administrator. Synchronization can be implemented via online terminals and roaming servers. This API provides the SyncOtherMachine parameter to determine whether to synchronize the message. For more information, see Sample request packet below.

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 only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Introduction.

Maximum call frequency

200 calls per second

Sample request packets

Here, we use sending a text message as an example. To send messages of other types, set MsgBody to the corresponding message type. For more information, see Message Formats.

The administrator sends a message to another account.

Note：

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

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

The administrator sends a message to another account and forbids callbacks for the message.

Note：

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

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

The administrator specifies an account to send a message to another account and set the information of offline push, without synchronizing the message to From_Account.

Note：

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

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

The administrator specifies an account to send a message to another account and allows synchronization of the message to From_Account (the sender’s terminal).

Note：

To synchronize the message to From_Account, set SyncOtherMachine to 1.

{
    "SyncOtherMachine": 1, // Synchronize the message 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

• Response to a successful request

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

• Response to a failed request

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

Response packet fields

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively.
For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:

API Debugging Tool

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

References

Sending One-to-One Messages to Multiple Users (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 a One-to-One Message
• Callback After Sending a One-to-One Message