测试企业微信连通性(SNSMicrosoftTeamsTestConnection)
API请求
URLs
POST zstack/v1/sns/application-endpoints/we-com/test-connectionHeaders
Authorization: OAuth the-session-uuidBody
{
"params": {
"url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key\u003df8b9014a-207a-44d5-ae26-3501bf01dbc4",
"atAll": false,
"atPersonUserIds": [
"zhangsan",
"lisi"
],
"testMsg": "hello",
"endpointUuid": "1c201c27a81740ddadbc5d2f3f38a5e4"
},
"systemTags": [],
"userTags": []
}Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"url":"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4","atAll":false,"atPersonUserIds":["zhangsan","lisi"],"testMsg":"hello","endpointUuid":"1c201c27a81740ddadbc5d2f3f38a5e4"}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/we-com/test-connection参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| testMsg | String | body(包含在params结构中) | 测试消息 | 5.0.0 | |
| endpointUuid (可选) | String | body(包含在params结构中) | 企业微信 endpoint uuid | 5.0.0 | |
| systemTags (可选) | List | body | 系统标签 | 5.0.0 | |
| userTags (可选) | List | body | 用户标签 | 5.0.0 | |
| url (可选) | String | body(包含在params结构中) | webhook url | 5.0.0 | |
| atAll (可选) | Boolean | body(包含在params结构中) | @所有人 | 5.0.0 | |
| atPersonUserIds (可选) | List | body(包含在params结构中) | @用户id集合 | 5.0.0 |
API返回
返回示例
{
"connected": true,
"webhookResp": {}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 5.0.0 | |
| connected | boolean | webhook url 是否联通 | 5.0.0 |
| webhookResp | boolean | webhook 返回数据 | 5.0.0 |
| error | ErrorCode | 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error | 5.0.0 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 | 5.0.0 |
| description | String | 错误的概要描述 | 5.0.0 |
| details | String | 错误的详细信息 | 5.0.0 |
| elaboration | String | 保留字段，默认为null | 5.0.0 |
| opaque | LinkedHashMap | 保留字段，默认为null | 5.0.0 |
| cause | ErrorCode | 根错误，引发当前错误的源错误，若无原错误，该字段为null | 5.0.0 |
SDK示例
Java
SDK
SNSWeComTestConnectionAction action = new SNSWeComTestConnectionAction();
action.url = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4";
action.atAll = false;
action.atPersonUserIds = asList("zhangsan","lisi");
action.testMsg = "hello";
action.endpointUuid = "1c201c27a81740ddadbc5d2f3f38a5e4";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SNSWeComTestConnectionAction.Result res = action.call();Python
SDK
SNSWeComTestConnectionAction action = SNSWeComTestConnectionAction()
action.url = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4"
action.atAll = false
action.atPersonUserIds = [zhangsan, lisi]
action.testMsg = "hello"
action.endpointUuid = "1c201c27a81740ddadbc5d2f3f38a5e4"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SNSWeComTestConnectionAction.Result res = action.call()