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

启动旁路推流

更新时间:2022-03-11 11:24

1 描述

调用本接口启动旁路推流任务,可将 RTC 流旁路转推至指定 CDN 直播地址,建议在推流之前调用。

如果开发者不再需要将流转推至 CDN,请参考 停止旁路推流

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

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=CreatCDNTransferRule
  • 传输协议: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=CreatCDNTransferRule
&StreamId=rtc01
&CDNUrl=rtmp%3A%2F%2Fwsdemo.zego.im%2Flivestream%2Frtc01
&Sequence=1617249600001
&<公共请求参数>

5 响应参数

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

6 响应示例

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

7 返回码

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

返回码 说明 处理建议
41001 直播保存失败。 请检查直播是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
41002 频道保存失败。 请检查频道是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
41003 直播不存在。 请检查直播是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
41004 流已不存在。 请检查流是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
42001 禁用直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
42002 恢复直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
42003 批量禁用直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
42004 批量恢复直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
43001 创建录制索引文件失败。 请重试,重试无效请 ZEGO 联系技术支持。