tencent cloud



Last updated: 2023-12-07 10:46:29

    1. API Description

    Domain name for API request: tiw.tencentcloudapi.com.

    This API is used to query the status and result of a recording video generation task.

    A maximum of 20 requests can be initiated per second for this API.

    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: DescribeVideoGenerationTask.
    Version Yes String Common Params. The value used for this API: 2019-09-19.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
    SdkAppId Yes Integer SdkAppId of the whiteboard application.
    TaskId Yes String ID of the recording video generation task.

    3. Output Parameters

    Parameter Name Type Description
    GroupId String Group ID corresponding to the task.
    RoomId Integer Room ID corresponding to the task.
    TaskId String Task ID.
    Progress Integer Disused.
    Status String Status of the recording video generation task. Valid values:
    - QUEUED: Queuing.
    - PROCESSING: Video generation in progress.
    - FINISHED: Video generation finished. (To determine whether the task succeeded or failed, check the error code and message.)
    TotalTime Integer Total video playback duration. Unit: milliseconds.
    VideoInfos VideoInfo Disused. Use the VideoInfoList parameter.
    VideoInfoList Array of VideoInfo List of videos generated by the recording video generation tasks.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a recording video generation task

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "GroupId": "900822",
            "Progress": 100,
            "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "RoomId": 900822,
            "Status": "FINISHED",
            "TaskId": "00e1jv8ve0jcqk7da9lb",
            "TotalTime": 156750,
            "VideoInfoList": [
                    "UserId": "",
                    "VideoDuration": 156750,
                    "VideoFormat": "mp4",
                    "VideoId": "5285890792776509100",
                    "VideoPlayTime": 0,
                    "VideoSize": 318384,
                    "VideoType": 2,
                    "Width": 1024,
                    "Height": 768,
                    "VideoUrl": "http://1257240443.vod2.myqcloud.com/cc35b442vodcq1257240443/video.mp4"
            "VideoInfos": {
                "VideoType": 0,
                "VideoUrl": "Disused. Use the VideoInfoList parameter.",
                "UserId": "xx",
                "VideoId": "xx",
                "VideoSize": 0,
                "VideoDuration": 0,
                "Width": 0,
                "Height": 0,
                "VideoPlayTime": 0,
                "VideoFormat": "xx"

    5. Developer Resources


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    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.Record Failed to record. For more information, see the error description.
    InvalidParameter.BodyParameterTypeUnmatched The parameter type does not match.
    InvalidParameter.TaskNotFound The task to query does not exist.
    ResourceUnavailable.NotRegistered TIW is not enabled.
    ResourceUnavailable.ServiceExpired The account is in arrears or the TIW service has expired.
    UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.
    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