预警通知
推送所有用户仪表盘中的预警消息至BDP外部的接口中,可用于将预警信息进一步转发、二次处理等。
该功能仅限超级管理员使用
1 使用流程
- 开发一个消息接收服务,需要公网可访问
- 开启预警通知服务,设置消息推送地址,发送测试信息校验接口有效性
- 当图表预警触发时,BDP推送消息至用户预设的接口地址,分享表包含查看者和分享者两人的预警信息
- 用户收到消息后返回“200”用以确认接收成功
- 开启后,可停用或修改接收地址
2 接收服务
2.1 接口说明
使用预警通知需要准备一个接口服务,用于接收推送消息,接口说明:
- 推送的http请求为POST,预警信息在请求参数中;
- 接收到消息后,通过url返回的http code来判断是否发送成功, 如果code为200,即发送成功,否则记为失败;
- 默认超时时间为5秒,超时后消息推送失败;
2.2 字段说明
请求中的参数包含以下内容:
字段含义 | 字段名称 | 备注 |
---|---|---|
文件夹名称 | project_name | 触发预警图表所在文件夹 |
用户ID | user_id | 收到消息的BDP用户ID,可用于通过权限API查询用户手机号信息 |
仪表盘名称 | dashboard_name | 触发预警图表所在仪表盘 |
预警详情 | warn_result | 包含预警消息内容。 |
图表名称 | chart_name | 触发预警图表所在图表 |
用户名称 | user_name | 收到消息的BDP用户名 |
预警名称 | warn_name | 预警在BDP中设置的名称 |
2.3 数据示例
{
"project_name": "bdpbest", //文件夹名称
"user_id": "404f19b7b9360bd09bc250650e0f6058", //用户id
"dashboard_name": "bdp_dsh", //仪表盘名称
"warn_result": "北京(预警)-北部 的利润(求和)为104.00,天津(预警)-北部 的利润(求和)为88.00",
"chart_name": "每日收入情况", // 图表名称
"user_name": "test", //用户姓名
"warn_name": "warn_test" //预警名称
}
3 开启设置
在开发者中心中的配置管理中,打开“预警通知”,点击立即开启,输入以Http或Https开头的接收地址,通过校验后完成。
4 典型场景
BDP支持预警的移动端APP和邮件通知,用户倾向于使用短信通知提高预警信息的触达率,使用方式如下:
- 启用预警通知
- 根据用户和仪表盘类型指定不同的推送策略
- A用户的x仪表盘中数据每次触发立即短信通知
- B用户的y仪表盘中数据,当每日累计触发3次时发送短信通知
- C用户的z仪表盘中数据,当每日累计触发2次时电话通知
- 接收到预警信息后,并提取出用户ID
- 利用BDP的OpenAPI中权限管理接口,查询用户在BDP填写的手机号
- 将预警信息推送至目标手机号