预警推送
所有文档

          舆情服务

          预警推送

          添加预警方案

          功能说明

          添加预警推送方案

          请求path

          POST /v1/alerts

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "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
          • 请求示例
          method: POST
          path:/v1/alerts
          body:
          {
              "alertName": "test2",
              "taskId": 592,
              "alertMediaList": [
                  "APP_MEDIA",
                  "BBS_MEDIA",
                  "NEWS_MEDIA",
                  "FEED_MEDIA",
                  "WEIBO_MEDIA",
                  "BOKE_MEDIA",
                  "VIDEO_MEDIA",
                  "OTHER_MEDIA"
              ],
              "alertType": "UNNORMAL",
              "allUnnormalAlert": "ON",
              "allUnnormalAlertValue": 30,
              "negativeUnnormalAlert": "OFF",
              "negativeUnnormalAlertValue": 30,
              "alertKeywordList": [
                  ""
              ],
              "keywordHitType": "ALL",
              "alertContact": "ON",
              "alertMon": "ON",
              "alertTues": "ON",
              "alertWed": "ON",
              "alertThur": "ON",
              "alertFri": "ON",
              "alertSat": "OFF",
              "alertSun": "OFF",
              "alertDayStartTime": 32400,
              "alertDayEndTime": 64800,
              "alertMinTimeInterval": 3600,
              "alertWarning": "OFF",
              "alertEmail": "ON",
              "alertMobile": "ON",
              "mobileContactIds": [
                  74
              ],
              "emailContactIds": [
                  75
              ],
              "alertStatus": "ON"
          }

          响应示例

          78  //返回该预警任务id

          获取预警列表

          功能说明

          获取预警方案列表

          请求path

          GET /v1/alerts

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "accept": "*/*"

          请求参数

          • 请求示例
          method: GET
          path:/v1/alerts

          响应示例

          {
            "totalAlertNum" : 100,
            "usedAlertNum" : 1,
            "leftAlertNum" : 99,
            "list" : [ {
              "alertStatus" : "ON",
              "alertType" : "UNNORMAL",
              "alertKeywordList" : [ "" ],
              "allUnnormalAlertValue" : 30,
              "alertContact" : "ON",
              "alertName" : "test",
              "negativeUnnormalAlert" : "ON",
              "createTime" : 1614580340000,
              "allUnnormalAlert" : "OFF",
              "taskName" : "深圳限购",
              "id" : 58,
              "negativeUnnormalAlertValue" : 30,
              "taskId" : 373
            } ]
          }

          获取预警详情

          功能说明

          获取预警方案详情

          请求path

          GET /v1/alerts/{alertId}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path alertId 预警方案id int
          • 请求示例
          method: GET
          path:/v1/alerts/78

          响应示例

          {
            "id" : 78,
            "taskName" : "智慧校园",
            "alertName" : "test2",
            "alertType" : "UNNORMAL",
            "userId" : 145,
            "taskId" : 592,
            "alertMediaList" : [ "APP_MEDIA", "BBS_MEDIA", "NEWS_MEDIA", "FEED_MEDIA", "WEIBO_MEDIA", "BOKE_MEDIA", "VIDEO_MEDIA", "OTHER_MEDIA" ],
            "keywordHitType" : "ALL",
            "alertKeywordList" : [ "" ],
            "alertStatus" : "ON",
            "allUnnormalAlert" : "ON",
            "allUnnormalAlertValue" : 30,
            "negativeUnnormalAlert" : "OFF",
            "negativeUnnormalAlertValue" : 30,
            "alertSun" : "OFF",
            "alertMon" : "ON",
            "alertTues" : "ON",
            "alertWed" : "ON",
            "alertThur" : "ON",
            "alertFri" : "ON",
            "alertSat" : "OFF",
            "alertDayStartTime" : 32400,
            "alertDayEndTime" : 64800,
            "alertMinTimeInterval" : 3600,
            "alertWarning" : "OFF",
            "alertContact" : "ON",
            "alertEmail" : "ON",
            "alertMobile" : "ON",
            "createTime" : 1617691086000,
            "updateTime" : 1617691086000,
            "lastAlertTime" : null,
            "del" : 0,
            "emailContactIds" : [ 75 ],
            "mobileContactIds" : [ 74 ]
          }

          更新预警方案

          功能说明

          更新预警推送方案

          请求path

          PUT /v1/alerts/{alertId}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "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
          • 请求示例
          method: PUT
          path:/v1/alerts/3219
          body:
          {
              "alertName": "test2",
              "taskId": 592,
              "alertMediaList": [
                  "APP_MEDIA",
                  "BBS_MEDIA",
                  "NEWS_MEDIA",
                  "OTHER_MEDIA"
              ],
              "alertType": "UNNORMAL",
              "allUnnormalAlert": "ON",
              "allUnnormalAlertValue": 30,
              "negativeUnnormalAlert": "OFF",
              "negativeUnnormalAlertValue": 30,
              "alertKeywordList": [
                  ""
              ],
              "keywordHitType": "ALL",
              "alertContact": "ON",
              "alertMon": "ON",
              "alertTues": "OFF",
              "alertWed": "OFF",
              "alertThur": "OFF",
              "alertFri": "OFF",
              "alertSat": "OFF",
              "alertSun": "OFF",
              "alertDayStartTime": 32400,
              "alertDayEndTime": 64800,
              "alertMinTimeInterval": 3600,
              "alertWarning": "OFF",
              "alertEmail": "ON",
              "alertMobile": "ON",
              "mobileContactIds": [
                  74
              ],
              "emailContactIds": [
                  75
              ],
              "alertStatus": "ON"
          }

          响应示例

          78  //返回该预警任务id

          删除预警方案

          功能说明

          删除预警方案

          请求path

          DELETE /v1/alerts/{alertId}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path alertId 预警方案id int
          • 请求示例
          method: DELETE
          path:/v1/alerts/78

          响应示例

          true  //删除成功

          更新邮件推送开关

          功能说明

          更新邮件推送开关

          请求path

          PUT /v1/alerts/{alertId}/alertEmail/{action}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path alertId 预警方案id int
          Path action 值为ON或OFF int
          • 请求示例
          method: PUT
          path:/v1/alerts/3276/alertEmail/ON
          body: {}

          响应示例

          78  //返回该预警任务id

          更新短信推送开关

          功能说明

          更新短信推送开关

          请求path

          PUT /v1/alerts/{alertId}/alertMobile/{action}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path alertId 预警方案id int
          Path action 值为ON或OFF int
          • 请求示例
          method: PUT
          path:/v1/alerts/3276/alertMobile/ON
          body: {}

          响应示例

          78  //返回该预警任务id

          更新预警监测开关

          功能说明

          更新预警监测开关

          请求path

          PUT /v1/alerts/{alertId}/alertStatus/{action}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path alertId 预警方案id int
          Path action 值为ON或OFF string
          • 请求示例
          method: PUT
          path:/v1/alerts/78/alertStatus/ON
          body: {}

          响应示例

          78 //返回预警任务id

          获取报告列表

          功能说明

          获取预警报告列表

          请求path

          GET /v1/alertReports

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "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
          • 请求示例
          method: GET
          path:/v1/alertReports
          query: start=0&limit=10&sort=DESC&timeFrom=1617033600000&timeTo=1617691535053&alertId=78

          响应示例

          {
            "totalCount" : 2,
            "list" : [ {
              "alertCondiction" : "负面舆情同比增加超过30%",
              "alertNeedSend" : "NEED",
              "alertNum" : 3,
              "alertType" : "UNNORMAL",
              "alertSendStatus" : "SENDED",
              "alertSendTime" : 0,
              "contactList" : [ {
                "createTime" : 1614580131000,
                "contactValue" : "135****9690",
                "contactName" : "aik",
                "contactDesc" : "",
                "contactType" : "MOBILE",
                "id" : 74
              } ],
              "alertReportName" : "2021-04-05 06:00:00 异常值-负面舆情预警简报",
              "alertName" : "test",
              "createTime" : 1617573702000,
              "alertReportType" : "NORMAL",
              "taskName" : "深圳限购",
              "id" : 11591,
              "taskId" : 373
            }, {
              "alertCondiction" : "负面舆情同比增加超过30%",
              "alertNeedSend" : "NEED",
              "alertNum" : 4,
              "alertType" : "UNNORMAL",
              "alertSendStatus" : "SENDED",
              "alertSendTime" : 0,
              "contactList" : [ {
                "createTime" : 1614580131000,
                "contactValue" : "135****9690",
                "contactName" : "aik",
                "contactDesc" : "",
                "contactType" : "MOBILE",
                "id" : 74
              } ],
              "alertReportName" : "2021-04-02 06:00:16 异常值-负面舆情预警简报",
              "alertName" : "test",
              "createTime" : 1617314513000,
              "alertReportType" : "NORMAL",
              "taskName" : "深圳限购",
              "id" : 11052,
              "taskId" : 373
            } ]
          }

          获取推送记录列表

          功能说明

          获取推送记录列表

          请求path

          GET /v1/alertReports/sendList

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "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
          • 请求示例
          method: GET
          path:/v1/alertReports/sendList
          query: timeFrom=1613703316748&timeTo=1613789716748

          响应示例

          {
              "totalCount": 2,
              "list": [
                  {
                      "alertCondiction": "负面舆情同比增加超过30%",
                      "alertNeedSend": "NEED",
                      "alertNum": 7,
                      "alertType": "UNNORMAL",
                      "alertSendStatus": "SENED_AND_SHOW",
                      "alertSendTime": 1617584501000,
                      "contactList": [
                          {
                              "createTime": 1614580131000,
                              "contactValue": "135****9690",
                              "contactName": "aik",
                              "contactDesc": "",
                              "contactType": "MOBILE",
                              "id": 74
                          }
                      ],
                      "alertReportName": "2021-04-05 09:00:00 异常值-负面舆情预警简报",
                      "alertName": "test",
                      "createTime": 1617584501000,
                      "alertReportType": "SYSMERGE",
                      "taskName": "深圳限购",
                      "id": 11617,
                      "taskId": 373
                  },
                  {
                      "alertCondiction": "负面舆情同比增加超过30%",
                      "alertNeedSend": "NEED",
                      "alertNum": 174,
                      "alertType": "UNNORMAL",
                      "alertSendStatus": "SENED_AND_SHOW",
                      "alertSendTime": 1616979700000,
                      "contactList": [
                          {
                              "createTime": 1614580131000,
                              "contactValue": "135****9690",
                              "contactName": "aik",
                              "contactDesc": "",
                              "contactType": "MOBILE",
                              "id": 74
                          }
                      ],
                      "alertReportName": "2021-03-29 09:00:00 异常值-负面舆情预警简报",
                      "alertName": "test",
                      "createTime": 1616979700000,
                      "alertReportType": "SYSMERGE",
                      "taskName": "深圳限购",
                      "id": 10234,
                      "taskId": 373
                  }
              ]
          }

          获取联系人列表

          功能说明

          获取联系人列表

          请求path

          GET /v1/contacts

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Query contactType 可选值ALL, MOBILE, EMAIL string
          Query limit 当次请求返回的列表最大条数 int
          Query start 本次请求的起始位置,用户可通过start+limit进行多轮结果请求 int
          • 请求示例
          /v1/contacts?start=0&limit=100&contactType=EMAIL

          响应示例

          {
            "totalCount" : 1,
            "list" : [ {
              "createTime" : 1614580218000,
              "contactValue" : "lia****@baidu.com",
              "contactName" : "aik",
              "contactDesc" : "",
              "contactType" : "EMAIL",
              "id" : 75
            } ]
          }

          获取联系人详情

          功能说明

          获取联系人详情

          请求path

          GET /v1/contacts/{contactId}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path contactId 联系人id string
          • 请求示例
          GET /v1/contacts/75

          响应示例

          {
              "createTime": 1614580218000,
              "contactValue": "lia****@baidu.com",
              "contactName": "aik",
              "contactDesc": "",
              "contactType": "EMAIL",
              "id": 75
          }

          删除联系人

          功能说明

          删除联系人

          请求path

          DELETE /v1/contacts/{contactId}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path contactId 联系人id string
          • 请求示例
          DELETE /v1/contacts/74

          响应示例

          true  //删除成功

          获取邮箱验证码

          功能说明

          获取邮箱验证码

          请求path

          POST /v1/contacts/email/code

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Body email 示例zhang3@126.com string
          • 请求示例
          method: POST
          path: /v1/contacts/email/code
          body:
          {
            "email": "zhang3@126.com"
          }

          响应示例

          true

          添加邮箱联系人

          功能说明

          添加邮箱联系人

          请求path

          POST /v1/contacts/email

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Body code /v1/contacts/email/code接口返回的验证码 string
          Body email 联系人邮箱 string
          Body desc 联系人相关描述 string
          Body name 联系人名称 string
          • 请求示例
          method: POST
          path: /v1/contacts/email
          body:
          {
            "code": "653986",
            "email": "zhang3@126.com",
            "desc": "",
            "name": "zhang3"
          }

          响应示例

          97  //联系人id

          更新邮箱联系人

          功能说明

          更新邮箱联系人

          请求path

          PUT /v1/contacts/email/{contactId}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path contactId 联系人id,可参见/v1/contacts接口返回列表 string
          Body code /v1/contacts/email/code接口返回的验证码 string
          Body email 联系人邮箱 string
          Body desc 联系人相关描述 string
          Body name 联系人名称 string
          • 请求示例
          method: PUT
          path: /v1/contacts/email/97
          body:
          {
            "code": "653986",
            "email": "zhang3@126.com",
            "desc": "",
            "name": "zhang3"
          }

          响应示例

          97  //联系人id

          获取手机验证码

          功能说明

          获取手机验证码

          请求path

          POST /v1/contacts/mobile/code

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Body mobile 示例 13765829753 string
          • 请求示例
          method: POST
          path: /v1/contacts/mobile/code
          body:
          {
            "mobile": "13765829753"
          }

          响应示例

          true

          添加手机联系人

          功能说明

          添加手机联系人

          请求path

          POST /v1/contacts/mobile

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Body code /v1/contacts/mobile/code接口返回的验证码 string
          Body mobile 联系人手机号码 string
          Body desc 联系人相关描述 string
          Body name 联系人名称 string
          • 请求示例
          method: POST
          path: /v1/contacts/mobile
          body:
          {
            "code": "653986",
            "mobile": "13510512690",
            "desc": "",
            "name": "zhang3"
          }

          响应示例

          96  //联系人id

          更新手机联系人

          功能说明

          更新手机联系人

          请求path

          PUT /v1/contacts/mobile/{contactId}

          请求header

          "authorization": "xxxx"
          "host": "yuqing.bce.baidu.com"
          "Content-Type": "application/json"
          "accept": "*/*"

          请求参数

          类型 名称 必填 说明 类型
          Path contactId 联系人id,可参见/v1/contacts接口返回列表 string
          Body code /v1/contacts/mobile/code接口返回的验证码 string
          Body mobile 联系人手机号码 string
          Body desc 联系人相关描述 string
          Body name 联系人名称 string
          • 请求示例
          method: PUT
          path: /v1/contacts/mobile/{contactId}
          body:
          {
            "code": "653986",
            "mobile": "13510512690",
            "desc": "",
            "name": "zhang3"
          }

          响应示例

          96  //返回该联系人id
          上一篇
          舆情分析
          下一篇
          API接口常见报错与处理