提交工单
咨询集成、功能及报价等问题
本接口支持实时查询当前流 ID 是否活跃(存在),只支持查询推流到 ZEGO 媒体服务器(RTC 服务)的流 ID,不支持直接推流到 CDN 或者混流服务器的流 ID。
推荐优先使用 流创建回调 和 流关闭回调 来维护当前推流信息。本接口一般作为流创建回调和流关闭回调的辅助接口,在流创建回调与流关闭回调维护的相关流异常时使用,或者在业务后台查询指定单流是否在推时使用。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
测试环境下(详见 调用方式 - 公共参数 中 “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 |
Number |
返回码。 |
Message |
String |
操作结果描述。 |
RequestId |
String |
请求 ID。 |
Data |
Object |
响应数据。 |
create_time |
String |
开始推流时间。 |
close_time |
String |
停止推流时间。 |
{
"Code": 0,
"Message": "ok",
"RequestId": "98004",
"Data": {
"create_time": "1673334117",
"close_time": ""
}
}
以下仅列出了常见的接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
3000 | 无效的 App。 | 请联系 ZEGO 技术支持处理。 |
3001、30003 | 内部错误。 | 请联系 ZEGO 技术支持处理。 |
3002 | Timestamp 时间戳错误。 | 请重新生成新的 Timestamp。 |
3003 | App 未配置 Token。 | 请联系 ZEGO 技术支持处理。 |
30002 | 接口调用频率过高。 | 请降低接口请求频率。 |
30004 | 参数 isTest 错误。 | 请检查公共请求参数 isTest 是否正确。 |
30005 | 无效的 AppId。 | 请检查 AppId 是否正确。 |
30009 | 无效的 StreamId。 | 请检查 StreamId 是否正确。 |
40005 | 鉴权失败。 | 请检查签名 Signature 是否正确。 |
41004 | StreamId 不存在。 | 请检查 StreamId 是否正确。 |
联系我们
文档反馈