发送透传消息 P2PSendMessage--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

发送透传消息 P2PSendMessage

最近更新时间：2024.06.07 18:33:44首次发布时间：2024.06.07 18:33:44

你可以使用此接口指定用户在某个会话中发送透传消息

使用说明

接口行为

你可以调用P2PSendMessage接口，指定你所属的AppId和，发送者 UserId、会话 ID、消息类型和消息内容，进行消息透传发送。
用户需要在会话中才允许消息发送，且不会触发第三方回调。
发送消息前不会检查发送方是否禁言，也不会检查会话是否开启禁言。
透传消息客户端不会存储到本地数据库，只有当用户在线时才可以正常收到透传消息，适用于一些在线通知。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过100。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`666675`	应用的唯一标志
Sender	Long	是	`10008`	消息发送人 UserId
ConversationShortId	Long	是	`7221856821303362000`	会话 ID
MsgType	Integer	是	`10013`	消息类型
Content	String	是	`{"type":1000,"ext":"","message_type":10001}`	消息内容，可以由你们自定义格式，对于IM服务端仅做透传
ReceiverUserId	Array of Long	否	`[111111,222222,33333]`	接收人列表。默认是会话中所有人都可收到透传消息，指定此字段，可以让某个会话中，仅个别人收到此透传消息。如果此字段有值，下面的`IgnoreUserIds`将不会生效
IgnoreUserIds	Array of Long	否	`[11111,2222,3333]`	忽略人列表。默认是会话中所有人都可收到透传消息，指定此字段，可以排除会话中指定的用户，让这些用户无法收到透传消息。

返回参数

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

参数	类型	示例值	描述
P2PResult	Array of P2PResult	`{ "UserId": 10008, "Code": "Success", "DevicePlatform": "Web" }`	透传消息推送结果

P2PResult

参数类型示例值描述

UserId Long 10008 接收人UserId

参数	类型	示例值	描述
UserId	Long	`10008`	接收人UserId
Code	String	`SUCCESS`	透传消息推送结果码 `SUCCESS`:表示成功接收 `NOT_ONLINE`:表示用户不在线无法收到透传消息
DevicePlatform	String	`Web`	用户此时登陆的平台信息 `Android` `Web` `IOS`

Code

String

SUCCESS

透传消息推送结果码

SUCCESS:表示成功接收
NOT_ONLINE:表示用户不在线无法收到透传消息

DevicePlatform

String

Web

用户此时登陆的平台信息

Android
Web
IOS

请求示例

POST https://rtc.volcengineapi.com?Action=P2PSendMessage&Version=2020-12-01
{
  "AppId": 666675,
  "Sender": 10008,
  "ConversationShortId": 7221856821303361536,
  "MsgType": 10013,
  "Content": "{\"type\":1000,\"ext\":\"\",\"message_type\":10001}",
  "ReceiverUserId": [],
  "IgnoreUserIds": []
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240604150611EC00A9D1A0E4F0DF98AB",
        "Action": "P2PSendMessage",
        "Version": "2020-12-01",
        "Service": "",
        "Region": ""
    },
    "Result": {
        "P2PResult": [
            {
                "UserId": 10008,
                "Code": "NOT_ONLINE",
                "DevicePlatform": "Default"
            },
            {
                "UserId": 10001,
                "Code": "SUCCESS",
                "DevicePlatform": "Web"
            }
        ]
    }
}

错误码

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