跳转到主要内容
ZStack
平台运维/云平台监控相关接口/监控报警/通知服务/通知服务相关接口

测试钉钉连通性

测试钉钉连通性

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

操作 ID

SNSDingTalkTestConnection

起始版本

5.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • testMsg
      String必填

      测试消息文本

    • endpointUuid
      String

      钉钉endpoint uuid

    • url
      String

      可选Webhook URL。

    • atAll
      Boolean

      是否@所有人

    • atPersonPhoneNumbers
      List

      @手机号

    • secret
      String

      钉钉秘钥

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • success
    boolean必填

    操作是否成功。

  • connected
    boolean必填

    webhook url 连通性标识(仅代表能否联通)

  • webhookResp
    LinkedHashMap必填

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

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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