接口功能介绍
此接口用于客户配置webhook推送地址时,测试该地址是否可以正常推送消息。
当code=800时,代表用户填写的url返回的http状态码为200,但不一定推送成功,需要客户根据响应内容和实际消息接收结果来确认。
接口约束
无。
URI
POST /v4/monitor/test-webhook
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
webhookURL | String | 是 | "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=65f3223d-4a21-xxxxxxxx" | webhook推送url |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
result | String | 成功或失败时的描述信息 | HTTP SERVER OK |
请求示例
POST /v4/monitor/webhook-testing
请求体body
{
"webhookURL": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=65f3223d-4a21-xxxxxxxx"
}
响应示例
{
"statusCode":800,
"returnObj":{
"result":"HTTP SERVER OK"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}