Get Digital Human Video Stream Task Status
2026-03-20
Description
Through this API, you can get the status of a currently running 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 includes API request parameters and some common parameters. For the complete list of common parameters, please refer to API Calling Methods - Common Request Parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| TaskId | String | Yes | Digital Human video stream task ID. Obtained from the response parameter of the Create Digital Human Video Stream Task API. |
Request Example
-
Request URL:
https://aigc-digitalhuman-api.zegotech.cn?Action=GetDigitalHumanStreamTaskStatus &<common-request-parameters> -
Request body:
{ "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 recommendations, please refer to Return Codes. |
| Message | String | Description of the request result. |
| RequestId | String | Request ID. |
| Data | Object | Response data. |
| └Status | Number | Task status:
|
| └RoomId | String | Room ID of the Digital Human video stream task. The room ID passed when creating the Digital Human video stream task. |
| └StreamId | String | Stream ID of the Digital Human video stream task. The stream ID passed when creating the Digital Human video stream task. |
| └FailReason | String | Description of the reason for Digital Human video stream task initialization failure, only meaningful when status is 2. |
| └CreateTime | Number | Unix timestamp (seconds) when the task was created. |
Response Example
{
"Code": 0,
"Message": "success",
"RequestId": "f0a9bf1d-167c-4c0e-af69-96d4e1cf6686",
"Data": {
"RoomId": "digital_room_1749541482",
"StreamId": "digital_stream_1749541482",
"Status": 3,
"CreateTime": 1749541482
}
}