logo
实时音视频
服务端 API
场景服务接口
当前页

SetForbidStreamRule

GET

https://rtc-api.zego.im/

设置音视频流封禁规则。

设置成功后,您可以 查询音视频流封禁规则删除音视频流封禁规则

调用频率限制
同一个 AppID 下所有房间:10 次/秒。
注意

参数 DisableAudio 和 DisableVideo 的使用:

  • 必须至少有一个取值为 1,否则调用本接口会出错。
  • 针对同一条流 ID,如果多次调用本接口设置不同的封禁规则(每次调用接口时的 DisableAudio 和 DisableVideo 参数取值不同),则以最后一次调用接口的参数设置为准。

Request

Query Parameters

    Action stringrequired

    Possible values: [SetForbidStreamRule]

    接口原型参数

    https://rtc-api.zego.im?Action=SetForbidStreamRule

    AppId uint32required

    💡公共参数。AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    💡公共参数。随机字符串。

    Timestamp int64required

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    💡公共参数。签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡公共参数。签名版本号。

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    RoomId stringrequired

    房间 ID。

    StreamId stringrequired

    Possible values: <= 256 characters

    流 ID,最大不超过 256 字节。

    DisableAudio int32

    Possible values: [0, 1]

    Default value: 0

    是否封禁音频。0:不封禁(默认);1:封禁。

    DisableVideo int32

    Possible values: [0, 1]

    Default value: 0

    是否封禁视频。0:不封禁(默认);1:封禁。

    EffectiveTime int64

    Possible values: >= 1 and <= 86400

    Default value: 21600

    封禁规则有效时长,单位:秒。默认 21600。范围 1 ~ 86400(超过 24 小时的取值将自动调整为 24 小时)。

Responses

操作成功
Schema
    Code int32

    返回码。以下仅列出了接口业务逻辑相关的部分返回码,完整返回码请参考 全局返回码

    返回码说明处理建议
    0请求成功。-
    1请求失败。请联系 ZEGO 技术支持处理。
    2输入参数错误。-
    9未开通当前接口的使用权限。请联系 ZEGO 技术支持处理。
    123设置流信息失败。请重试,或联系 ZEGO 技术支持处理。
    206App 请求 QPS 过高被限制。降低请求频率,或联系 ZEGO 技术支持提高 QPS 限制阈值。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。


Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
query
query
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

简介

Next

查询音视频流封禁规则

当前页

返回到顶部