你可以使用此接口指定用户向目标用户发送消息
你可以调用BatchSendMessage接口，指定你所属的AppId和，发送者 UserId、接收方 UserId列表、消息类型和消息内容，进行消息发送。
支持一次对最多500个用户发送单聊消息。
不会触发BeforeSendMessage第三方回调。
发送消息前不会检查发送方是否禁言，也不会检查接收方是否在发送方黑名单中。
关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。
调用频次：12000 条消息/分钟，若一次发给 500 个用户，计作 500 条消息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | BatchSendMessage | 接口名称。当前 API 的名称为 BatchSendMessage。 |
| Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | Integer | 是 | 000000 | 应用的唯一标志 |
| Sender | Long | 是 | 000010 | 消息发送人 UserId |
| Receiver | Array of Long | 是 | [000011,000012] | 消息接收人 UserId 列表 |
| InboxType | Integer | 否 | 0 | 信箱，用做逻辑隔离 默认值为 0 |
| MsgType | Integer | 是 | 10001 | 消息类型 |
| Content | String | 是 | Your_Content | 消息内容。当你给客户端发消息时，Content 内容需符合客户端格式，详细信息请参看消息格式 |
| IsNormalUser | Boolean | 否 | false | 发送者是否为正常用户，true 表示为正常用户，false 表示为机器人，默认为 false |
| Ext | JSON Map | 否 | {"key":"value"} | 消息的扩展字段，key 的数据类型为 String，value 的数据类型为 String |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| UserMessageId | JSON Map | {"1":123} | 消息Id列表，key是String类型为用户UserId，value是Long类型为消息Id |
| FailedReceiver | Array of Long | [1,2,3] | 发送失败用户 UserId 列表 |
POST https://rtc.volcengineapi.com?Action=BatchSendMessage&Version=2020-12-01 { "AppId": 666675, "Sender": 10001, "Receiver": [1,2,3], "InboxType": 0, "MsgType": 10001, "Content": "消息群发123", "IsNormalUser": false, "Ext": { "key": "value" } }
{ "ResponseMetadata": { "RequestId": "20240515160313C****B7EBFDF76AA168D", "Action": "BatchSendMessage", "Version": "2020-12-01", "Service": "rtc", "Region": "cn-north-1" }, "Result": { "UserMessageId": { "1": 7368834896, "2": 735697664 }, "FailedReceiver": [3] } }
您可访问公共错误码，获取更多错误码信息。