You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/即时通讯 IM/服务端 API 参考/服务端 OpenAPI/消息相关/消息管理/发送用户透传消息
发送用户透传消息
最近更新时间：2025.09.02 17:32:13首次发布时间：2025.09.02 17:32:13
复制全文
我的收藏
有用
有用
无用
无用

你可以使用此接口向指定用户或全部在线用户发送透传消息

使用说明

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

注意事项

  • 若指定接收者 UserId 发送消息，QPS 不得超过 100；若给全部在线用户发送消息，QPS 不得超过 1。
  • 限制 25000 条消息/分钟，若一次发给 500 个用户，计作 500 条消息。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志

MsgType

Integer

是

10015

消息类型

  • 10013：普通透传消息
  • 10015：用户在线状态变更消息
SenderInteger是000010消息发送人 UserId
ReceiversArray of Integer否[111111,222222]消息接收人 UserId，最多支持 500 个
ToAllOnlineUsersBoolean否false指定接收方为全部在线用户，默认为 false，指定为 true 时，Receivers 不生效
ContentString是Your_Content消息内容。当你给客户端发消息时，Content 内容需符合客户端格式，详细信息请参看消息格式
ExtJSON Map否{"key":"value"}消息的扩展字段，key 的数据类型为 String，value 的数据类型为 String
CreateTimeInteger否1666613688658消息时间，毫秒时间戳，若不指定，默认服务端接收请求时间

返回参数

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

参数类型示例值描述
P2PResultArray of P2PResult{ "UserId": 10008, "Code": "Success", "DevicePlatform": "Web" }透传消息推送结果
SuccessCountString1成功推送数量，若同一用户多平台登录，会计数多次

P2PResult

参数类型示例值描述
UserIdInteger111111接收人 UserId

Code

String

SUCCESS

透传消息推送结果码

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

DevicePlatform

String

Web

用户此时登陆的平台信息

  • Android
  • Web
  • IOS

请求示例 1

发送自定义透传消息

POST https://rtc.volcengineapi.com?Action=P2PSendUserMessage&Version=2020-12-01
{
    "AppId": 000000,
    "MsgType": 10013,
    "Sender": 000001,
    "Receivers": [
        111111
    ],
    "ToAllOnlineUsers": false,
    "Content": "Your_Content"
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "202508271438357****F8BA1DF4BAAA08F",
        "Action": "P2PSendUserMessage",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "P2PResult": [
            {
                "UserId": 111111,
                "Code": "SUCCESS",
                "DevicePlatform": "Web"
            }
        ],
        "SuccessCount": 1
    }
}

请求示例 2

发送用户在线状态变更透传消息

POST https://rtc.volcengineapi.com?Action=P2PSendUserMessage&Version=2020-12-01
{
    "AppId": 000000,
    "MsgType": 10015,
    "Sender": 000001,
    "Receivers": [
        111111
    ],
    "ToAllOnlineUsers": false,
    "Content": "{\"UserId\": 100001, \"Action\":\"Online\"}"
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "202508271438357****F8BA1DF4BAAA08F",
        "Action": "P2PSendUserMessage",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "P2PResult": [
            {
                "UserId": 111111,
                "Code": "SUCCESS",
                "DevicePlatform": "Web"
            }
        ],
        "SuccessCount": 1
    }
}

错误码

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