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

GetMixTaskInfo

GET

https://rtc-api.zego.im/

根据指定混流任务的 taskid 查询相关信息。

调用频率限制
100 次/秒

Request

Query Parameters

    Action stringrequired

    Possible values: [GetMixTaskInfo]

    接口原型参数

    https://rtc-api.zego.im?Action=GetMixTaskInfo

    AppId uint32required

    💡公共参数。AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    💡公共参数。随机字符串。

    Timestamp int64required

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    💡公共参数。签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡公共参数。签名版本号。

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    TaskId stringrequired

    任务 ID,混流任务的唯一标识。

Responses

操作成功
Schema
    Code int32

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

    返回码说明处理建议
    0请求成功。-
    110200001失败。建议重试。一般是网络错误异常导致。
    110200004解析输入参数失败。请检查混流参数是否正确。
    110200194混流请求过载。请求过于频繁,请稍后再试。
    110209001混流任务不存在。请核查该混流任务是否正在进行。如果混流任务实际正在进行,请联系 ZEGO 技术支持。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。

    Data object
    响应数据。
    TaskInfo object
    混流任务信息。
    TaskId string

    混流任务 ID。

    MixDuration int32

    混流任务持续时长,单位秒。


Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

停止混流

Next

开始自动混流

当前页

返回到顶部