文档中心
数字人 PaaS 服务
服务端 API
实时流式视频合成
查询视频流任务状态

查询视频流任务状态

更新时间：2024-07-09 15:25

描述

调用本接口查询一个数字人视频流任务的详情。

接口原型

请求方法：POST
中国大陆正式环境请求地址：https://aigc-api.zegotech.cn/?Action=DescribeMetaHumanLive
传输协议：HTTPS
调用频率限制：10 次/秒

请求参数

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

参数	类型	是否必选	描述
TaskId	String	是	数字人视频流任务 ID，创建数字人视频流任务后获取。

请求示例

请求 URL

https://aigc-api.zegotech.cn/?Action=DescribeMetaHumanLive
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0

请求消息体
```
{
    "TaskId": "your_task_id"
}
```

响应参数

参数	类型	描述
Code	Int	错误码。
Message	String	错误描述。
Data	Object	响应对象。
RoomId	String	数字人视频流所在房间 ID。
StreamId	String	数字人视频流 ID。
RtmpUrl	String	RTMP 流地址。
CreateTime	Int	数字人视频流任务创建时间，Unix 时间戳，单位为秒。
Status	Int	推流状态。 1：视频流任务初始化中。 2：视频流任务初始化失败。 3：推流中。 4：正在停止推流。 5：已停止推流。
FailReason	String	失败原因。
Duration	Int	直播时长，单位：秒。

响应示例

{
    "Code": 0,
    "Message": "succeed",
    "Data": {
        "RoomId": "your_room_id",
        "StreamId": "your_stream_id",
        "RtmpUrl": "your_rtmp_url",
        "CreateTime": 1694598494,
        "Status": 5,
        "FailReason": "",
        "Duration": 10,
        "Deduction": 68
    }
}

返回码

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

返回码	说明	处理建议
0	成功。	-
100000004	签名过期。	请重新生成签名。
100000005	签名错误。	请确认生成签名的参数是否正确。
400000001	输入参数无效。	请根据 Message 提示，调整对应参数的取值。
400000002	数字人 PaaS 服务权限未开通。	请联系 ZEGO 技术支持开通服务权限。
400000005	未找到任务。	请确认设置的 TaskId 是否正确。
400010000	系统错误。	请联系 ZEGO 技术支持处理。