文档中心
服务端 API v2
媒体服务接口
禁止 RTC 推流

禁止 RTC 推流

更新时间：2023-07-12 22:00

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

2 接口原型

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

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

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

参数	类型	是否必选	描述
StreamId	String	是	流 ID。
Sequence	String	是	请求序列号。对于同一个流 StreamId，连续 10 秒内，必须保证发出的该 StreamId 的请求序列号是严格递增的；避免服务端收到请求的时序不一致而导致操作错乱。如果没有并发场景，推荐使用时间戳（毫秒级别）。

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 返回码

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

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

服务端API