告警联系人/组
告警联系人：发送激活验证码
接口功能介绍
调用此接口可对告警联系人发送手机短息激活验证码或邮箱激活验证码。
接口约束
- 告警联系人ID存在。
- 激活验证码10分钟内有效，在一个请求周期内不支持重复请求。
- 对同一个签名的手机号：1分钟内发送短信条数不超过2条； 1小时内发送短信条数不超过10条； 1个自然日内发送短信条数不超过50。
URI
POST /v4/monitor/contact-activation-code
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| contactID | 是 | String | 告警联系人ID | a6fb570f-2299-5bde-989c-df0819c687d0 | |
| media | 是 | String | 本参数表示媒介。取值范围：sms：手机短信。email：邮箱。根据以上范围取值。 | sms |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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/contact-activation-code
请求头header
无
请求体body
{
"contactID":"a6fb570f-2299-5bde-989c-df0819c687d0",
"media":"sms"
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Contact.ContactNotExist | 告警联系人不存在 |
| Monitor.Contact.CodeIsValid | 告警联系人验证码还在有效期 |
| Monitor.Contact.EmailAddressIsEmpty | 告警联系人邮箱地址为空 |
| Monitor.Contact.PhoneNumberIsEmpty | 告警联系人手机号码为空 |
| Monitor.Contact.PhoneNumberHasBeenSentFrequently | 手机号发送频繁 |
| 其他 | 参见公共错误码说明 |
