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

RTC 流状态查询

更新时间:2021-10-25 17:43

1 描述

本接口支持实时查询当前流 ID 是否活跃(存在),只支持查询推流到 ZEGO 媒体服务器(RTC 服务)的流 ID,不支持直接推流到 CDN 或者混流服务器的流 ID。

推荐优先使用 流创建回调流关闭回调 来维护当前推流信息。本接口一般作为流创建回调和流关闭回调的辅助接口,在流创建回调与流关闭回调维护的相关流异常时使用,或者在业务后台查询指定单流是否在推时使用。

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

2 接口原型

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

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=DescribeRTCStreamState
&StreamId=rtc01
&Sequence=1617249600001
&<公共请求参数>

5 响应参数

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

6 响应示例

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

7 返回码

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

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