1. API Description
Domain name for API request: facefusion.tencentcloudapi.com.
This API is used to query the progress and status of video face fusion tasks by Job ID.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: QueryVideoFaceFusionJob. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-27. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| JobId | Yes | String | Job ID of the video face fusion task |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| JobStatus | String | Current task status: queuing, processing, processing failed, or processing completed |
| VideoFaceFusionOutput | VideoFaceFusionOutput | Video face fusion result Note: This field may return null, indicating that no valid values can be obtained. |
| JobStatusCode | Integer | Task status code. 1: queuing; 3: processing; 5: processing failed; 7: processing completed. Note: This field may return null, indicating that no valid values can be obtained. |
| JobErrorCode | String | Task failure error code Note: This field may return null, indicating that no valid values can be obtained. |
| JobErrorMsg | String | Task failure error message Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying Video Face Fusion Tasks
This example shows you how to query video face fusion tasks.
Input Example
https://facefusion.tencentcloudapi.com/?Action=QueryVideoFaceFusionJob
&JobId=C0a5EXaNR7JzGvlg
&<Common request parameters>
Output Example
{
"Response": {
"JobStatusCode": 7,
"JobStatus": "Processing completed",
"VideoFaceFusionOutput": {
"VideoUrl": "http://bda-video-bodyseg-1254418846.cos.ap-guangzhou.myqcloud.com/video_fusion_test/1.0/251006455/20210119164402_83ecff39-2e4a-41d5-8562-1f8898326565_qc_300314_789050_75_1611045834157_result.mp4",
"VideoMD5": "3AA00F9A2914DF3F2268628C45C4E4CE",
"Width": 720,
"Height": 1280,
"FPS": 25,
"DurationInSec": 15.079999923706,
"Frame": 375
},
"JobErrorCode": "",
"JobErrorMsg": "",
"RequestId": "ef13456e-8174-4418-8e51-a724257c9a3a"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.InnerError | Internal service error. |
| FailedOperation.JobHasBeenCanceled | The task has been canceled. Please submit the task again. |
| FailedOperation.JobNotExist | The task does not exist. |
| FailedOperation.NoFaceDetected | The face cannot be detected because the face box is too small. |
| FailedOperation.ParameterValueError | Parameter or value is invalid. |
| FailedOperation.RequestTimeout | The backend service timed out. |
| FailedOperation.RpcFail | RPC request failed, typically due to algorithm service malfunction. |
| FailedOperation.UnKnowError | Internal error. |
| FailedOperation.Unknown | Unknown error. |
Yes
No
Was this page helpful?