Domain name for API request: csip.intl.tencentcloudapi.com.
Send a test message to the designated receiving robot to verify reachability and configuration. Use the "Test" button in the corresponding table row.
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: TestWebhookReceiver. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| ID | Yes | Integer | Robot configuration ID |
| Data | No | String | Custom test content (plaintext). If not passed, the system default test sample is used |
| Parameter Name | Type | Description |
|---|---|---|
| RespData | String | Test result (base64 decode required to get plaintext) |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TestWebhookReceiver
<Common request parameters>
{
"ID": 19,
"Data": "alert"
}
{
"Response": {
"RespData": "eyJlcnJjb2RlIjo5MzAwMCwiZXJybXNnIjoiaW52YWxpZCB3ZWJob29rIHVybCwgaGl*******************************AxNjAxNDZdLCBmcm9tIGlwOiAxMjkuMjA0LjE1OC4xMTYsIG1vcmUgaW5mbyBhdCBodHRwczovL29wZW4ud29yay53ZWl4aW4ucXEuY29tL2RldnRvb2wvcXVlcnk/ZT05MzAwMCJ9",
"RequestId": "96230daf-e40e-4c8d-8cdb-67c3be382ae0"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback