1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
新增或修改一个接收机器人。ID > 0 表示修改已有记录;ID = 0 或不传表示新增。机器人类型由 Type 字段决定,Type=WEBHOOK 时 WebhookAddr 必填,Type=SCF 时 SCFRegion/Namespace/FunctionName/FunctionVersion/Alias/MaxWaitSeconds 全部必填。修改时不允许变更 Type
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyWebhookReceiver。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Name | 是 | String | 机器人名称 示例值:f2 |
| Type | 是 | String | 机器人类型 示例值:SCF |
| ID | 否 | Integer | 机器人 ID。大于 0 表示修改已有记录;等于 0 或不传表示新增 示例值:19 |
| WebhookAddr | 否 | String | Webhook 地址 示例值:https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=144cbd |
| SCFRegion | 否 | String | 云函数地域,例如 ap-guangzhou 示例值:ap-guangzhou |
| Namespace | 否 | String | 云函数命名空间 示例值:default |
| FunctionName | 否 | String | 云函数名称 示例值:f2 |
| FunctionVersion | 否 | String | 云函数版本 示例值:$LATEST |
| Alias | 否 | String | 云函数别名 示例值:alias2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ID | Integer | 新增或被修改的机器人 ID 示例值:21 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWebhookReceiver
<公共请求参数>
{
"Name": "f2",
"Type": "SCF",
"SCFRegion": "ap-guangzhou",
"Namespace": "default",
"FunctionName": "f2",
"FunctionVersion": "$LATEST",
"Alias": "alias2"
}
输出示例
{
"Response": {
"ID": 21,
"RequestId": "72c22c12-d0e3-4c35-928c-64225477dc46"
}
}
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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。