测试钉钉连通性(SNSDingTalkTestConnection)
API请求
URLs
POST zstack/v1/sns/application-endpoints/ding-talk/test-connectionHeaders
Authorization: OAuth the-session-uuidBody
{
"params": {
"url": "https://open.feishu.cn/open-apis/bot/v2/hook/006879a3-0898-4428-aad4-3221db3daf81",
"atAll": true,
"atPersonPhoneNumbers": [
"13062689903",
"13062689901"
],
"secret": "SECf8310c22767fe6f7cc5c00c6c4b1343605c445e9adaa28e39138749127a1c962",
"testMsg": "hello world",
"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://open.feishu.cn/open-apis/bot/v2/hook/006879a3-0898-4428-aad4-3221db3daf81","atAll":true,"atPersonPhoneNumbers":["13062689903","13062689901"],"secret":"SECf8310c22767fe6f7cc5c00c6c4b1343605c445e9adaa28e39138749127a1c962","testMsg":"hello world","endpointUuid":"1c201c27a81740ddadbc5d2f3f38a5e4"}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/ding-talk/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 | |
| atPersonPhoneNumbers (可选) | List | body(包含在params结构中) | @手机号 | 5.0.0 | |
| secret (可选) | String | body(包含在params结构中) | 钉钉秘钥 | 5.0.0 |
API返回
返回示例
{
"connected": true,
"webhookResp": {}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 5.0.0 | |
| connected | boolean | webhook url 连通性标识(仅代表能否联通) | 5.0.0 |
| webhookResp | LinkedHashMap | webhook url 发送测试消息对端返回(https://open.dingtalk.com/document/robots/custom-robot-access#title-7ur-3ok-s1a) | 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
SNSDingTalkTestConnectionAction action = new SNSDingTalkTestConnectionAction();
action.url = "https://open.feishu.cn/open-apis/bot/v2/hook/006879a3-0898-4428-aad4-3221db3daf81";
action.atAll = true;
action.atPersonPhoneNumbers = asList("13062689903","13062689901");
action.secret = "SECf8310c22767fe6f7cc5c00c6c4b1343605c445e9adaa28e39138749127a1c962";
action.testMsg = "hello world";
action.endpointUuid = "1c201c27a81740ddadbc5d2f3f38a5e4";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SNSDingTalkTestConnectionAction.Result res = action.call();Python
SDK
SNSDingTalkTestConnectionAction action = SNSDingTalkTestConnectionAction()
action.url = "https://open.feishu.cn/open-apis/bot/v2/hook/006879a3-0898-4428-aad4-3221db3daf81"
action.atAll = true
action.atPersonPhoneNumbers = [13062689903, 13062689901]
action.secret = "SECf8310c22767fe6f7cc5c00c6c4b1343605c445e9adaa28e39138749127a1c962"
action.testMsg = "hello world"
action.endpointUuid = "1c201c27a81740ddadbc5d2f3f38a5e4"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SNSDingTalkTestConnectionAction.Result res = action.call()