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

停止旁路推流

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

1 描述

调用本接口停止旁路推流。如果指定流正旁路推流至 CDN 直播服务,则会停止该转推任务。开发者需要保证转推的地址一致 (携带参数可以不一致),才能够正确停止对应的转推任务。

开发者 启动旁路推流,将 RTC 流旁路转推至指定 CDN 直播地址后,如果不再需要将流转推至 CDN 时,请参考本文档停止旁路推流。

2 接口原型

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

3 请求参数

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

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

参数 类型 是否必选 描述
StreamId
String
流 ID。
CDNUrl
String
转推的 CDN 地址,必须是 RTMP 格式。

使用时,请对该参数内容进行 UrlEncode。

Sequence
String
请求序列号,开发者需保证发出的请求严格递增,推荐使用时间戳(毫秒级别)。

4 请求示例

https://rtc-api.zego.im/?Action=DeleteCDNTransferRule
&StreamId=rtc01
&CDNUrl=rtmp%3A%2F%2Fwsdemo.zego.im%2Flivestream%2Frtc01
&Sequence=1617249600002
&<公共请求参数>

5 响应参数

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

6 响应示例

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

7 返回码

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

返回码 说明 处理建议
5000、5001、5002、5006、30003 内部错误。 请联系 ZEGO 技术支持处理。
5003 鉴权失败。 请检查签名 Signature 是否正确。
5004 无效的 CDN 地址。 请检查请求参数 CDNUrl 是否正确。
5005 无效请求。 请联系 ZEGO 技术支持处理。
5007、30002 接口调用频率过高。 请降低接口请求频率。
30004 参数 isTest 错误。 请检查公共请求参数 isTest 是否正确。
30005 无效的 AppId。 请检查 AppId 是否正确。
30009 无效的 StreamId。 请检查 StreamId 是否正确。