推送服务
接口功能
本服务为对外推送消息的服务,不是api接口,需要企业用户在订阅消息时,提交可用的postUrl后,我们将会对外推送给企业用户消息,消息结构为json格式
推送方式
假定用户提供的postUrl地址为:http://www.xxxxxx.com/api 我们会以 content-type: application/json 的格式向上述地址推送一段通过密钥加密后的字符串 需要通过获取订阅信息中的公钥(publickey)进行RSA解密,其中keyPairGen为512,解密后,会获得明文的json字符串,即为推送消息的具体内容,解密后的json格式如下:
{ "eps": { "alert": [{ "msgType": "[消息类型]", "body": "[消息内容]" }] } }
推送方式
POST
推送参数
参数名 | 类型 | 描述 |
---|---|---|
eps | String | Ezviz Push Services,目前只有alert参数,后期可能根据业务扩展 |
alert | String | 消息体(为数组格式,可支持消息批量推送,也便于用户要求 不同功能类型的数据在同一批次内推送) |
msgType | Int | 推送的消息类型,目前对外推送的消息类型有: 离岗检测:10001 身份识别:10002 回头客:10003 门禁事件消息:10004(云门禁组件) 设备报警:10005 设备上线离线消息:10006 门禁权限同步消息:10007 消防设备消息:10008 消息类型是唯一的。 |
请求报文
POST https://open.ys7.com/api/component/saas/subscription/delete HTTP/1.1 Host: https://open.ys7.com content-type: application/json accessToken=at.cz71shznbdnxcyr9difaessc60n4sopj-2o91xv6z4l-07q8ulf-fotospidq&msgType=10001
返回数据
{ "msg": "操作成功!", "code": "saas-200", "data": null }
参数说明
参数名 | 类型 | 描述 | 是否必须 |
---|---|---|---|
code | int | 状态码-200表示成功 | Y |
msg | String | 具体错误描述信息 | Y |