文档中心

实时音视频

请输入

实时消息通信

发送房间内广播消息 SendBroadcast

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

调用 SendBroadcast 向指定房间内的所有用户广播文本消息或二进制消息。

使用说明

前提条件

对于使用 Native SDK 3.60 及以上版本、Web SDK 4.66 及以上版本，调用本接口前请确保已在 RTC 控制台启用 RTS 高级功能。

说明

若在 SDK 运行期间开启了该功能，则必须重新初始化引擎，配置才能生效。

接口行为

消息发送成功后，用户会通过以下回调收到该消息：

	Android	iOS	Windows
文本消息	onRoomMessageReceived	rtcRoom:onRoomMessageReceived:uid:message:	OnRoomMessageReceived
二进制消息	onRoomBinaryMessageReceived	rtcRoom:onUserBinaryMessageReceived:message:	OnUserBinaryMessageReceived

注意事项

请求频率：对于每个 accountID，调用 `SendUnicast`、`SendRoomUnicast`、`SendBroadcast`与`BatchSendRoomUnicast`的频率上限之和是 500 次每秒。

请求频率：对于每个 accountID，调用 SendUnicast、SendRoomUnicast、SendBroadcast与BatchSendRoomUnicast的频率上限之和是 500 次每秒。

消息大小：文本消息不能超过 64 KB，二进制消息大小不能超过 64 KB。

请求说明

请求方式：POST

请求地址：https://rtc.volcengineapi.com?Action=SendBroadcast&Version=2023-07-20

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：SendBroadcast

接口名称。当前 API 的名称为 SendBroadcast。

Version String 必选示例值：2023-07-20

接口版本。当前 API 的版本为 2023-07-20。

Body

AppId String 必选示例值：66****3cf

实时音视频应用的 AppId。可在控制台获取。

RoomId String 必选示例值：Room1

接收消息的 RTC 房间 ID。

From String 必选示例值：from_server_id

业务服务端的唯一标识。由您自定义，命名规则如下：

需符合正则表达式： [a-zA-Z0-9_@\-\.]{1,128}。

在一个 AppID 下，不能和真实用户的 user_ID 重复。

建议使用固定的 ID 的发送消息。

Binary Boolean 必选示例值：false

消息类型。

true：二进制消息。

false：文本消息。

Message String 必选示例值：hello

广播消息内容。如果是二进制消息，需进行 Base64 编码。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

Message String 示例值：Success

请求成功时返回消息 Success，表示服务端成功接收到消息，失败时返回具体错误信息。

请求示例

POST https://rtc.volcengineapi.com?Action=SendBroadcast&Version=2023-07-20​
{​
    "AppId": "66****3cf",​
    "RoomId": "Room1",​
    "From": "from_user_id",​
    "Message": "hello",​
    "Binary" : flase​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420",​
        "Action": "SendBroadcast",​
        "Version": "2023-07-20",​
        "Service": "rtc",​
        "Region": "cn-north-1"​
    },​
    "Result": {​
        "Message": "Success"​
    }​
}​

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.08.19 17:35:25

这个页面对您有帮助吗？

有用

无用