Domain name for API request: tiw.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.
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. |
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, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the whiteboard push callback URL.
https://tiw.tencentcloudapi.com/?Action=DescribeWhiteboardPushCallback
&SdkAppId=1400000001
&<Common request parameters>
{
"Response": {
"Callback": "https://example.com/online/callback",
"CallbackKey": "6vg9G7Fd",
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?