告警聯系人：激活
更新時間 2024-09-25 16:20:57
最近更新時間: 2024-09-25 16:20:57
分享文章
告警聯系人/組
告警聯系人：激活
接口功能介紹
調用此接口可激活告警聯系人的手機短息或郵箱，激活后的媒介可接收平臺告警信息。
接口約束
告警聯系人ID存在。
URI
POST /v4/monitor/activate-contact
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| contactID | 是 | String | 告警聯系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 | |
| media | 是 | String | 本參數表示媒介。取值范圍：sms：手機短信。email：郵箱。根據以上范圍取值。 | sms | |
| code | 是 | Integer | 驗證碼 | 123456 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
請求示例
請求url
/v4/monitor/activate-contact
請求頭header
無
請求體body
{
"contactID":"a6fb570f-2299-5bde-989c-df0819c687d0",
"media":"sms",
"code":123456
}
響應示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.Contact.ContactNotExist | 告警聯系人不存在 |
| Monitor.Contact.CodeExpired | 告警聯系人驗證碼已過期 |
| Monitor.Contact.CodeError | 告警聯系人驗證碼錯誤 |
| Monitor.Contact.EmailAddressIsEmpty | 告警聯系人郵箱地址為空 |
| Monitor.Contact.PhoneNumberIsEmpty | 告警聯系人手機號碼為空 |
| 其他 | 參見公共錯誤碼說明 |
