Domain name for API request: tiw.tencentcloudapi.com.
This API is used to set the whiteboard push callback URL. For more information, see Event Notification.
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: SetWhiteboardPushCallback. |
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. |
Callback | Yes | String | Callback URL of the whiteboard push task result. If an empty string is passed in, the existing callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with http:// or https:// . For the callback format, see Event Notification. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tiw.tencentcloudapi.com/?Action=SetWhiteboardPushCallback
&SdkAppId=1400000001
&Callback=https://example.com/online/callback
&<Common request parameters>
{
"Response": {
"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.BodyParameterTypeUnmatched | The parameter type does not match. |
InvalidParameter.CallbackAddressFormatError | The callback address format is invalid. |
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. |
本页内容是否解决了您的问题?