Feature Description

• This API is used to send one-to-one messages to multiple users (up to 500) at a time.
• Compared with the API for sending one-to-one messages to one user, this API is more suitable for time-sensitive messages, such as marketing messages and system notifications.
• When the administrator specifies an account to send a message to multiple target accounts, the sender displayed to the recipients is not the administrator, but the account specified by the administrator.
• This API does not trigger callback requests.
• This API does not check whether the sender and the recipients are friends or blocklisted by either party or whether the recipients are muted.

Note：

When calling this API to batch send a 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, please see Sample request packet below.

API Call Description

Sample request URL

https://console.tim.qq.com/v4/openim/batchsendmsg?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 multiple target accounts.

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": [ // A list of target accounts
        "bonnie",
        "rong"
    ],
    "MsgRandom": 19901224, // The random number of the message
    "MsgBody": [ // The body of the message
        {
            "MsgType": "TIMTextElem", // The type of the message. `TIMTextElem` indicates text messages.
            "MsgContent": {
                "Text": "hi, beauty" // The text of the message
            }
        }
    ]
}

The administrator specifies an account to send a message to multiple target accounts and sets the information of offline push.

From_Account is the sender specified by the administrator. The sender displayed to the recipients is not the administrator, but the account specified by the administrator. In the following JSON request, dave sends a message to bonnie and rong. When bonnie and rong receive the message, the message sender displayed to them is dave.

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": 1, // Synchronize the message to the sender.
    "From_Account": "dave",
    "To_Account": [
        "bonnie",
        "rong"
    ],
    "MsgRandom": 19901224,
    "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
        }
    }
}

Request packet fields

Sample response packets

• Response when the message was sent to all the target accounts

  {
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "MsgKey": "128493_903762_1572870301"
  }

• Response when the message was not sent to some target accounts

  {
    "ActionStatus": "SomeError",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "MsgKey": "4852_28135_1579678877",
    "ErrorList": [ // A list of the accounts to which the message was not sent
        {
            "To_Account": "rong", // The account to which the message was not sent
            "ErrorCode":  70107 // Error code. 70107 indicates that the account does not exist.
        }
    ]
  }

• Response when the message was sent to none of the target accounts

  {
    "ActionStatus": "FAIL",
    "ErrorInfo": "invalid To_Account",
    "ErrorCode": 90012
  }

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 One User (v4/openim/sendmsg)
• Sending Ordinary Messages in a Group (v4/group_open_http_svc/send_group_msg)
• Sending System Messages in a Group (v4/group_open_http_svc/send_group_system_notification)
• Message Formats