实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考实时消息通信批量发送房间内点对点消息 BatchSendRoomUnicast
复制全文
下载 pdf批量发送房间内点对点消息 BatchSendRoomUnicast
文档反馈
问问助手通过 BatchSendRoomUnicast 批量向 RTC 房间内的多个用户发送点对点文本消息或二进制消息。
使用说明
前提条件
若在 SDK 运行期间开启了该功能，则必须重新初始化引擎，配置才能生效。
接口行为
消息发送成功后，已进房的 RTC 用户可通过 onUserMessageReceived 或 onUserBinaryMessageReceived 回调收到该消息。各端回调说明参见业务服务器向客户端发送消息。
注意事项
- 请求频率：对于每个 accountID，调用 SendUnicast、SendRoomUnicast、SendBroadcast与BatchSendRoomUnicast的频率上限之和是 500 次每秒。参看使用限制获取更多信息。
- 使用限制：
- 消息大小不能超过 20 KB。
- 单次最多同时给 600 个用户发送点对点消息。
- RTS SDK 不支持接收通过本接口发送的消息。如需通过 RTS SDK 接收点对点消息，请使用 SendUnicast。
请求说明
- 请求方式：POST
- 请求地址：https://rtc.volcengineapi.com?Action=BatchSendRoomUnicast&Version=2023-07-20
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：BatchSendRoomUnicast
接口名称。当前 API 的名称为 BatchSendRoomUnicast。
Version String 必选 示例值：2023-07-20
接口版本。当前 API 的版本为 2023-07-20。
Body
AppId String 必选 示例值：66****3cf
RoomId String 必选 示例值：Room1
接收消息的 RTC 房间 ID。
From String 必选 示例值：from_userid
业务服务端的唯一标识。由您自定义，命名规则如下：
- 需符合正则表达式： [a-zA-Z0-9_@\-\.]{1,128}。
- 在一个 AppID 下，不能和真实用户的 user_ID 重复。
- 建议使用固定的 ID 的发送消息。
To String[] 必选 示例值：[user1, user2]
消息接收者的 user_ID。
Binary Boolean 必选 示例值：false
消息类型。
- true：二进制消息。
- false：文本消息。
Message String 必选 示例值：hello
消息内容。如果是二进制消息，需进行 Base64 编码。
返回参数
Message String 示例值：success
请求成功时返回消息 Success，表示服务端成功接收到消息，失败时返回具体错误信息。
请求示例
POST https://rtc.volcengineapi.com?Action=BatchSendRoomUnicast&Version=2023-07-20
{
"AppId" : "66****3cf",
"From" : "from_userid",
"To" : ["user1", "user2"],
"RoomId" : "Room1",
"Message" : "your message",
"Binary" : false
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "BatchSendRoomUnicast",
"Version": "2023-07-20",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"Message": "Success"
}
}
错误码
最近更新时间：2026.07.01 15:48:23
这个页面对您有帮助吗？
有用
有用
无用
无用