测试企业微信群组机器人的连通性。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=TestWeComBotWebhook&Version=2021-03-03
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | TestWeComBotWebhook | 接口名称。当前 API 的名称为 TestWeComBotWebhook。 |
| Version | String | 是 | 2021-03-03 | 接口版本。当前 API 的版本为 2021-03-03。 |
| Address | String | 是 | https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=*** | 企业微信群组机器人 Webhook 地址，使用方法请参见 使用说明。 |
| AtUserIds | Array of String | 否 | ["********"] | 被@人的用户 ID，该用户需要在群组内。 |
请求示例
POST https://open.volcengineapi.com/?Action=TestWeComBotWebhook&Version=2021-03-03
Content-Type: application/json
{
"Address": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxx",
"AtUserIds": [
"********"
]
}
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| StatusCode | Integer | 200 | HTTP 状态码。 |
| ErrorMessage | String | timeout | HTTP 请求返回错误信息。 |
| WeComCode | Integer | 9499 | 企业微信机器人发送消息后返回的状态码。 |
| WeComMessage | String | Bad Request | 企业微信机器人发送消息后返回的信息。 |
返回示例
HTTP/1.1: 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "TestWeComBotWebhook",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-north-1"
},
"Result": {
"StatusCode": 200,
"ErrorMessage": "timeout",
"WeComCode": 9499,
"WeComMessage": "Bad Request"
}
}
错误码
本接口错误码如下表所示，公共错误码请参见 公共错误码。
| 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 the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service | 当前账号未订阅 VMP 服务。 |