全部产品
Search

搜索本产品

    视频直播：ListEventSub - 查询订阅房间消息列表

    文档中心

    视频直播：ListEventSub - 查询订阅房间消息列表

    更新时间：Dec 05, 2024

    查询订阅房间消息列表。

    接口说明

    本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    live:ListEventSublist
    *Rtc
    acs:live::{#accountId}:rtc/{#AppId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    AppIdstring是

    应用 ID。

    		9qb1****

    返回参数

    名称类型描述示例值
    object

    返回参数。

    RequestIdstring

    请求 ID。

    		AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08
    Subscribersarray<object>

    订阅事件列表。

    dataobject

    订阅事件详情。

    SubIdstring

    订阅事件 ID。

    		09be0d2254cb5a89f4cbd86403ec****
    ChannelIdstring

    订阅的频道 ID。

    		testmodify
    Eventsarray

    订阅的事件，取值：

    • ChannelEvent：频道事件，包括频道开启与关闭。
    • UserEvent：用户事件，包括用户入离会等。
    eventsstring

    订阅的事件，取值：

    • ChannelEvent：频道事件，包括频道开启与关闭。
    • UserEvent：用户事件，包括用户入离会等。
    		ChannelEvent
    CallbackUrlstring

    回调地址。

    		http://****.com/callback
    CreateTimestring

    创建订阅时间。东八区时间，是 UTC+8 时区的时间。格式：yyyy-MM-dd hh:mm:ss。

    		2023-08-18 10:14:49
    ModifyTimestring

    修改订阅时间。东八区时间，是 UTC+8 时区的时间。格式：yyyy-MM-dd hh:mm:ss。

    		2023-08-18 10:14:49
    Usersarray

    只回调此用户的事件，不建议与 Roles 同用。

    usersstring

    只回调此用户的事件，不建议与 Roles 同用。

    		testUser
    Rolesdeprecatedinteger

    回调哪个角色的事件，取值：

    • 1：只回调主播事件。
    • 2：只回调观众事件。

    无值或其他值表示回调所有用户事件。

    说明 创建订阅不再支持此参数，此参数已废弃。
    		1

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08",
  "Subscribers": [
    {
      "SubId": "09be0d2254cb5a89f4cbd86403ec****",
      "ChannelId": "testmodify",
      "Events": [
        "ChannelEvent"
      ],
      "CallbackUrl": "http://****.com/callback",
      "CreateTime": "2023-08-18 10:14:49",
      "ModifyTime": "2023-08-18 10:14:49",
      "Users": [
        "testUser"
      ],
      "Roles": 1
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400InputInvalid%s.输入参数不合法
    403NoAuth%s.没有权限
    404ResourceNotExist%s.请求资源不存在，请检查后重新尝试
    500ServerError%s.未知错误，请稍后重试或提交工单咨询。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史