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

DescribeForbidStreamRules

GET

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

查询音视频流封禁规则。

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

说明
如果所查询的 StreamId 不存在、或未设置任何音视频流封禁规则,则返回结果中所有字段值将会为 0,如响应示例中的 streamId2。
注意

调用 DescribeForbidStreamRules 接口,可以查询到当前处于有效期内的规则,也可以查询到已失效的规则。请注意,ZEGO 会不定期清理数据库中的已失效的封禁规则,调用本接口查询得到的失效规则列表可能不完整。

Request

Query Parameters

    Action stringrequired

    Possible values: [DescribeForbidStreamRules]

    接口原型参数

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

    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 string[]required

    Possible values: >= 1, <= 10

    需要查询的流 ID,调用本接口查询时不可超过 10 个流 ID。

Responses

操作成功
Schema
    Code int32

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

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

    操作结果描述。

    RequestId string

    请求 ID。

    Data object
    RoomId string

    房间 ID。

    ForbidStreamRuleList object[]
    查询到的音视频流封禁规则信息列表。
  • Array[
  • StreamId string

    查询的流 ID。

    DisableAudio int32

    Possible values: [0, 1]

    流 ID 对应的音频是否封禁。0:不封禁;1:封禁。

    DisableVideo int32

    Possible values: [0, 1]

    流 ID 对应的视频是否封禁。0:不封禁;1:封禁。

    CreateTime int64

    音视频流封禁规则的创建时间,Unix 时间戳,单位:秒。

    EffectiveTime int64

    音视频流封禁规则的有效时间,Unix 时间戳,单位:秒。

  • ]

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

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

Previous

设置音视频流封禁规则

Next

删除音视频流封禁规则

当前页

返回到顶部