tencent cloud

APIs

DocumentaçãoAPIsCloud Security CenterNotification Center APIsDescribeWebhookReceiverList

DescribeWebhookReceiverList

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 10:19:01

1. API Description

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

This API is used to query the list of receiving robots for the current tenant by page, corresponding to the table on the Receive Bot Management Tab in Notification Center - Robot Notification. Each tenant can have up to 50 robots.

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: DescribeWebhookReceiverList.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Offset No Integer Pagination offset.
Valid values: [0, +∞)
Default value: 0
Limit No Integer Number of results per page
Valid values: [1, 200]
Default value: 20
Filters.N No Array of Filters Filter criteria.
Supported filter items:
Name: Fuzzy search by robot name
Type: Robot type. Available values: WEBHOOK (webhook) / SCF (function)
Order No String Sorting field.
Enumeration values:
InsertTime: Creation time
UpdateTime: Update time
Default value: UpdateTime.
By No String Sorting method.
Enumeration values:
asc: Ascending
desc: Descending
Default value: desc

3. Output Parameters

Parameter Name Type Description
Data Array of WebhookReceiver Receiving robot list
TotalCount Integer Total 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.

4. Example

Example1 Query all receiving robots

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebhookReceiverList
<Common request parameters>

{
    "Offset": 0,
    "Limit": 20
}

Output Example

{
    "Response": {
        "Data": [
            {
                "ID": 1001,
                "Name": "Develop group-Lark",
                "Type": "WEBHOOK",
                "WebhookAddr": "https://open.feishu.cn/open-apis/bot/v2/hook/abc",
                "SCFRegion": "",
                "Namespace": "",
                "FunctionName": "",
                "FunctionVersion": "",
                "Alias": ""
            }
        ],
        "TotalCount": 1,
        "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Anterior: DescribeWebhookPolicyListPróximo: ModifyWebhookPolicy

Ajuda e Suporte

Esta página foi útil?

comentários