发送房间外点对点消息 SendUnicast

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

使用说明

接口行为

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

注意：

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

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

调用接口

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

注意事项

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

请求说明

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

请求参数

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

Query

Body

返回参数

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

请求示例

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"
    }
}

错误码

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