logo
实时音视频
服务端 API
场景服务接口
当前页

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

成功
Schema
    Code number

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

    返回码说明处理建议
    0查询成功,查询的流存在、且是活跃状态。-
    3000无效的 App。请联系 ZEGO 技术支持处理。
    3001、30003内部错误。请联系 ZEGO 技术支持处理。
    3002Timestamp 时间戳错误。请重新生成新的 Timestamp。
    3003App 未配置 Token。请联系 ZEGO 技术支持处理。
    30002接口调用频率过高。请降低接口请求频率。
    30004参数 isTest 错误。请检查公共请求参数 isTest 是否正确。
    30005无效的 AppId。请检查 AppId 是否正确。
    30009无效的 StreamId,流名不规范。请检查 StreamId 是否符合流名编码规范。
    40005鉴权失败。请检查签名 Signature 是否正确。
    41004查询失败,StreamId 不存在。请检查 StreamId 是否正确、或"查询流状态历史信息权限"是否过期。
    41006查询成功,查询的流存在、但是关闭状态。仅在开通了"查询流状态历史信息权限"的有效期内会返回。-
    Message string

    操作结果描述

    RequestId string

    请求 ID

    Data object
    响应数据
    create_time string

    流创建时间,UTC 时间

    close_time string

    流关闭时间,UTC 时间


Request
折叠所有
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

RTMP 推拉流调度

Next

开始 CDN 录制

当前页

返回到顶部