告警回調測試
更新(xin)時間 2023-07-19 11:40:57
最(zui)近更新時間(jian): 2023-07-19 11:40:57
分享(xiang)文章
接口功能介紹
此接口用于客戶配置webhook推送地址時，測試該地址是否可以正常推送消息。
當(dang)code=800時，代(dai)表(biao)用戶填寫的url返回的http狀態碼為200，但(dan)不一(yi)定推送成功，需要客戶根(gen)據響(xiang)應(ying)內容和實(shi)際消息接收結果(guo)來(lai)確認。
接口約束
無。
URI
POST /v4/monitor/test-webhook
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| webhookURL | String | 是 | "//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": "//qyapi.weixin.qq.com/cgi-bin/webhook/send?key=65f3223d-4a21-xxxxxxxx"
}
響應示例
{
"statusCode":800,
"returnObj":{
"result":"HTTP SERVER OK"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
