发送房间外点对点消息 SendUnicast--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

发送房间外点对点消息 SendUnicast

最近更新时间：2024.02.29 19:30:22首次发布时间：2021.11.15 15:01:24

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

使用说明

接口行为

你可以调用 SendUnicast 接口，指定你所属的 AppId，通过服务端向指定 user_Id 的用户发送房间外点对点消息。

注意：
用户只要调用 login 接口完成登录，获得用于接收实时消息的 user_Id，就可以接收来自服务端的房间外消息。
消息可以是文本消息，也可以是二进制消息。
文本消息大小不能超过 64 KB，二进制消息大小不能超过 64 KB。

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

	Android	iOS	Windows
文本消息	`onUserMessageReceivedOutsideRoom`	`rtcEngine:onUserMessageReceivedOutsideRoom:message`	`OnUserMessageReceivedOutsideRoom`
二进制消息	`onUserBinaryMessageReceivedOutsideRoom`	`rtcEngine:onUserBinaryMessageReceivedOutsideRoom:message`	`OnUserBinaryMessageReceivedOutsideRoom`

调用接口

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

注意事项

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

请求说明

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

请求参数

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

Query

参数名称	数据类型	是否必选	示例值	描述
Action	String	是	`SendUnicast`	接口名称。当前 API 的名称为 `SendUnicast`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`Your_AppId`	应用的唯一标志
From	String	是	`from_server_id`	业务服务端的唯一标识。命名规则符合正则表达式：`[a-zA-Z0-9_@\-\.]{1,128}`。在一个 `AppID` 下，不能和真实用户用于实时消息通信的 `user_ID` 重复；建议使用固定的 `ID` 的发送消息。
To	String	是	`to_user_id`	消息接收用户调用 `login` 接口登录时设置的 `ID`，可用于接收房间外消息
Binary	Boolean	是	`false`	字段为 `true`，发送二进制消息；字段为 `false`，发送文本消息。
Message	String	是	`hello`	点对点消息内容。如果是二进制消息，需进行 base64 编码

返回参数

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

参数	类型	示例值	描述
Message	String	`success`	仅在请求成功时返回消息 `Success`，失败时为空。

请求示例

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

返回示例

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

错误码

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