tencent cloud



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

    1. API Description

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

    This API is used to query the status and result of a real-time recording 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: DescribeOnlineRecord.
    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 customer
    TaskId Yes String ID of the real-time recording task

    3. Output Parameters

    Parameter Name Type Description
    FinishReason String Recording stop reason
    - AUTO: Recording automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time.
    - USER_CALL: The API for stopping recording is called.
    - EXCEPTION: An exception occurred.
    - FORCE_STOP: Recording is forcibly stopped, which is usually because the recording has been paused for more than 90 minutes or has lasted for more than 24 hours.
    TaskId String ID of the recording task to be queried.
    Status String Recording task status
    - PREPARED: preparing
    - RECORDING: recording
    - PAUSED: recording is paused.
    - STOPPED: recording is stopped, and the recorded video is being processed and uploaded.
    - FINISHED: the recorded video has been processed and uploaded, and the recording result is generated.
    RoomId Integer Room ID
    GroupId String Group ID of the whiteboard
    RecordUserId String ID of the recording user
    RecordStartTime Integer Actual recording start time, which is a UNIX timestamp in seconds
    RecordStopTime Integer Actual recording stop time, which is a UNIX timestamp in seconds
    TotalTime Integer Total video playback duration, in milliseconds
    ExceptionCnt Integer Number of exceptions during recording
    OmittedDurations Array of OmittedDuration Duration to be deleted in the spliced video. This parameter is valid only when the video splicing feature is enabled.
    VideoInfos Array of VideoInfo List of recorded videos
    ReplayUrl String
    Interrupts Array of Interrupt Number of video stream interruptions during recording.
    Note: This parameter may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the information about a real-time recording task

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "ExceptionCnt": 0,
            "FinishReason": "USER_CALL",
            "GroupId": "880528",
            "OmittedDurations": [],
            "RecordStartTime": 1568949369,
            "RecordStopTime": 1568949392,
            "RecordUserId": "tic_record_user_880528_test-01",
            "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "RoomId": 880528,
            "Status": "FINISHED",
            "TaskId": "ghucnligqtgtvk2624mb",
            "TotalTime": 18317,
            "ReplayUrl": "http://replayurl",
            "Interrupts": [],
            "VideoInfos": [
                    "UserId": "Mac_trtc_04",
                    "VideoDuration": 17969,
                    "VideoFormat": "mp4",
                    "VideoId": "dace3518e865e76a9e36712c629822ba",
                    "VideoPlayTime": 0,
                    "VideoSize": 593418,
                    "VideoType": 0,
                    "Width": 640,
                    "Height": 360,
                    "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/d124f518e865e76a9e36712c629822ba.mp4"
                    "UserId": "tic_mixstream_880528_101",
                    "VideoDuration": 18205,
                    "VideoFormat": "mp4",
                    "VideoId": "763d1f6b8679c3f17fb118bd37d05c85",
                    "VideoPlayTime": 3,
                    "VideoSize": 765545,
                    "VideoType": 3,
                    "Width": 640,
                    "Height": 360,
                    "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/763d1f6b86724f51fb118bd37d05c85.mp4"
                    "UserId": "tic_mixstream_880528_3",
                    "VideoDuration": 18222,
                    "VideoFormat": "mp4",
                    "VideoId": "1b9623df0516dc7318df89f6e7fffc1e",
                    "VideoPlayTime": 95,
                    "VideoSize": 402038,
                    "VideoType": 3,
                    "Width": 640,
                    "Height": 360,
                    "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/1b9623df05124f51318df89f6e7fffc1e.mp4"
                    "UserId": "",
                    "VideoDuration": 17605,
                    "VideoFormat": "mp4",
                    "VideoId": "a8152f8faa2cfe621dc965a066a5813c",
                    "VideoPlayTime": 623,
                    "VideoSize": 226337,
                    "VideoType": 2,
                    "Width": 640,
                    "Height": 360,
                    "VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/a815224f512cfe621dc965a066a5813c.mp4"

    Example2 Querying failed real-time recording tasks

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851"

    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