tencent cloud



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

    1. API Description

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

    This API is used to query whiteboard push tasks by room ID.

    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: DescribeWhiteboardPushSearch.
    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.

    3. Output Parameters

    Parameter Name Type Description
    WhiteboardPushTaskSet Array of WhiteboardPushTaskSearchResult The set of queried push tasks.
    TotalCount Integer Number of push tasks.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Success.

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "WhiteboardPushTaskSet": [
                    "CreateTime": "2021-01-15T12:43:57+08:00",
                    "RoomId": 101069223,
                    "TaskId": "01bjgeeigsh31f3rh00c",
                    "Status": "STOPPED",
                    "SdkAppId": 1400313729,
                    "PushUserId": "tic_push_user_101069223_107991",
                    "Result": {
                        "RoomId": 101069223,
                        "GroupId": "101069223",
                        "FinishReason": "USER_CALL",
                        "ExceptionCnt": 0,
                        "PushStartTime": 1610685839,
                        "PushStopTime": 1610685852,
                        "IMSyncTime": 0,
                        "ErrorCode": 0,
                        "ErrorMsg": ""
            "TotalCount": 1,
            "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 Operation failed.
    InvalidParameter A parameter error occurred.
    InvalidParameter.SdkAppIdNotFound The SdkAppId does not exist or is invalid.
    ResourceUnavailable.NotRegistered TIW is not enabled.
    ResourceUnavailable.ServiceExpired The account is in arrears or the TIW service has expired.
    UnauthorizedOperation Unauthorized operation.
    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