tencent cloud



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

    1. API Description

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

    This API is used to query the status and result of a whiteboard push 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: DescribeWhiteboardPush.
    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 whiteboard push task.

    3. Output Parameters

    Parameter Name Type Description
    FinishReason String Reason for push stop.
    - AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time.
    - USER_CALL: The API for stopping pushing is called.
    - EXCEPTION: An exception occurred.
    TaskId String ID of the whiteboard push task.
    Status String Status of the push task.
    - PREPARED: Push in preparation (including entering the room and starting the push service).
    - PUSHING: Pushing in progress.
    - STOPPED: Pushing stopped.
    RoomId Integer Room ID.
    GroupId String Group ID of the whiteboard.
    PushUserId String User ID of the push task.
    PushStartTime Integer Actual push start time, which is a Unix timestamp in seconds.
    PushStopTime Integer Actual push stop time, which is a Unix timestamp in seconds.
    ExceptionCnt Integer Number of exceptions during push.
    IMSyncTime Integer IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.
    Backup String Result information of the backup push task.
    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 a whiteboard push task

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "ExceptionCnt": 0,
            "FinishReason": "USER_CALL",
            "GroupId": "880528",
            "IMSyncTime": 0,
            "PushStartTime": 1610591726,
            "PushStopTime": 1610591759,
            "PushUserId": "tic_push_user_880528_test1",
            "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "RoomId": 880528,
            "Status": "STOPPED",
            "Backup": "",
            "TaskId": "g42lfmu5uc3lpoqrqvvb"

    Example2 Querying failed whiteboard push 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.WhiteboardPush Whiteboard push failed. 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