添加订阅
接口功能
企业用户添加订阅
请求地址
https://open.ys7.com/api/component/saas/subscription/add
请求方式
POST
参数列表
参数名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
accessToken | String | 开放平台授权获取的访问令牌 | Y |
msgType | Int | 推送的消息类型,目前对外推送的消息类型有: 离岗检测:10001 身份识别:10002 回头客:10003 门禁&锁事件消息:10004 设备报警:10005 设备上线离线消息:10006 门禁权限同步消息:10007 消防设备消息:10008 消息类型是唯一的。 |
Y |
postUrl | String | 企业用户提供的消息推送地址,服务端会采用Http协议Post请求的方式推送数据。 目前设置为2000毫秒若企业用户端未响应,则默认超时,会重试2次,如果还是失败会存储到失败记录表,客户可以通过“查询推送失败记录”接口查询。 |
Y |
privateKey | String | ras加密私钥。请使用512位,PKCS#8格式生成的rsa私钥。 如果不填,系统会随机生成512位,PKCS#8格式的rsa密钥对。 |
N |
remarks | String | 订阅信息备注 | Y |
请求报文
POST https://open.ys7.com/api/component/saas/subscription/add HTTP/1.1 Host: https://open.ys7.com content-type: application/x-www-form-urlencoded accessToken=at.cz71shznbdnxcyr9difaessc60n4sopj-2o91xv6z4l-07q8ulf-fotospidq&msgType=10001&postUrl=http://ip: port
返回数据
{ "msg": "操作成功!", "code": "saas-200", "data": null }
参数说明
参数名 | 类型 | 描述 | 是否必须 |
---|---|---|---|
code | int | 状态码-200表示成功 | Y |
msg | String | 具体错误描述信息 | Y |