Get Digital Human Video Stream Task Status

Description

Through this API, you can retrieve the status of a digital human video stream task.

Request prototype

Request method: POST
Request body format: JSON
Request URL: https://aigc-digitalhuman-api.zegotech.cn?Action=GetDigitalHumanStreamTaskStatus
Transmission protocol: HTTPS
QPS limit: 10 times/second

Request Parameters

The following request parameter list only shows the API request parameters and some common parameters. For the complete list of common parameters, please refer to Accessing Server APIs - Common Request Parameters.

Parameter	Type	Required	Description
TaskId	String	Yes	Digital human video stream task ID. You can obtain it from the response parameters of the CreateDigitalHumanStreamTask API.

Sample request

Request URL:

https://aigc-digitalhuman-api.zegotech.cn?Action=GetDigitalHumanStreamTaskStatus
&<Common Request Parameters>

https://aigc-digitalhuman-api.zegotech.cn?Action=GetDigitalHumanStreamTaskStatus
&<Common Request Parameters>

Request body:

{
    "TaskId": "f06d1f5d-c0d1-4845-9a2c-f0a45ee037fd"
}

{
    "TaskId": "f06d1f5d-c0d1-4845-9a2c-f0a45ee037fd"
}

Response parameters

Parameter	Type	Description
Code	Number	Return code. 0 indicates success, other values indicate failure. For error codes and response handling suggestions, please refer to Return Codes.
Message	String	Description of the request result.
RequestId	String	Request ID.
Data	Object	Return data.
└Status	Number	Task status: 1: Initializing the video stream task. 2: Failed to initialize the video stream task. 3: Publishing the stream. 4: Stopping the stream-publishing. 5: Stream-publishing stopped.
└RoomId	String	Room ID of the digital human stream task. This is the Room ID passed in when calling CreateDigitalHumanStreamTask.
└StreamId	String	Stream ID of the digital human stream task. This is the Stream ID passed in when calling CCreateDigitalHumanStreamTask.
└FailReason	String	Description of the failure reason. Available only when the status is 2 (initialization failed).
└CreateTime	Number	Unix timestamp (in seconds) when the task was created.

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "f0a9bf1d-167c-4c0e-af69-96d4e1cf6686",
    "Data": {
        "RoomId": "digital_room_1749541482",
        "StreamId": "digital_stream_1749541482",
        "Status": 5,
        "CreateTime": 1749541482
    }
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "f0a9bf1d-167c-4c0e-af69-96d4e1cf6686",
    "Data": {
        "RoomId": "digital_room_1749541482",
        "StreamId": "digital_stream_1749541482",
        "Status": 5,
        "CreateTime": 1749541482
    }
}