帮你快速理解、总结文档立即下载

新增或修改接收机器人

最近更新时间:2026-08-21 01:20:25
我的收藏

1. 接口描述

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

新增或修改一个接收机器人。ID > 0 表示修改已有记录;ID = 0 或不传表示新增。机器人类型由 Type 字段决定,Type=WEBHOOK 时 WebhookAddr 必填,Type=SCF 时 SCFRegion/Namespace/FunctionName/FunctionVersion/Alias/MaxWaitSeconds 全部必填。修改时不允许变更 Type

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyWebhookReceiver。
Version String 公共参数,本接口取值:2022-11-21。
Region String 公共参数,此参数为可选参数。
Name String

机器人名称
入参限制:长度 1-20 个字符,租户内唯一


示例值:f2
Type String

机器人类型
枚举值:
WEBHOOK:webhook 类型
SCF:云函数类型


示例值:SCF
ID Integer

机器人 ID。大于 0 表示修改已有记录;等于 0 或不传表示新增
默认值:0


示例值:19
WebhookAddr String

Webhook 地址
入参限制:Type=WEBHOOK 时必填,长度 1-2048,必须为合法 http(s) URL,且不允许内网地址


示例值:https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=144cbd
SCFRegion String

云函数地域,例如 ap-guangzhou
入参限制:Type=SCF 时必填


示例值:ap-guangzhou
Namespace String

云函数命名空间
入参限制:Type=SCF 时必填
取值参考:通过 DescribeSCFNamespaceList 接口获取


示例值:default
FunctionName String

云函数名称
入参限制:Type=SCF 时必填
取值参考:通过 DescribeSCFFunctionList 接口获取


示例值:f2
FunctionVersion String

云函数版本
入参限制:Type=SCF 时必填,例如 $LATEST
取值参考:通过 DescribeSCFFunctionVersionList 接口获取


示例值:$LATEST
Alias String

云函数别名
入参限制:Type=SCF 时必填,例如 $DEFAULT
取值参考:通过 DescribeSCFAliasList 接口获取


示例值: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。

命令行工具

6. 错误码

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