Domain name for API request: cwp.tencentcloudapi.com.
This API is used to query the list of alarm recipients.
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: DescribeWebHookReceiver. |
Version | Yes | String | Common Params. The value used for this API: 2018-02-28. |
Region | No | String | Common Params. This parameter is not required. |
Filter.N | No | Array of Filter | Filter criteria |
Offset | No | Integer | Offset, which defaults to 0 |
Limit | No | Integer | Number of items to be returned. It is 10 by default, and the maximum value is 100. |
Order | No | String | Sorting Method: [ASC: Ascending Order, DESC: Descending Order] |
By | No | String | Sorting field |
Parameter Name | Type | Description |
---|---|---|
List | Array of WebHookReceiver | Alarm recipient list |
TotalCount | Integer | Number |
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. |
Example
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebHookReceiver
<Common request parameters>
{
"Offset": 0,
"Limit": 10
}
{
"Response": {
"List": [
{
"Addr": "https://testtesttesttest",
"Id": 7,
"Name": "123"
},
{
"Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=cbe03861-a7c6-48cf-a34c-443c34be0db5",
"Id": 9,
"Name": "This message is sent for test purpose, and please do not delete it."
},
{
"Addr": "https://mybot1211",
"Id": 11,
"Name": "bot1"
},
{
"Addr": "http://",
"Id": 12,
"Name": "12345678901234567890"
},
{
"Addr": "https://",
"Id": 13,
"Name": "123"
},
{
"Addr": "https://dd",
"Id": 14,
"Name": "123dsf..."
},
{
"Addr": "http://alarm",
"Id": 15,
"Name": "Alarm"
},
{
"Addr": "http://11",
"Id": 16,
"Name": "1"
},
{
"Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=d0c2fc25-23a2-4285-ab98-d8a862146a73",
"Id": 17,
"Name": "WeCom"
},
{
"Addr": "Example",
"Id": 18,
"Name": "Example"
}
],
"RequestId": "a1fd9261-58a8-4947-877d-222198eeeb56",
"TotalCount": 14
}
}
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?