预警推送
更新时间:2021-12-14
添加预警方案
功能说明
添加预警推送方案
请求path
Plain Text
1POST /v1/alerts
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Body | alertContact | 是 | 推送开关,ON为推送,OFF为不推送 | string |
| Body | alertDayEndTime | 否 | 每天推送结束时间,毫秒时间戳格式,例如1604400780000 | int |
| Body | alertDayStartTime | 否 | 每天推送开始时间,毫秒时间戳格式,例如1604400780000 | int |
| Body | alertEmail | 否 | 邮件推送开关,ON为推送,OFF为不推送 | string |
| Body | alertMon | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertSat | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertWed | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertSun | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertThur | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertTues | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertFri | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertStatus | 是 | 预警开关,ON为开启,OFF为关闭,关闭后预警监控方案将停止 | string |
| Body | alertKeywordList | 否 | 关键字预警关键字列表,如["深圳", "房价"] | list |
| Body | alertMediaList | 否 | 监测媒体列表,可选值见公共变量说明中媒体分类 | list |
| Body | alertMinTimeInterval | 否 | 最小推送间隔,单位为秒 | int |
| Body | alertMobile | 否 | 短信推送开关,ON为开启,OFF为关闭 | string |
| Body | alertName | 是 | 预警推送方案名称 | string |
| Body | alertType | 是 | UNNORMAL,KEYWORD二选一,分别代表异常值预警和关键词预警 | string |
| Body | alertWarning | 否 | 无预警时,是否发送邮件或短信通知,值为OFF或ON | string |
| Body | allUnnormalAlert | 是 | 全部舆情异常设置开关,值为OFF或ON | string |
| Body | allUnnormalAlertValue | 是 | 全部舆情异常报警阈值 | int |
| Body | emailContactIds | 否 | 预警接收邮件联系人id列表,具体值可从获取联系人列表接口获取 | list |
| Body | keywordHitType | 否 | 预警关键字命中字段,可选值为TITLE, ALL,其中ALL代表全文 | string |
| Body | mobileContactIds | 否 | 预警接收手机联系人id列表,具体值可从获取联系人列表接口获取 | list |
| Body | negativeUnnormalAlert | 是 | 负面舆情异常设置开关,值为OFF或ON | string |
| Body | negativeUnnormalAlertValue | 是 | 负面舆情异常报警阈值 | int |
| Body | taskId | 是 | 预警监控方案任务id | int |
- 请求示例
Plain Text
1method: POST
2path:/v1/alerts
3body:
4{
5 "alertName": "test2",
6 "taskId": 592,
7 "alertMediaList": [
8 "APP_MEDIA",
9 "BBS_MEDIA",
10 "NEWS_MEDIA",
11 "FEED_MEDIA",
12 "WEIBO_MEDIA",
13 "BOKE_MEDIA",
14 "VIDEO_MEDIA",
15 "OTHER_MEDIA"
16 ],
17 "alertType": "UNNORMAL",
18 "allUnnormalAlert": "ON",
19 "allUnnormalAlertValue": 30,
20 "negativeUnnormalAlert": "OFF",
21 "negativeUnnormalAlertValue": 30,
22 "alertKeywordList": [
23 ""
24 ],
25 "keywordHitType": "ALL",
26 "alertContact": "ON",
27 "alertMon": "ON",
28 "alertTues": "ON",
29 "alertWed": "ON",
30 "alertThur": "ON",
31 "alertFri": "ON",
32 "alertSat": "OFF",
33 "alertSun": "OFF",
34 "alertDayStartTime": 32400,
35 "alertDayEndTime": 64800,
36 "alertMinTimeInterval": 3600,
37 "alertWarning": "OFF",
38 "alertEmail": "ON",
39 "alertMobile": "ON",
40 "mobileContactIds": [
41 74
42 ],
43 "emailContactIds": [
44 75
45 ],
46 "alertStatus": "ON"
47}
响应示例
Plain Text
178 //返回该预警任务id
获取预警列表
功能说明
获取预警方案列表
请求path
Plain Text
1GET /v1/alerts
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
无
- 请求示例
Plain Text
1method: GET
2path:/v1/alerts
响应示例
Plain Text
1{
2 "totalAlertNum" : 100,
3 "usedAlertNum" : 1,
4 "leftAlertNum" : 99,
5 "list" : [ {
6 "alertStatus" : "ON",
7 "alertType" : "UNNORMAL",
8 "alertKeywordList" : [ "" ],
9 "allUnnormalAlertValue" : 30,
10 "alertContact" : "ON",
11 "alertName" : "test",
12 "negativeUnnormalAlert" : "ON",
13 "createTime" : 1614580340000,
14 "allUnnormalAlert" : "OFF",
15 "taskName" : "深圳限购",
16 "id" : 58,
17 "negativeUnnormalAlertValue" : 30,
18 "taskId" : 373
19 } ]
20}
获取预警详情
功能说明
获取预警方案详情
请求path
Plain Text
1GET /v1/alerts/{alertId}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | alertId | 是 | 预警方案id | int |
- 请求示例
Plain Text
1method: GET
2path:/v1/alerts/78
响应示例
Plain Text
1{
2 "id" : 78,
3 "taskName" : "智慧校园",
4 "alertName" : "test2",
5 "alertType" : "UNNORMAL",
6 "userId" : 145,
7 "taskId" : 592,
8 "alertMediaList" : [ "APP_MEDIA", "BBS_MEDIA", "NEWS_MEDIA", "FEED_MEDIA", "WEIBO_MEDIA", "BOKE_MEDIA", "VIDEO_MEDIA", "OTHER_MEDIA" ],
9 "keywordHitType" : "ALL",
10 "alertKeywordList" : [ "" ],
11 "alertStatus" : "ON",
12 "allUnnormalAlert" : "ON",
13 "allUnnormalAlertValue" : 30,
14 "negativeUnnormalAlert" : "OFF",
15 "negativeUnnormalAlertValue" : 30,
16 "alertSun" : "OFF",
17 "alertMon" : "ON",
18 "alertTues" : "ON",
19 "alertWed" : "ON",
20 "alertThur" : "ON",
21 "alertFri" : "ON",
22 "alertSat" : "OFF",
23 "alertDayStartTime" : 32400,
24 "alertDayEndTime" : 64800,
25 "alertMinTimeInterval" : 3600,
26 "alertWarning" : "OFF",
27 "alertContact" : "ON",
28 "alertEmail" : "ON",
29 "alertMobile" : "ON",
30 "createTime" : 1617691086000,
31 "updateTime" : 1617691086000,
32 "lastAlertTime" : null,
33 "del" : 0,
34 "emailContactIds" : [ 75 ],
35 "mobileContactIds" : [ 74 ]
36}
更新预警方案
功能说明
更新预警推送方案
请求path
Plain Text
1PUT /v1/alerts/{alertId}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | alertId | 是 | 预警方案id | int |
| Body | alertContact | 是 | 推送开关,ON为推送,OFF为不推送 | string |
| Body | alertDayEndTime | 否 | 每天推送结束时间,毫秒时间戳格式,例如1604400780000 | int |
| Body | alertDayStartTime | 否 | 每天推送开始时间,毫秒时间戳格式,例如1604400780000 | int |
| Body | alertEmail | 否 | 邮件推送开关,ON为推送,OFF为不推送 | string |
| Body | alertMon | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertSat | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertWed | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertSun | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertThur | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertTues | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertFri | 否 | 推送日期设置,ON为推送,OFF为不推送 | string |
| Body | alertStatus | 是 | 预警开关,ON为开启,OFF为关闭,关闭后预警监控方案将停止 | string |
| Body | alertKeywordList | 否 | 关键字预警关键字列表,如["深圳", "房价"] | list |
| Body | alertMediaList | 否 | 监测媒体列表,可选值见公共变量说明中媒体分类 | list |
| Body | alertMinTimeInterval | 否 | 最小推送间隔,单位为秒 | int |
| Body | alertMobile | 否 | 短信推送开关,ON为开启,OFF为关闭 | string |
| Body | alertName | 是 | 预警推送方案名称 | string |
| Body | alertType | 是 | UNNORMAL,KEYWORD二选一,分别代表异常值预警和关键词预警 | string |
| Body | alertWarning | 否 | 无预警时,是否发送邮件或短信通知,值为OFF或ON | string |
| Body | allUnnormalAlert | 是 | 全部舆情异常设置开关,值为OFF或ON | string |
| Body | allUnnormalAlertValue | 是 | 全部舆情异常报警阈值 | int |
| Body | emailContactIds | 否 | 预警接收邮件联系人id列表,具体值可从获取联系人列表接口获取 | list |
| Body | keywordHitType | 否 | 预警关键字命中字段,可选值为TITLE, ALL,其中ALL代表全文 | string |
| Body | mobileContactIds | 否 | 预警接收手机联系人id列表,具体值可从获取联系人列表接口获取 | list |
| Body | negativeUnnormalAlert | 是 | 负面舆情异常设置开关,值为OFF或ON | string |
| Body | negativeUnnormalAlertValue | 是 | 负面舆情异常报警阈值 | int |
| Body | taskId | 是 | 预警监控方案任务id | int |
- 请求示例
Plain Text
1method: PUT
2path:/v1/alerts/3219
3body:
4{
5 "alertName": "test2",
6 "taskId": 592,
7 "alertMediaList": [
8 "APP_MEDIA",
9 "BBS_MEDIA",
10 "NEWS_MEDIA",
11 "OTHER_MEDIA"
12 ],
13 "alertType": "UNNORMAL",
14 "allUnnormalAlert": "ON",
15 "allUnnormalAlertValue": 30,
16 "negativeUnnormalAlert": "OFF",
17 "negativeUnnormalAlertValue": 30,
18 "alertKeywordList": [
19 ""
20 ],
21 "keywordHitType": "ALL",
22 "alertContact": "ON",
23 "alertMon": "ON",
24 "alertTues": "OFF",
25 "alertWed": "OFF",
26 "alertThur": "OFF",
27 "alertFri": "OFF",
28 "alertSat": "OFF",
29 "alertSun": "OFF",
30 "alertDayStartTime": 32400,
31 "alertDayEndTime": 64800,
32 "alertMinTimeInterval": 3600,
33 "alertWarning": "OFF",
34 "alertEmail": "ON",
35 "alertMobile": "ON",
36 "mobileContactIds": [
37 74
38 ],
39 "emailContactIds": [
40 75
41 ],
42 "alertStatus": "ON"
43}
响应示例
Plain Text
178 //返回该预警任务id
删除预警方案
功能说明
删除预警方案
请求path
Plain Text
1DELETE /v1/alerts/{alertId}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | alertId | 是 | 预警方案id | int |
- 请求示例
Plain Text
1method: DELETE
2path:/v1/alerts/78
响应示例
Plain Text
1true //删除成功
更新邮件推送开关
功能说明
更新邮件推送开关
请求path
Plain Text
1PUT /v1/alerts/{alertId}/alertEmail/{action}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | alertId | 是 | 预警方案id | int |
| Path | action | 是 | 值为ON或OFF | int |
- 请求示例
Plain Text
1method: PUT
2path:/v1/alerts/3276/alertEmail/ON
3body: {}
响应示例
Plain Text
178 //返回该预警任务id
更新短信推送开关
功能说明
更新短信推送开关
请求path
Plain Text
1PUT /v1/alerts/{alertId}/alertMobile/{action}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | alertId | 是 | 预警方案id | int |
| Path | action | 是 | 值为ON或OFF | int |
- 请求示例
Plain Text
1method: PUT
2path:/v1/alerts/3276/alertMobile/ON
3body: {}
响应示例
Plain Text
178 //返回该预警任务id
更新预警监测开关
功能说明
更新预警监测开关
请求path
Plain Text
1PUT /v1/alerts/{alertId}/alertStatus/{action}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | alertId | 是 | 预警方案id | int |
| Path | action | 是 | 值为ON或OFF | string |
- 请求示例
Plain Text
1method: PUT
2path:/v1/alerts/78/alertStatus/ON
3body: {}
响应示例
Plain Text
178 //返回预警任务id
获取报告列表
功能说明
获取预警报告列表
请求path
Plain Text
1GET /v1/alertReports
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Query | alertId | 否 | 预警方案id | int |
| Query | keyword | 否 | 根据预警方案名称、联系人名称过滤 | string |
| Query | limit | 否 | 当次请求返回的列表最大条数 | int |
| Query | sort | 否 | 时间排序方法,支持ASC, DESC两种 | string |
| Query | start | 否 | 本次请求的起始位置,用户可通过start+limit进行多轮结果请求 | int |
| Query | taskName | 否 | 监控方案名称 | string |
| Query | timeFrom | 否 | 时间范围查询,timeFrom和timeTo同时出现有效,毫秒时间戳格式,例如1604400780000,不传默认拉全部 | int |
| Query | timeTo | 否 | 时间范围查询,timeFrom和timeTo同时出现有效,毫秒时间戳格式,例如1604400780000,不传默认拉全部 | int |
- 请求示例
Plain Text
1method: GET
2path:/v1/alertReports
3query: start=0&limit=10&sort=DESC&timeFrom=1617033600000&timeTo=1617691535053&alertId=78
响应示例
Plain Text
1{
2 "totalCount" : 2,
3 "list" : [ {
4 "alertCondiction" : "负面舆情同比增加超过30%",
5 "alertNeedSend" : "NEED",
6 "alertNum" : 3,
7 "alertType" : "UNNORMAL",
8 "alertSendStatus" : "SENDED",
9 "alertSendTime" : 0,
10 "contactList" : [ {
11 "createTime" : 1614580131000,
12 "contactValue" : "135****9690",
13 "contactName" : "aik",
14 "contactDesc" : "",
15 "contactType" : "MOBILE",
16 "id" : 74
17 } ],
18 "alertReportName" : "2021-04-05 06:00:00 异常值-负面舆情预警简报",
19 "alertName" : "test",
20 "createTime" : 1617573702000,
21 "alertReportType" : "NORMAL",
22 "taskName" : "深圳限购",
23 "id" : 11591,
24 "taskId" : 373
25 }, {
26 "alertCondiction" : "负面舆情同比增加超过30%",
27 "alertNeedSend" : "NEED",
28 "alertNum" : 4,
29 "alertType" : "UNNORMAL",
30 "alertSendStatus" : "SENDED",
31 "alertSendTime" : 0,
32 "contactList" : [ {
33 "createTime" : 1614580131000,
34 "contactValue" : "135****9690",
35 "contactName" : "aik",
36 "contactDesc" : "",
37 "contactType" : "MOBILE",
38 "id" : 74
39 } ],
40 "alertReportName" : "2021-04-02 06:00:16 异常值-负面舆情预警简报",
41 "alertName" : "test",
42 "createTime" : 1617314513000,
43 "alertReportType" : "NORMAL",
44 "taskName" : "深圳限购",
45 "id" : 11052,
46 "taskId" : 373
47 } ]
48}
获取推送记录列表
功能说明
获取推送记录列表
请求path
Plain Text
1GET /v1/alertReports/sendList
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Query | alertId | 否 | 预警方案id | int |
| Query | keyword | 否 | 根据预警方案名称、联系人名称过滤 | string |
| Query | limit | 否 | 当次请求返回的列表最大条数 | int |
| Query | sort | 否 | 时间排序方法,支持ASC, DESC两种 | string |
| Query | start | 否 | 本次请求的起始位置,用户可通过start+limit进行多轮结果请求 | int |
| Query | taskName | 否 | 监控方案名称 | string |
| Query | timeFrom | 否 | 时间范围查询,timeFrom和timeTo同时出现有效,毫秒时间戳格式,例如1604400780000,不传默认拉全部 | int |
| Query | timeTo | 否 | 时间范围查询,timeFrom和timeTo同时出现有效,毫秒时间戳格式,例如1604400780000,不传默认拉全部 | int |
- 请求示例
Plain Text
1method: GET
2path:/v1/alertReports/sendList
3query: timeFrom=1613703316748&timeTo=1613789716748
响应示例
Plain Text
1{
2 "totalCount": 2,
3 "list": [
4 {
5 "alertCondiction": "负面舆情同比增加超过30%",
6 "alertNeedSend": "NEED",
7 "alertNum": 7,
8 "alertType": "UNNORMAL",
9 "alertSendStatus": "SENED_AND_SHOW",
10 "alertSendTime": 1617584501000,
11 "contactList": [
12 {
13 "createTime": 1614580131000,
14 "contactValue": "135****9690",
15 "contactName": "aik",
16 "contactDesc": "",
17 "contactType": "MOBILE",
18 "id": 74
19 }
20 ],
21 "alertReportName": "2021-04-05 09:00:00 异常值-负面舆情预警简报",
22 "alertName": "test",
23 "createTime": 1617584501000,
24 "alertReportType": "SYSMERGE",
25 "taskName": "深圳限购",
26 "id": 11617,
27 "taskId": 373
28 },
29 {
30 "alertCondiction": "负面舆情同比增加超过30%",
31 "alertNeedSend": "NEED",
32 "alertNum": 174,
33 "alertType": "UNNORMAL",
34 "alertSendStatus": "SENED_AND_SHOW",
35 "alertSendTime": 1616979700000,
36 "contactList": [
37 {
38 "createTime": 1614580131000,
39 "contactValue": "135****9690",
40 "contactName": "aik",
41 "contactDesc": "",
42 "contactType": "MOBILE",
43 "id": 74
44 }
45 ],
46 "alertReportName": "2021-03-29 09:00:00 异常值-负面舆情预警简报",
47 "alertName": "test",
48 "createTime": 1616979700000,
49 "alertReportType": "SYSMERGE",
50 "taskName": "深圳限购",
51 "id": 10234,
52 "taskId": 373
53 }
54 ]
55}
获取联系人列表
功能说明
获取联系人列表
请求path
Plain Text
1GET /v1/contacts
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Query | contactType | 否 | 可选值ALL, MOBILE, EMAIL | string |
| Query | limit | 否 | 当次请求返回的列表最大条数 | int |
| Query | start | 否 | 本次请求的起始位置,用户可通过start+limit进行多轮结果请求 | int |
- 请求示例
Plain Text
1/v1/contacts?start=0&limit=100&contactType=EMAIL
响应示例
Plain Text
1{
2 "totalCount" : 1,
3 "list" : [ {
4 "createTime" : 1614580218000,
5 "contactValue" : "lia****@baidu.com",
6 "contactName" : "aik",
7 "contactDesc" : "",
8 "contactType" : "EMAIL",
9 "id" : 75
10 } ]
11}
获取联系人详情
功能说明
获取联系人详情
请求path
Plain Text
1GET /v1/contacts/{contactId}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | contactId | 是 | 联系人id | string |
- 请求示例
Plain Text
1GET /v1/contacts/75
响应示例
Plain Text
1{
2 "createTime": 1614580218000,
3 "contactValue": "lia****@baidu.com",
4 "contactName": "aik",
5 "contactDesc": "",
6 "contactType": "EMAIL",
7 "id": 75
8}
删除联系人
功能说明
删除联系人
请求path
Plain Text
1DELETE /v1/contacts/{contactId}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | contactId | 是 | 联系人id | string |
- 请求示例
Plain Text
1DELETE /v1/contacts/74
响应示例
Plain Text
1true //删除成功
获取邮箱验证码
功能说明
获取邮箱验证码
请求path
Plain Text
1POST /v1/contacts/email/code
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Body | 是 | 示例zhang3@126.com | string |
- 请求示例
Plain Text
1method: POST
2path: /v1/contacts/email/code
3body:
4{
5 "email": "zhang3@126.com"
6}
响应示例
Plain Text
1true
添加邮箱联系人
功能说明
添加邮箱联系人
请求path
Plain Text
1POST /v1/contacts/email
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Body | code | 是 | /v1/contacts/email/code接口返回的验证码 | string |
| Body | 否 | 联系人邮箱 | string | |
| Body | desc | 否 | 联系人相关描述 | string |
| Body | name | 是 | 联系人名称 | string |
- 请求示例
Plain Text
1method: POST
2path: /v1/contacts/email
3body:
4{
5 "code": "653986",
6 "email": "zhang3@126.com",
7 "desc": "",
8 "name": "zhang3"
9}
响应示例
Plain Text
197 //联系人id
更新邮箱联系人
功能说明
更新邮箱联系人
请求path
Plain Text
1PUT /v1/contacts/email/{contactId}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | contactId | 是 | 联系人id,可参见/v1/contacts接口返回列表 | string |
| Body | code | 是 | /v1/contacts/email/code接口返回的验证码 | string |
| Body | 否 | 联系人邮箱 | string | |
| Body | desc | 否 | 联系人相关描述 | string |
| Body | name | 是 | 联系人名称 | string |
- 请求示例
Plain Text
1method: PUT
2path: /v1/contacts/email/97
3body:
4{
5 "code": "653986",
6 "email": "zhang3@126.com",
7 "desc": "",
8 "name": "zhang3"
9}
响应示例
Plain Text
197 //联系人id
获取手机验证码
功能说明
获取手机验证码
请求path
Plain Text
1POST /v1/contacts/mobile/code
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Body | mobile | 是 | 示例 13765829753 | string |
- 请求示例
Plain Text
1method: POST
2path: /v1/contacts/mobile/code
3body:
4{
5 "mobile": "13765829753"
6}
响应示例
Plain Text
1true
添加手机联系人
功能说明
添加手机联系人
请求path
Plain Text
1POST /v1/contacts/mobile
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Body | code | 是 | /v1/contacts/mobile/code接口返回的验证码 | string |
| Body | mobile | 是 | 联系人手机号码 | string |
| Body | desc | 否 | 联系人相关描述 | string |
| Body | name | 是 | 联系人名称 | string |
- 请求示例
Plain Text
1method: POST
2path: /v1/contacts/mobile
3body:
4{
5 "code": "653986",
6 "mobile": "13510512690",
7 "desc": "",
8 "name": "zhang3"
9}
响应示例
Plain Text
196 //联系人id
更新手机联系人
功能说明
更新手机联系人
请求path
Plain Text
1PUT /v1/contacts/mobile/{contactId}
请求header
Plain Text
1"authorization": "xxxx"
2"host": "yuqing.bce.baidu.com"
3"Content-Type": "application/json"
4"accept": "*/*"
请求参数
| 类型 | 名称 | 必填 | 说明 | 类型 |
|---|---|---|---|---|
| Path | contactId | 是 | 联系人id,可参见/v1/contacts接口返回列表 | string |
| Body | code | 是 | /v1/contacts/mobile/code接口返回的验证码 | string |
| Body | mobile | 是 | 联系人手机号码 | string |
| Body | desc | 否 | 联系人相关描述 | string |
| Body | name | 是 | 联系人名称 | string |
- 请求示例
Plain Text
1method: PUT
2path: /v1/contacts/mobile/{contactId}
3body:
4{
5 "code": "653986",
6 "mobile": "13510512690",
7 "desc": "",
8 "name": "zhang3"
9}
响应示例
Plain Text
196 //返回该联系人id
