服务端 API v2
  • API概览
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 回调说明
  • 全局返回码
  • 调测指南

禁止 RTC 推流

更新时间:2021-12-02 14:52

1 描述

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

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

ZegoExpress SDK LiveRoom SDK
平台 接口 错误码 接口 错误码
iOS/macOS onPublisherStateUpdate 1003025 onPublishStateUpdate 12301011
Android onPublisherStateUpdate 1003025 onPublishStateUpdate 12301011
Windows onPublisherStateUpdate 1003025 OnPublishStateUpdate 12301011

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

LiveRoom SDK
平台 接口 错误码
iOS/macOS onPlayStateUpdate 12301011
Android onPlayStateUpdate 12301011
Windows OnPlayStateUpdate 12301011

首次使用本接口之前,需要联系 ZEGO 技术支持开通。

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=ForbidRTCStream
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒(测试环境:5 次/秒)

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

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

参数 类型 是否必选 描述
StreamId String 流 ID。
Sequence String 请求序列号,开发者需保证发出的请求严格递增,推荐使用时间戳(毫秒级别)。

4 请求示例

https://rtc-api.zego.im/?Action=ForbidRTCStream
&StreamId=rtc01
&Sequence=1617249600001
&<公共请求参数>

5 响应参数

参数 类型 描述
Code Number 返回码。
Message String 操作结果描述。
RequestId String 请求 ID。
Data Object 响应数据。

6 响应示例

{
    "Code":0,
    "Message":"ok",
    "RequestId":"1929203990360298509",
    "Data":null
}

7 返回码

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

返回码 说明
41001 直播保存失败。
41002 频道保存失败。
41003 直播不存在。
41004 流已不存在。
42001 禁用直播失败。
42002 恢复直播失败。
43001 创建录制索引文件失败。