云安全中心查询接收机器人列表

1. 接口描述

接口请求域名： csip.tencentcloudapi.com 。

分页查询当前租户下的接收机器人列表，对应「通知中心 - 机器人通知 - 接收机器人管理」Tab 的表格。每租户最多 50 个机器人

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeWebhookReceiverList。
Version	是	String	公共参数，本接口取值：2022-11-21。
Region	否	String	公共参数，此参数为可选参数。
Offset	否	Integer	分页偏移量取值范围：[0, +∞) 默认值：0 示例值：0
Limit	否	Integer	每页返回数量取值范围：[1, 200] 默认值：20 示例值：20
Filters.N	否	Array of Filters	过滤条件支持的过滤项： Name：按机器人名称模糊搜索 Type：机器人类型，可选值：WEBHOOK（webhook） / SCF（云函数）
Order	否	String	排序字段枚举值： InsertTime：创建时间 UpdateTime：更新时间默认值：UpdateTime 示例值：UpdateTime
By	否	String	排序方式枚举值： asc：升序 desc：降序默认值：desc 示例值：desc

3. 输出参数

参数名称	类型	描述
Data	Array of WebhookReceiver	接收机器人列表
TotalCount	Integer	总数量示例值：5
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询全部接收机器人

输入示例

POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebhookReceiverList
<公共请求参数>

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

输出示例

{
    "Response": {
        "Data": [
            {
                "ID": 1001,
                "Name": "开发组-飞书",
                "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询接收机器人列表

本页目录：