Feature Description

• 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 send a message to another account, the recipient will see that the sender is not the admin but the account specified by the admin.
• This API does not check whether the sender and the recipient are friends (nor does it check the blocklist) or whether the recipient is muted.

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 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 packet”.

API Calling 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 is a list of the parameters commonly used when calling this API and their descriptions. For more parameters, see the RESTful API Overview.

Maximum calling frequency

200 times/second

Sample request packets

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

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, // Messages are not synchronized 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 specifies an account to send messages to another account and enables offline information push, without synchronizing the messages to From_Account

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": "Offline push content",
        "Ext": "This is the passthrough content",
        "AndroidInfo": {
            "Sound": "android.mp3"
        },
        "ApnsInfo": {
            "Sound": "apns.mp3",
            "BadgeMode": 1, // The default value is 0, indicating that a message is counted. The value 1 indicates that the message is not counted, that is, the icon number in the upper right corner does not increase by one.
            "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)

To synchronize messages to From_Account, set SyncOtherMachine to 1.

{
    "SyncOtherMachine": 1, // Messages are synchronized 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 packet

• 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 represent the actual error code and error information.
For public error codes (60000 to 79999), see Error Codes.
The following are error codes specific to this API:

API Debugging Tool

Use the RESTful API online 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)

Callbacks That May Be Triggered

• Callback before sending one-to-one messages
• [Callback after sending one-to-one messages] (https://intl.cloud.tencent.com/document/product/1047/34365)