Get Digital Human Video Stream Drive Task Status
Description
Through this API, you can retrieve the status of a digital human video stream drive task.
Request prototype
- Request method: POST
- Request body format: JSON
- Request URL: https://aigc-digitalhuman-api.zegotech.cn?Action=GetDriveStatus
- 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 | No | Digital human video stream task ID. If only this field is filled, it means to retrieve the status of all drive tasks for this video stream task. You can obtain it from the response parameters of the CreateDigitalHumanStreamTask API. |
| DriveId | String | No | Digital human video stream drive task ID. You can obtain it from the response parameters of the DriveByAudio, DriveByText, and DriveByWsStream APIs. |
Sample request
-
Request URL:
https://aigc-digitalhuman-api.zegotech.cn?Action=GetDriveStatus &<Common Request Parameters> -
Request body:
{ "DriveId": "1d4e048a-7520-4b7b-b762-5d8266bb8b7f" }
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. |
| └DriveList | Array of Object | Digital human video stream drive task list. For details, please refer to Drive. |
Drive
| Parameter | Type | Description |
|---|---|---|
| DriveId | String | Digital human video stream drive task ID. |
| Status | Number | Digital human video stream drive task status:
|
Sample response
{
"Code": 0,
"Message": "success",
"RequestId": "831234c7-8385-4051-8d3f-d491fe89cc2f",
"Data": {
"DriveList": [
{
"DriveId": "1d4e048a-7520-4b7b-b762-5d8266bb8b7f",
"Status": 1
}
]
}
}