tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeWhiteboardPushCallback

Last updated: 2024-11-26 18:56:23

    1. API Description

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

    This API is used to query the whiteboard push callback URL.

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

    3. Output Parameters

    Parameter Name Type Description
    Callback String Callback URL of the whiteboard push event. If no callback URL is set, this parameter is null.
    CallbackKey String Callback authentication key for whiteboard push.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the whiteboard push callback URL

    This example shows you how to query the whiteboard push callback URL.

    Input Example

    https://tiw.intl.tencentcloudapi.com/?Action=DescribeWhiteboardPushCallback
&SdkAppId=1400000001
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Callback": "https://example.com/online/callback",
        "CallbackKey": "6vg9G7Fd",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

    5. Developer Resources

    SDK

    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
    AuthFailure
    InvalidParameter A parameter error occurred.
    InvalidParameter.BodyParameterTypeUnmatched The parameter type does not match.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy