托管 Prometheus
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | UpdateContact | 接口名称。当前 API 的名称为 UpdateContact。 |
Version | String | 是 | 2021-03-03 | 接口版本。当前 API 的版本为 2021-03-03。 |
Id | String | 是 | e28ae750-bbb8-4ff4-abf4*** | 联系人 ID。 |
Name | String | 否 | user-demo | 联系人名称。
|
Email | String | 否 | user-demo@example.com | 联系人邮箱,需为合法邮箱字段。 |
Webhook | 否 | - | 联系人通用 Webhook。 | |
ContactGroupIds | Array of String | 否 | ["e28ae750-bbb8-4ff4-abf4***"] | 联系人所属联系人组 ID。 |
LarkBotWebhook | 否 | - | 联系人飞书群组机器人 Webhook。 | |
DingTalkBotWebhook | 否 | - | 联系人钉钉群组机器人 Webhook。 | |
WeComBotWebhook | 否 | - | 企业微信群组机器人 Webhook。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Address | String | 是 | https://www.bytedance.com/ | 通用 Webhook 地址。 |
Token | String | 否 | 3KSxxx | 通用 Webhook 认证 token。 不能单独配置,需要与通用 Webhook 地址搭配使用。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Address | String | 是 | https://open.feishu.cn/open-apis/bot/v2/hook/*** | |
SecretKey | String | 否 | 6KKxxx | 飞书群组机器人 Webhook 秘钥。 不能单独配置,需要与飞书群组机器人的 Webhook 地址搭配使用。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Address | String | 是 | https://oapi.dingtalk.com/robot/send?access_token=*** | |
SecretKey | String | 否 | SECxxx | 钉钉群组机器人 Webhook 秘钥。 不能单独配置,需要与钉钉群组机器人的 Webhook 地址搭配使用。 |
AtMobiles | Array of String | 否 | ["133********"] | 被@人的手机号,该用户需要在群组内。 |
AtUserIds | Array of String | 否 | ["********"] | 被@人的用户 ID,该用户需要在群组内。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Address | String | 是 | https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=*** | |
AtUserIds | Array of String | 否 | ["********"] | 被@人的用户 ID,该用户需要在群组内。 |
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Id | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 联系人 ID。 |
SendStatus | String | MessageSucceed.Email | 发送邮箱认证信息状态码:
|
Message | String | The same email address should not be validated more than once in 1 minute, please try it later. | 发送邮箱认证信息错误原因。 当SendStatus不等于MessageSucceed.Email时,该参数有值。 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter.{{parameter}} | The specified parameter {{parameter}} is invalid. | 输入不合法,如工作区名称不合法等。 |
400 | MissingParameter.{{parameter}} | The required parameter {{parameter}} is missing. | 缺少必要的参数。 |
403 | ProductUnsubscribed | You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service | 当前账号未订阅 VMP 服务。 |
404 | NotFound.Id | The specified Contact/ContactGroup {{Id}} is not found. | 未找到指定联系人/联系人组。 |
409 | Conflict.Name | The specified name conflicts with existing {{resource}}. | 指定的名称与已有资源重复。 |