服务端 API v2
  • API概览
  • 快速开始
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 场景服务接口
  • 回调说明
  • 全局返回码
  • 使用 Postman 调试

批量禁止 RTC 推流

更新时间:2022-12-07 17:08

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 回调接口:

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

调用本接口后,正在推送的音视频流会被禁止推送,同时流 ID 被记录到后台数据库;不存在的流直接记录到后台数据库,接口正常返回成功。

2 接口原型

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

3 请求参数

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

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

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

4 请求示例

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

5 响应参数

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

6 响应示例

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

7 返回码

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

返回码 说明 处理建议
30002 接口调用频率过高。 请降低接口请求频率。
30003 内部错误。 请联系 ZEGO 技术支持处理。
30004 参数 isTest 错误。 请检查公共请求参数 isTest 是否正确。
30005 无效的 AppId。 请检查 AppId 是否正确。
30006 无效的 StreamId 列表。 请检查 StreamId[] 是否正确。
42003 批量禁用直播失败。 请重试,重试无效请 ZEGO 联系技术支持。