DescribeRTCStreamState
GET
https://rtc-api.zego.im/
本接口支持查询指定流的实时状态(是否活跃或存在)。只支持查询推流到 ZEGO 媒体服务器(RTC 服务)的流,不支持查询直接推流到 CDN 或者混流服务输出的流。
推荐优先使用 流创建回调 和 流关闭回调 异步获取当前推流信息。本接口一般作为流创建回调和流关闭回调的辅助接口,或者在业务后台查询指定单流是否活跃时使用。
说明
本接口默认支持在开始推流后,对流状态信息进行查询。
调用频率限制
同一个 AppID 下所有房间:40 次/秒(测试环境:10 次/秒)
说明
测试环境下(详见 IsTest 公共参数说明),流 ID 需要加上 “zegotest-AppId-” 前缀。例如,流 ID 为 “test”,在 AppId 为 “123456789” 的测试环境下,流 ID 应为 “zegotest-123456789-test”。
Request
Query Parameters
Action string必填
可选值: [DescribeRTCStreamState
]
接口原型参数
https://rtc-api.zego.im?Action=DescribeRTCStreamState
AppId uint32必填
💡公共参数。AppId,ZEGO 分配的用户唯一凭证。
SignatureNonce string必填
💡公共参数。随机字符串。
Timestamp int64必填
💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
SignatureVersion string必填
可选值: [2.0
]
默认值: 2.0
💡公共参数。签名版本号。
StreamId string必填
流 ID。
Sequence string必填
请求序列号,由用户自定义。
注意
对于同一个流 Streamld,连续 10 秒内,必须保证发出的该 Streamld 的请求序列号是严格递增的;避免服务端收到请求的时序不一致而导致操作错乱。
如果没有并发场景,推荐使用时间戳(毫秒级别)。
Responses
- 200
成功
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
RESPONSE清除