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

ForbidRTCStream

GET

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

调用本接口禁止 RTC 推流,可以禁止指定流 ID 推送到 RTC 服务。禁止推流操作会向正在推流的客户端和正在拉流的客户端发送推流被禁止的通知。

推流客户端接收推流被服务端禁止的通知使用 ZEGO Express SDK 回调接口:

平台ZegoExpress SDKLiveRoom SDK
接口错误码接口错误码
iOS/macOSonPublisherStateUpdate1003025onPublishStateUpdate12301011
AndroidonPublisherStateUpdate1003025onPublishStateUpdate12301011
WindowsonPublisherStateUpdate1003025OnPublishStateUpdate12301011

拉流客户端接收所拉流被服务端禁止的通知使用 ZEGO Express SDK 回调接口:

平台ZegoExpress SDKLiveRoom SDK
接口错误码接口错误码
iOS/macOSonPlayerStateUpdate1004025onPlayStateUpdate12301011
AndroidonPlayerStateUpdate1004025onPlayStateUpdate12301011
WindowsonPlayerStateUpdate1004025OnPlayStateUpdate12301011
调用频率限制
同一个 AppID 下所有房间:20 次/秒(测试环境:5 次/秒)
说明

测试环境下(详见 IsTest 公共参数说明),流 ID 需要加上 “zegotest-AppId-” 前缀。例如,流 ID 为 “test”,在 AppId 为 “123456789” 的测试环境下,流 ID 应为 “zegotest-123456789-test”。

Request

Query Parameters

    Action string必填

    可选值: [ForbidRTCStream]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    IsTest string

    可选值: [false, true]

    默认值: false

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

    ⚠️注意:测试环境跟正式环境是隔离的,请不要在操作正式环境 appid 时误把该参数标记为 true。2021-11-16 及之后创建的项目建议不要填写该参数

    📌是否必填参数:2021-11-16 及之前在 ZEGO 控制台创建的项目为必填,之后创建的则不是必填。

    StreamId string必填

    流 ID。

    Sequence string必填

    请求序列号。

    注意

    对于同一个流 StreamId,连续 10 秒内,必须保证发出的该 StreamId 的请求序列号是严格递增的;避免服务端收到请求的时序不一致而导致操作错乱。

    如果没有并发场景,推荐使用时间戳(毫秒级别)。

Responses

成功
Schema
    Code number

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

    返回码说明处理建议
    3000无效的 App。请联系 ZEGO 技术支持处理。
    3001、5006、30003内部错误。请联系 ZEGO 技术支持处理。
    3002Timestamp 时间戳错误。请重新生成新的 Timestamp。
    3003App 未配置 Token。请联系 ZEGO 技术支持处理。
    30002接口调用频率过高。请降低接口请求频率。
    30004参数 isTest 错误。请检查公共请求参数 isTest 是否正确。
    30005无效的 AppId。请检查 AppId 是否正确。
    30009无效的 StreamId,流名不规范。请检查 StreamId 是否符合流名编码规范。
    40005鉴权失败。请检查签名 Signature 是否正确。
    Message string

    操作结果描述

    RequestId string

    请求 ID


Request
折叠所有
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

恢复 CDN 推流

Next

恢复 RTC 推流

当前页

返回到顶部