批量发送房间内点对点消息 BatchSendRoomUnicast--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量发送房间内点对点消息 BatchSendRoomUnicast

最近更新时间：2024.07.16 15:31:21首次发布时间：2023.11.01 20:13:18

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

在实时音视频通话场景中，你可以通过调用此接口从业务服务端批量向指定房间内的用户发送点对点消息。

使用说明

接口行为

消息可以是文本消息，也可以是二进制消息。
文本消息大小不能超过 20 KB，二进制消息大小不能超过 20 KB。
该接口支持单次最多同时给600个用户发送点对点消息。

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

	Android	iOS	Windows
文本消息	onUserMessageReceived	rtcRoom:onUserMessageReceived:message:	OnUserMessageReceived
二进制消息	onUserBinaryMessageReceived	rtcRoom:onUserBinaryMessageReceived:message:	OnUserBinaryMessageReceived

注意事项

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

请求说明

请求方式：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	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
RoomId	String	是	`Room1`	房间 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" : "661e****543cf",
    "From" : "from_userid",
    "To" : ["user1", "user2"],
    "RoomId" : "Room1",
    "Message" : "your message",
    "Binary" : false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "BatchSendRoomUnicast",
        "Version": "2023-07-20",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "Success"
    }
}

错误码

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