UpdateEventSub - 更新订阅房间消息回调

更新订阅房间消息回调。

接口说明

  • 调用本接口前,您必须已经调用 CreateEventSub 创建订阅房间消息回调。
  • 已有关联频道,依然使用原规则。频道关闭 20 分钟以上,再次开启才会适用新规则。
  • 如果只想更新某些字段,则其他字段也需要用原有内容进行填充。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

订阅的应用 ID。

9qb1****
SubscribeIdstring

订阅事件 ID。您可通过 CreateEventSub 接口的返回参数查询订阅 ID。

ad53276431c****
ChannelIdstring

订阅的频道 ID。订阅的频道 ID。您可通过调用 ListEventSub 接口查询订阅的频道 ID。

说明
  • 如果 Users.N 参数不为空,则此参数必填。
  • ChannelId 为*或者不填,表示为全频道订阅,每个 AppId 只允许 1 个全频道订阅。
  • 每个 AppId 最多同时允许创建 20 个订阅事件。
  • 123333
    Usersarray

    订阅哪些用户的消息。

    string

    订阅哪些用户的消息,参数为空表示订阅该房间全部用户(包含主播和观众)。格式如下所示:

    Users.1=****
    Users.2=****
    ......
    
    user1
    Eventsarray

    订阅事件。

    string

    订阅的事件,取值:

    • ChannelEvent:频道事件。
    • UserEvent:频道内用户事件。
    ChannelEvent
    CallbackUrlstring

    回调地址。回调内容请参见 CallBack

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

    返回参数

    名称类型描述示例值
    object

    返回参数。

    RequestIdstring

    请求 ID。

    AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InputInvalid%s.输入参数不合法
    400QuotaLimitError%s.每个AppId,最多同时允许创建20个订阅,并且只允许1个全频道订阅
    400ErrorInvalidCallBackUrl%s.CallBackURL无效,请检查后重新尝试。
    403NoAuth%s.没有权限
    404ResourceNotExist%s.请求资源不存在,请检查后重新尝试
    500ServerError%s.未知错误,请稍后重试或提交工单咨询。

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

    变更历史

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