跳转到主要内容
API Explorer|API Explorer
运维管理/监控相关接口/通知服务相关接口
POSTNotification Service APIs起始版本 4.2.0同步需要认证

测试钉钉连通性

测试钉钉连通性

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • testMsgString必填

      测试消息

    • endpointUuidString

      钉钉终端UUID

    • urlString

      Webhook地址。

    • atAllBoolean

      @所有人

    • atPersonPhoneNumbersList

      @手机号

    • secretString

      钉钉秘钥

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • connectedboolean必填

    Webhook URL连通性标识(仅代表能否连通)

  • webhookRespLinkedHashMap必填

    Webhook URL发送测试消息对端返回(https://open.dingtalk.com/document/robots/custom-robot-access#title-7ur-3ok-s1a)

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

POST/zstack/v1/sns/application-endpoints/ding-talk/test-connection

/zstack/v1/sns/application-endpoints/ding-talk/test-connection

操作 ID

SNSDingTalkTestConnection

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/sns/application-endpoints/ding-talk/test-connection' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"testMsg":"<testMsg>","endpointUuid":"<endpointUuid>","url":"<url>","atAll":true,"atPersonPhoneNumbers":["<atPersonPhoneNumbers>"],"secret":"<secret>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "connected": true, "webhookResp": {} }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史