[关闭]
@cfygaoyang 2018-06-08T08:57:56.000000Z 字数 5170 阅读 573

推送接口 (图正/鸿雁/天诚)

推送相关

用户上传推送客户端ID

POST /api/user/push/bind

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
client_id 字符串 是 推送客户端ID 
  1. {
  2.     "code": 0,
  3.     "message": {
  4.         "id": 5,
  5.         "app_id": "50e7c476-f10c-4699-9243-d8ed9ddc10f8",
  6.         "created_at": "2017-12-21T17:14:48.127000",
  7.         "updated_at": "2017-12-21T17:14:48.127000",
  8.         "user_id": 2,
  9.         "client_id": <client_id>,
  10.         "accept": true
  11.     }
  12. }

设备绑定

POST /api/user/device/bind

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
phone 字符串 是 绑定（或被分享）者的手机号
device_id 字符串 是 设备ID
admin 整数 否 1:管理员 0:普通用户

备注：  admin=1为管理员绑定设备，会把原设备成员踢出
备注2：管理员可分享设备给其他用户

  1. {
  2.     "message": {
  3.         "app_id": "50e7c476-f10c-4699-9243-d8ed9ddc10f8",
  4.         "user_id": 2,
  5.         "device_id": <device_id>
  6.     },
  7.     "code": 0
  8. }

设备解绑

DELETE /api/user/device/bind/{DEVICE_ID}?phone={phone}
备注：管理员解绑则所有设备成员解绑
          管理员可以解绑设备其他成员
          成员只能解绑自己 

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
device_id 字符串 是 设备ID
phone 字符串 是 解绑（或被分享）者的手机号

* 请求回调

  1. {
  2.     "message": "success",
  3.     "code": 0
  4. }

推送接收开关

PUT /api/user/push/accept

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
accept 整数 是 1：接收，0：不接收
client_id 字符串 是 1234567890 
  1. {
  2.     "message": "success.",
  3.     "code": 0
  4. }

推送接收状态查询

GET /api/user/push/accept?client_id=1234567890

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
client_id 字符串 是 推送id 
  1. {
  2.     "message": {
  3.         "accept": false
  4.     },
  5.     "code": 0
  6. }

设备查询(所有设备)

GET /api/user/device/bind

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": [
  3.         {
  4.             "id": 1,
  5.             "app_id": "9b90dba3-995e-4a5c-b23c-4198916a4b60",
  6.             "created_at": "2017-12-28T10:46:24.918000",
  7.             "updated_at": "2017-12-28T10:46:48.821000",
  8.             "user_id": 1,
  9.             "device_id": "abcde",
  10.             "device_name": "big door",
  11.             "permission": 1
  12.         }
  13.     ],
  14.     "code": 0
  15. }

设备查询(单设备)

GET /api/user/device/bind/{device_id}

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": {
  3.         "id": 1,
  4.         "app_id": "9b90dba3-995e-4a5c-b23c-4198916a4b60",
  5.         "created_at": "2017-12-28T10:46:24.918000",
  6.         "updated_at": "2017-12-28T10:46:48.821000",
  7.         "user_id": 1,
  8.         "device_id": "abcde",
  9.         "device_name": "big door",
  10.         "permission": 1
  11.     },
  12.     "code": 0
  13. }

设备成员查询

GET /api/user/device/members/{device_id}
备注：仅设备管理员可查

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": [
  3.         {
  4.             "user_id": 1,
  5.             "app_id": "9b90dba3-995e-4a5c-b23c-4198916a4b60",
  6.             "created_at": "2017-12-28T10:31:23.284000",
  7.             "updated_at": "2017-12-28T10:31:54.216000",
  8.             "user_email": "",
  9.             "user_telephone": "15618927901",
  10.             "user_password": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXNzd29yZCI6IjEyMzQ1NiJ9.tj8r8ucscDj-q9IxWzMKSE8-HbJI2qOhqk8Nzh8RR_s"
  11.         },
  12.         {
  13.             "user_id": 2,
  14.             "app_id": "9b90dba3-995e-4a5c-b23c-4198916a4b60",
  15.             "created_at": "2017-12-28T10:31:23.284000",
  16.             "updated_at": "2017-12-28T10:31:54.216000",
  17.             "user_email": "",
  18.             "user_telephone": "123123",
  19.             "user_password": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXNzd29yZCI6IjEyMzQ1NiJ9.tj8r8ucscDj-q9IxWzMKSE8-HbJI2qOhqk8Nzh8RR_s"
  20.         }
  21.     ],
  22.     "code": 0
  23. }

推送消息列表(锁设备)

GET /api/user/device/message?device_id={device_id}&push_type={push_type}&page=1

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
device_id 整数 否 所查消息的设备id
push_type 整数 否 消息类型 1.开门记录2.报警记录3.请求远程开门4.用户添加和删除
page 整数 否 每页20条，默认第一页
msg_status 整数 否 0:未读消息 1:已读消息

* 请求回调

  1. {
  2.     "message": {
  3.         "total":3,
  4.         "data":{...},
  5.         "pages": 1,
  6.         "page_size": 20,
  7.         "current_page": 1
  8.     },
  9.     "code": 0
  10. }

推送消息状态修改(锁设备)

PUT /api/user/device/message

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
push_id 整数 是 推送消息ID
msg_status 整数 是 0:未读 1:已读 -1:删除 
  1. {
  2.     "message": {
  3.         "id": 1,
  4.         "app_id": "f981d5c1-2a50-4632-a5d4-122e2bc5df7aa",
  5.         "created_at": "2018-01-03T14:23:00.685000",
  6.         "updated_at": "2018-01-03T15:00:49.215000",
  7.         "push_id": 62,
  8.         "user_id": 4,
  9.         "msg_status": 1
  10.     },
  11.     "code": 0
  12. }

推送消息全部已读(锁设备)

PUT /api/user/device/all_message_read

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
  1. {
  2.     "message": "success",
  3.     "code": 0
  4. }

推送消息列表(净水器设备)

GET /api/user/device/purifier/message?device_id={device_id}&push_type={push_type}&page=1

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
device_id 整数 否 所查消息的设备id
push_type 整数 否 消息类型 1.滤芯消息2.报警记录3.工作状态
page 整数 否 每页20条，默认第一页
msg_status 整数 否 0:未读消息 1:已读消息

* 请求回调

  1. {
  2.     "message": {
  3.         "total":3,
  4.         "data":{...},
  5.         "pages": 1,
  6.         "page_size": 20,
  7.         "current_page": 1
  8.     },
  9.     "code": 0
  10. }

推送消息状态修改(净水器设备)

PUT /api/user/device/purifier/message

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
push_id 整数 是 推送消息ID
msg_status 整数 是 0:未读 1:已读 -1:删除 
  1. {
  2.     "message": {
  3.         "id": 1,
  4.         "app_id": "f981d5c1-2a50-4632-a5d4-122e2bc5df7aa",
  5.         "created_at": "2018-01-03T14:23:00.685000",
  6.         "updated_at": "2018-01-03T15:00:49.215000",
  7.         "push_id": 62,
  8.         "user_id": 4,
  9.         "msg_status": 1
  10.     },
  11.     "code": 0
  12. }

推送消息列表(运营)

推送消息状态修改(运营)

(运营)消息推送

POST /web/push

  1. {
  2.     "Authorization" :"1234567890qwertyuio"
  3. }
参数 类型 必须 说明
push_title 字符串 是 标题
push_content 字符串 是 内容

* 请求回调

  1. {
  2.     "message": "success.",
  3.     "code": 0
  4. }

(运营)推送消息列表查询

(锁设备)消息推送

POST /device/push

参数 类型 必须 说明
device_id 字符串 是 设备ID
push_type 整数 是 消息类型 1:开门 2:报警 3:远程开门请求 4:添加用户 5:删除用户
open_type 字符串 否 开门类型 1:密码 2:指纹 3:卡片 4:遥控器 5:钥匙 6:远程开门
alarm_type 字符串 否 14种报警类型，见TRD
remote_type 整数 否 远程开门类型 1:密码
lock_user_id 字符串 否 锁用户id
admin_flag 字符串 否 1:管理员 2:非管理员
timestamp 字符串 否 设备上报的时间戳 
  1. {
  2.     "message": "success.",
  3.     "code": 0
  4. }

(锁设备)设备重置

参数 类型 必须 说明
device_id 字符串 是 设备ID

* 请求回调

  1. {
  2.     "message": "success.",
  3.     "code": 0
  4. }

(净水器设备)消息推送

POST /device/purifier/push

参数 类型 必须 说明
device_id 字符串 是 设备ID
push_type 整数 是 消息类型 1:滤芯 2:报警 3:状态
alarm_type 字符串 否 9种报警类型，见TRD
work_status 字符串 否 1种工作状态
filter_status 字符串 否 2种滤芯状态
filter_id 字符串 否 滤芯1-4
timestamp 字符串 否 设备上报的时间戳

filter_status 状态类型
1.滤芯寿命5%
2.滤芯寿命10%

work_status
6.滤芯制水超时

alarm_type 报警类型
1 温度传感器故障
2 原水 TDS 传感器故障
3 纯水 TDS 传感器故障
4 漏水报警
5 制水超时保护功能
6 废水比阀故障
7 进水电磁阀故障
8 增压水泵故障
9 高压开关故障

  1. {
  2.     "message": "success.",
  3.     "code": 0
  4. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注