文档

更新订阅房间消息回调

更新时间:

调用UpdateEventSub更新订阅房间消息回调。

使用说明

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

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String UpdateEventSub

系统规定参数。取值:UpdateEventSub

AppId String 9qb1****

订阅的应用ID。

SubscribeId String ad53276431c****

订阅事件ID。

ChannelId String 123333

订阅的频道ID。

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

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

Users.1=****
Users.2=****
......
Events.N String ChannelEvent

订阅的事件,取值:

  • ChannelEvent:频道事件。
  • UserEvent:频道内用户事件。
CallbackUrl String http://****.com/callback

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

返回数据

名称

类型

示例值

描述

RequestId String AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateEventSub
&AppId=9qb1****
&SubscribeId=ad53276431c****
&ChannelId=123333
&Users=["user1"]
&Events=["ChannelEvent"]
&CallbackUrl=http://****.com/callback
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateEventSubResponse>
    <RequestId>AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08</RequestId>
</UpdateEventSubResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode

错误码

错误信息

描述

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

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