调用UpdateEventSub更新订阅房间消息回调。
接口说明
使用说明
- 调用本接口前,您必须已经调用 CreateEventSub 创建订阅房间消息回调。
- 已有关联频道,依然使用原规则。频道关闭 20 分钟以上,再次开启才会适用新规则。
- 如果只想更新某些字段,则其他字段也需要用原有内容进行填充。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:UpdateEventSub | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 订阅的应用 ID。 | 9qb1**** |
SubscribeId | string | 是 | 订阅事件 ID。 | ad53276431c**** |
ChannelId | string | 否 | 订阅的频道 ID。 说明
| 123333 |
Users | array | 否 | 订阅哪些用户的消息。 | |
string | 否 | 订阅哪些用户的消息,参数为空表示订阅该房间全部用户(包含主播和观众)。格式如下所示:
| user1 | |
Events | array | 是 | 订阅事件。 | |
string | 是 | 订阅的事件,取值:
| ChannelEvent | |
CallbackUrl | string | 是 | 回调地址。回调内容请参见 CallBack 。 | http://****.com/callback |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InputInvalid | %s. | 输入参数不合法 |
400 | QuotaLimitError | %s. | 每个AppId,最多同时允许创建20个订阅,并且只允许1个全频道订阅 |
400 | ErrorInvalidCallBackUrl | %s. | CallBackURL无效,请检查后重新尝试。 |
403 | NoAuth | %s. | 没有权限 |
404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史