RTC 流状态查询

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

1 描述

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

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

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

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

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

参数	类型	是否必选	描述
StreamId	String	是	流 ID。
Sequence	String	是	请求序列号，开发者需保证发出的请求严格递增，推荐使用时间戳（毫秒级别）。

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

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

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

本文档是否帮助你解决问题？

有帮助

没有帮助

如果遇到产品相关问题，您可咨询在线客服或者创建工单寻求帮助