You need to enable JavaScript to run this app.
导航

发送房间内点对点消息 SendRoomUnicast

最近更新时间2024.01.12 16:39:43

首次发布时间2021.11.15 15:01:24

在你的音视频应用中,当你需要从业务服务端,向指定 RTC 房间内指定的一个应用客户端发送消息时,你可以使用 SendRoomUnicast 这个 OpenAPI 实现这一功能。

使用说明

接口行为

你可以调用 SendRoomUnicast 接口,指定你所属的 AppId,通过服务端向指定 RoomId 的 RTC 房间内的指定 userId 的用户发送点对点消息。

注意:

  • 消息可以是文本消息,也可以是二进制消息。
  • 文本消息大小不能超过 64 KB,二进制消息大小不能超过 64 KB。

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

AndroidiOSWindows
文本消息onUserMessageReceivedrtcEngine:onUserMessageReceived:messageOnUserMessageReceived
二进制消息onUserBinaryMessageReceivedrtcEngine:onUserBinaryMessageReceived:messageOnUserBinaryMessageReceived

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

请求频率:对于每个 AppId,调用 SendUnicastSendRoomUnicastSendBroadcastBatchSendRoomUnicast的频率上限之和是 500 次每秒。

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=SendRoomUnicast&Version=2020-12-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringSendRoomUnicast接口名称。当前 API 的名称为 SendRoomUnicast
VersionString2020-12-01接口版本。当前 API 的版本为 2020-12-01

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId应用的唯一标志
RoomIdStringYour_RoomId房间 ID,是房间的唯一标志

From

String

from_server_id

业务服务端的唯一标识。
命名规则符合正则表达式:[a-zA-Z0-9_@\-\.]{1,128}
在一个 AppID 下,不能和真实用户用于实时消息通信的 user_ID 重复;
建议使用固定的 ID 的发送消息。

ToStringto_user_id消息接收用户调用 login 接口登录时设置的 ID,可用于接收房间内消息

Binary

Boolean

false

  • 字段为 true,发送二进制消息;
  • 字段为 false,发送文本消息。
MessageStringhello点对点消息内容。如果是二进制消息,需进行 base64 编码

返回参数

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

参数类型示例值描述
MessageStringsuccess仅在请求成功时返回消息 Success,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=SendRoomUnicast&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "From": "from_user_id",
    "To": "to_user_id",
    "RoomId" : "to_RoomId",
    "Message": "hello",
    "Binary" : true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "SendRoomUnicast",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result":{
        "Message": "Success"
    }
}

错误码

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