设置通道禁止播流

最近更新时间:2024-06-28 15:23:50

我的收藏

1. 接口描述

接口请求域名: iss.tencentcloudapi.com 。

禁止主、子账号对视频通道的实况预览

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SetForbidPlayChannels。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,此参数为可选参数。
Channels.N Array of SetForbidplayChannelParam 要禁播的通道参数,一次最多可以设置200个通道
UserId String 用户uin,可以是子用户的也可以是主用户的uin
示例值:12***36

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 通道禁播使能

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetForbidPlayChannels
<公共请求参数>

{
    "UserId": "10********02",
    "Channels": [
        {
            "ChannelId": "0001a415-****-****-****-b13cfb96c778",
            "Enable": true
        },
        {
            "ChannelId": "00037e5f-****-****-****-f30b13a86b02",
            "Enable": false
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.NotHaveSubUser 没有该子用户
InternalError.ServerInternalError 服务器内部错误
InvalidParameter.InvalidChannels 无效的通道参数
InvalidParameterValue.ChannelsExceedsRange 通道数量超过限制范围
InvalidParameterValue.IllegalChannelId 通道ID包含了非法字符
InvalidParameterValue.InvalidChannelId 无效的通道ID
InvalidParameterValue.InvalidEnalbeValue 无效的使能参数
InvalidParameterValue.InvalidUserParam 无效的用户参数
MissingParameter.MissingMustParameter 缺少必须参数
MissingParameter.MissingUserInfo 缺少用户信息
OperationDenied.NoWhitelist 该功能需要申请白名单配置
OperationDenied.PlayAuthNotEnabled 播放鉴权未开启