tencent cloud

Feedback

Progress Query Interface

Last updated: 2024-07-18 17:53:03
    Query the task's production progress and results through the TaskId.

    Calling Protocol

    HTTPS + JSON POST /v2/ivh/assetmanager/customservice/getprogress Header Content-Type: application/json;charset=utf-8

    Request Parameters

    Parameters
    Type
    Mandatory
    Description
    TaskId
    string
    Yes
    The taskId returned by the Custom API.
    Response Parameter
    Parameters
    Type
    Mandatory
    Description
    Status
    string
    Yes
    Task production status:
    MAKING: In progress
    SUCCESS: Production succeeded
    FAIL: Production failed
    FailMessage
    string
    No
    When the Status is FAIL, the error reason is returned for troubleshooting.
    StageV2
    string
    No
    (New Version) When the Status is MAKING, the specific stage of the task in progress is returned:
    SUBMIT: Material submission
    AUDIT: Manual review
    PROCESS: Preprocessing (only applicable for avatar customization)
    TRAIN: Intelligent training
    CONFIRM: Effect confirmation (not applicable for photo customization)
    END: Completion
    StatusV2
    string
    No
    When StageV2 is at a certain stage, the specific status of that stage is:
    WAIT_PROCESS: To be processed
    PROCESSING: In process
    SUCCESS: succeeded
    FAIL: Failed
    StageInfo
    string
    No
    Indicates extra information for a certain stage, displayed as strings in JSON format. JSON format types for different stages are listed in the table below. Currently, only the effect confirmation stage (StageV2: CONFIRM) has values.
    AssetList
    Array of [AssetInfo]
    No
    Returns the customized image or voice information. Currently supported customization types are as follows: IMAGE_PHOTO: Photo Avatar image customization ZERO_SHOT_VOICE: Voice Clone (ultra edition)
    
    Extra StageInfo information for different stages is shown in the table below:
    StageV2
    Type
    Description
    Example
    CONFIRM: effect confirmation stage
    string of [CustomerConfirmContent]
    When the stage is at the effect confirmation stage (StageV2: CONFIRM) and the status is to be processed (StatusV2: WAIT_PROCESS), a demo video of the effect to be confirmed is returned. The customer can call the Effect Confirmation API to approve or reject the effect of the demo video based on the returned video.
    {\\"TrainResult\\":[\\"url1\\",\\"url2\\"],\\"RejectReason\\":\\"\\",\\"TrainRecord\\":[{\\"StartTime\\":\\"2023-11-01 23:00:17\\",\\"Record\\":[\\"url1\\",\\"url2\\"]}]}
    
    CustomerConfirmContent
    Parameters
    Type
    Mandatory
    Description
    TrainResult
    Array of [string]
    Yes
    URL address of the demo video for customers to confirm the effect
    RejectReason
    string
    Yes
    Reasons for the digital human side not accepting retraining
    TrainRecord
    Array of [TrainRecord]
    No
    List of demo videos of historical training
    TrainRecord
    Parameters
    Type
    Mandatory
    Description
    StartTime
    string
    Yes
    Historical training time
    Record
    Array of [string]
    Yes
    URL address of demo videos of historical training
    
    AssetInfo
    Parameters
    Type
    Mandatory
    Description
    VirtualmanTypeCode
    string
    No
    Avatar type code (see Appendix 3 - Avatar Types for details), returned by image customization
    VirtualmanKey
    string
    No
    Avatar virtualmankey, returned by image customization
    Resolution
    string
    No
    Avatar resolution, returned by image customization
    OriginZoom
    string
    No
    Scale factor, rounded to three decimal places, returned by image customization
    VirtualmanResourceId
    int32
    No
    Avatar resource ID, returned by image customization
    TimbreKey
    string
    No
    Voice key, returned by Voice Clone
    TimbreSample
    string
    No
    Voice demo link, returned by Voice Clone
    MakeType
    string
    Yes
    Customization Types: IMAGE_PHOTO: Photo Avatar image customization ZERO_SHOT_VOICE: Voice Clone (ultra edition)
    

    Request Sample

    {
    "Header": {},
    "Payload": {
    "TaskId": 666
    }
    }

    Response Sample

    {
    "Header": {
    "RequestID": "gz1a74c25f17030396653416949",
    "SessionID": "gz1a74c25f17030396653416950",
    "DialogID": "",
    "Code": 0,
    "Message": "ok"
    },
    "Payload": {
    "StageInfo": "{\\"TrainResult\\":[\\"url1\\",\\"url2\\"],\\"RejectReason\\":\\"\\",\\"TrainRecord\\":[{\\"StartTime\\":\\"2023-11-01 23:00:17\\",\\"Record\\":[\\"url1\\",\\"url2\\"]}]}",
    "Status": "MAKING",
    "StatusV2": "WAIT_PROCESS",
    "FailMessage": "",
    "StageV2": "CONFIRM"
    }
    }
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support