校验webhook地址有效性。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

POST /services/check/webhook HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
Object Body 否

A short description of struct
clientToken String Body 否 FD200FAE-E98F-496E-BFE6-4CE61E59A2E9

幂等校验token
webhook String Body 否 https://oapi.dingtalk.com/robot/send?access_token=XXX

webook地址
webhookType String Body 否 DING_GROUP

webhook地址类型：

  • 企业微信WEIXIN_GROUP
  • 钉钉群DING_GROUP
  • 飞书FEISHU_GROUP

返回数据

名称 类型 示例值 描述
requestId String FD200FAE-E98F-496E-BFE6-4CE61E59A2E9

Id of the request

示例

请求示例

POST /services/check/webhook HTTP/1.1
Host:gemp.aliyuncs.com
Content-Type:application/json

{
  "clientToken" : "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9",
  "webhook" : "https://oapi.dingtalk.com/robot/send?access_token=XXX",
  "webhookType" : "DING_GROUP"
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CheckWebhookResponse>
    <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>
</CheckWebhookResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9"
}

错误码

HttpCode 错误码 错误信息 描述
403 WebhookVerificationError A webhook verification error occurred. webhook校验异常
403 WebhookAddressFormatError The webhook address format is invalid. webhook地址格式错误
403 WebhookAccessRestricts Traffic is restricted for webhook access. webhook访问限流

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。