[关闭]
@cfygaoyang 2018-07-09T03:47:00.000000Z 字数 12883 阅读 780

紫光云智能锁 (V1.1)

APP

说明

所有api接口请求，http header 定义 content-type: application/json;
上传文件请求方式为 form-data
服务器ip/host参考接口附件

账号体系

获取token(账号密码登陆)

POST /api/access_token

参数 类型 必须 说明
area 字符串 可选 国际区号：默认中国
account 字符串 是 手机号/邮箱
password 字符串 是 密码
appid 字符串 是 厂商标识 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "access_token": "884ffcc9d7af0b9a9abb2d1696a4a9db0a80b2bba2dc79fa4b05d10ebdd9",
  6.         "expires_in": 604800,
  7.         "expires_at": "2018-02-05 15:14:23",
  8.         "refresh_token": "f28f213ca3e202c4feca66b1eec863c68adf7aa570e4a6cf4d270382bf95"
  9.     }
  10. }
参数 类型 说明
access_token 字符串 用于接口authorization中的token
expires_in 整型 access_token有效期；单位：秒
expires_at 字符串 access_token有效期时间截止
refresh_token 字符串 用于刷新token

获取token(快捷登陆：账号验证码登陆)

POST /api/access_token

参数 类型 必须 说明
area 字符串 可选 国际区号：默认中国
account 字符串 是 手机号/邮箱
code 字符串 是 验证码
appid 字符串 是 厂商标识 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "access_token": "884ffcc9d7af0b9a9abb2d1696a4a9db0a80b2bba2dc79fa4b05d10ebdd9",
  6.         "expires_in": 604800,
  7.         "expires_at": "2018-02-05 15:14:23",
  8.         "refresh_token": "f28f213ca3e202c4feca66b1eec863c68adf7aa570e4a6cf4d270382bf95"
  9.     }
  10. }
参数 类型 说明
access_token 字符串 用于接口authorization中的token
expires_in 整型 access_token有效期；单位：秒
expires_at 字符串 access_token有效期时间截止
refresh_token 字符串 用于刷新token

刷新token

POST /api/refresh_token

参数 类型 必须 说明
refresh_token 字符串 是 刷新Token 
  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message":{
  5.         "access_token":"aa660df56d9bef4e4136af4ecfd9c71476dc804471fe73531ca73e3a67c2", 
  6.         "expires_in":604800, 
  7.         "expires_at":"2018-06-27 14:16:53", 
  8.         "refresh_token":"6acbb2361c99a7363cb91e86a73496d07dcb0910038b1f96b60af707b0fa"
  9.     }
  10. }
参数 类型 说明
access_token 字符串 用于接口authorization中的token
expires_in 整型 access_token有效期；单位：秒
expires_at 字符串 access_token有效期时间截止
refresh_token 字符串 用于刷新token

销毁token

POST /api/destroy_token

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

发送验证码

POST /api/send_code

参数 类型 必须 说明
area 字符串 可选 国际区号：默认中国
account 字符串 是 手机/邮箱
flag 整型 可选 标签：1注册2修改密码
appid 字符串 是 厂商标识 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

设置密码

POST /api/reset_password

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
old_password 字符串 可选 旧密码
password 字符串 是 密码 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

获取用户信息

GET /api/user/info

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "created_at": "2018-01-08 15:55:03",
  7.         "updated_at": "2018-01-08 15:55:03",
  8.         "avatar": "",
  9.         "birthday": "",
  10.         "sex": 2,
  11.         "city": "",
  12.         "address": "",
  13.         "user": 1,
  14.         "username": "18888888889",
  15.         "phone": "18888888889",
  16.         "email": "",
  17.         "company": "上海庆科",
  18.         "job": "Python",
  19.         "name": "张三"
  20.     }
  21. }
参数 类型 说明
avatar 字符串 头像
birthday 字符串 生日
sex 整型 性别 （2：女 1：男 0：未知）
city 字符串 城市
address 字符串 住址
username 字符串 昵称
phone 字符串 手机
email 字符串 邮箱
name 字符串 姓名
company 字符串 公司
job 字符串 职位

编辑用户信息

PUT /api/user/info

  1. {
  2.     "Authorization": " Token c8b1243cc508efc1e0d07e7a4091cee566d9976320edab08ea86886eeb27"
  3. }
参数 类型 必须 说明
avatar 字符串 可选 头像
birthday 字符串 可选 生日
sex 整型 可选 性别 （2：女 1：男 0：未知）
city 字符串 可选 城市
address 字符串 可选 住址
username 字符串 可选 昵称
phone 字符串 可选 手机
email 字符串 可选 邮箱
name 字符串 可选 姓名
company 字符串 可选 公司
job 字符串 可选 职位 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "created_at": "2018-01-08 15:55:03",
  7.         "updated_at": "2018-01-08 15:55:03",
  8.         "avatar": "",
  9.         "birthday": "",
  10.         "sex": 2,
  11.         "city": "",
  12.         "address": "",
  13.         "user": 1,
  14.         "username": "18888888889",
  15.         "phone": "18888888889",
  16.         "email": ""
  17.     }
  18. }
参数 类型 说明
avatar 字符串 头像
birthday 字符串 生日
sex 整型 性别 （2：女 1：男 0：未知）
city 字符串 城市
address 字符串 住址
username 字符串 昵称
phone 字符串 手机
email 字符串 邮箱
name 字符串 姓名
company 字符串 公司
job 字符串 职位

校验账号是否已注册

POST /api/account_check

参数 类型 必须 说明
area 字符串 可选 国际区号：默认中国
account 字符串 是 手机 /邮箱
appid 字符串 是 厂商标识 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "flag": true
  6.     }
  7. }
参数 类型 说明
flag boolean 是否已注册

设备

同步绑定设备

POST /api/device/bind

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
is_admin 整型 可选 用户角色：1 管理员 0 分享用户 ；默认为0
device_name 字符串 可选 设备名称：默认：紫光智能锁 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "is_admin": 1,
  6.         "device": "xxxxxx",
  7.         "user_id": 1,
  8.         "device_name": "紫光智能锁"
  9.     }
  10. }
参数 类型 说明
device 字符串 设备uuid
is_admin 整型 用户角色：1 管理员 0 分享用户
user_id 整型 用户id
device_name 字符串 设备设备昵称

同步解绑设备

DELETE /api/device/bind/{uuid}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 url参数；设备uuid
is_admin 整型 可选 url参数；用户角色：1 管理员 0 分享用户 ；默认为0 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

同步推送绑定

POST /api/client/bind

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
client_id 字符串 是 推送唯一标识符 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": ""
  5. }

推送开关

POST /api/push/switch

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
switch 整型 是 开关状态；0关闭1开启 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "switch": 1,
  6.         "user_id": 1,
  7.         "appid": "xxxxxxx"
  8.     }
  9. }

推送开关状态获取

GET /api/push/switch

  1. {
  2.     "Authorization": "Token 123456"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "switch": 1,
  6.         "user_id": 1,
  7.         "appid": "xxxxxxx"
  8.     }
  9. }

锁用户列表

GET /api/lock/user

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
user_tyoe 整型 可选 用户类型

* 请求回调

  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": [
  5.         {
  6.             "user_name": "小明",
  7.             "user_avatar": "http://xxx.com/xxx.jpg",
  8.             "user_role": 2,
  9.             "user_id": 1,
  10.             "user_type": 1,
  11.             "timestamp": "15200000000",
  12.             "created_at": 15200000000
  13.         }
  14.     ]
  15. }
参数 类型 说明
user_name 字符串 锁用户昵称
user_avatar 字符串 头像地址
timestamp 字符串 创建时间戳(单位：秒)
user_role 整型 用户角色
user_type 整型 用户类型;0:APP用户1:密码2:指纹3:感应卡
user_id 整型 锁用户id
created_at 整型 唯一标识（微秒时间戳）

编辑锁用户

PUT /api/lock/user/{created_at}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
created_at 整型 是 url参数；唯一标识（微秒时间戳）
user_name 字符串 可选 锁用户昵称
user_avatar 字符串 可选 头像地址

* 请求回调

  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": 
  5.     {
  6.         "id": "xxxxxx",
  7.         "user_name": "小明",
  8.         "user_avatar": "http://xxx.com/xxx.jpg",
  9.         "user_role": 2,
  10.         "user_id": 1,
  11.         "timestamp": "15200000000",
  12.         "created_at": 15200000000
  13.     }
  14. }

获取设备属性

GET /api/device/get/{deivce}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "device": "xxxxxx",
  6.         "device_name": "智能锁"
  7.     }
  8. }
参数 类型 说明
device 字符串 url参数；设备uuid
device_name 字符串 设备名称

设置设备属性

PUT /api/device/set/{deivce}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 url参数；设备uuid
device_name 字符串 是 设备名称

* 请求回调

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

意见反馈

反馈类型列表

GET /api/feedback/category

  1. {
  2.     "Authorization: Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "total": 5,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "appid": "",
  13.                 "created_at": "2018-03-26 09:52:39",
  14.                 "updated_at": "2018-03-26 09:52:39",
  15.                 "category_name": "设备使用问题"
  16.             },
  17.             {
  18.                 "id": 2,
  19.                 "appid": "",
  20.                 "created_at": "2018-03-26 09:53:41",
  21.                 "updated_at": "2018-03-26 09:53:41",
  22.                 "category_name": "APP使用出错"
  23.             },
  24.             {
  25.                 "id": 3,
  26.                 "appid": "",
  27.                 "created_at": "2018-03-26 09:53:56",
  28.                 "updated_at": "2018-03-26 09:53:56",
  29.                 "category_name": "设备配网问题"
  30.             },
  31.             {
  32.                 "id": 4,
  33.                 "appid": "",
  34.                 "created_at": "2018-03-26 09:54:07",
  35.                 "updated_at": "2018-03-26 09:54:07",
  36.                 "category_name": "功能与设计建议"
  37.             },
  38.             {
  39.                 "id": 5,
  40.                 "appid": "",
  41.                 "created_at": "2018-03-26 09:54:15",
  42.                 "updated_at": "2018-03-26 09:54:15",
  43.                 "category_name": "其他"
  44.             }
  45.         ]
  46.     }
  47. }

意见反馈列表

GET /api/feedback

  1. {
  2.     "Authorization: Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "total": 1,
  6.         "pages": 1,
  7.         "current_page": 1,
  8.         "page_size": 20,
  9.         "data": [
  10.             {
  11.                 "id": 1,
  12.                 "appid": "",
  13.                 "created_at": "2018-03-26 10:21:20",
  14.                 "updated_at": "2018-03-26 10:21:20",
  15.                 "feedback_content": "配网不成功",
  16.                 "device": "xxx-xxx-xxx-xxx",
  17.                 "category": 2,
  18.                 "user": 2
  19.             }
  20.         ]
  21.     }
  22. }

添加意见反馈

POST /api/feedback

  1. {
  2.     "Authorization: Token 1234567890"
  3. }
参数 类型 必须 说明
feedback_content 字符串 是 反馈内容
category 整型 可选 反馈类型
device 字符串 可选 设备uuid

* 请求回调

  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "appid": "",
  7.         "created_at": "2018-03-26 10:21:20",
  8.         "updated_at": "2018-03-26 10:21:20",
  9.         "feedback_content": "配网不成功",
  10.         "device": "xxx-xxx-xxx-xxx",
  11.         "category": 2,
  12.         "user": 2
  13.     }
  14. }

意见反馈详情

GET /api/feedback/{pk}

  1. {
  2.     "Authorization: Token 1234567890"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "appid": "",
  7.         "created_at": "2018-03-26 10:21:20",
  8.         "updated_at": "2018-03-26 10:21:20",
  9.         "feedback_content": "配网不成功",
  10.         "device": "xxx-xxx-xxx-xxx",
  11.         "category": 2,
  12.         "user": 2
  13.     }
  14. }

编辑意见反馈

PUT /api/feedback/{pk}

  1. {
  2.     "Authorization: Token 1234567890"
  3. }
参数 类型 必须 说明
feedback_content 字符串 是 反馈内容
category 整型 是 反馈类型
device 字符串 可选 设备uuid

* 请求回调

  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "appid": "",
  7.         "created_at": "2018-03-26 10:21:20",
  8.         "updated_at": "2018-03-26 10:24:49",
  9.         "feedback_content": "配网不成功",
  10.         "device": "xxx-xxx-xxx-xxx",
  11.         "category": 2,
  12.         "user": 2
  13.     }
  14. }

删除意见反馈

DELETE /api/feedback/{pk}

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

文件上传

图片上传

POST /api/upload/img

form-data 请求方式； 对应的 key 为 img
与其他api接口有区别

  1. {
  2.     "Authorization": "Token 123456"
  3. }
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "img_path": "/storage/uploads/img/20180614153221.jpg"
  6.     }
  7. }

img_path 为图片 path 路径；完整路径为 host + path

锁状态

获取锁状态

GET /api/lock/state

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "remote": {
  6.             "state": 0,
  7.             "timer": 0,
  8.             "remote_id": 1
  9.         },
  10.         "battery_percentage": 100,
  11.         "main_lock_state": true,
  12.         "back_lock_state": true,
  13.         "child_lock_state": true,
  14.         "remote_id": 20
  15.     }
  16. }
参数 类型 说明
status 整型 0:开门失败；1:开门成功；2:等待开门；3:其他
timer 整型 等待开门的倒计时时间段；单位（秒）
main_lock_state bool 主锁状态
back_lock_state bool 反锁状态
child_lock_state bool 童锁状态 
  1. 应用场景：
  2. 当 status=2
  3. 剩余有效时间 timer
  4. 当 status=0 或 1
  5. 远程开门结果；timer无效
  6. 当 status=3
  7. 其他

消息记录

故障记录

GET /api/lock/alarm

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
start_time 整型 可选 起始时间戳；单位（微秒）
end_time 整型 可选 结束时间戳单位（微秒）：默认为0，表示当前 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": [
  5.         {
  6.             "alarm_type": 1,
  7.             "timestamp": "15200000000",
  8.             "user_type": 1,
  9.             "user_id": 1,
  10.             "created_at": 15200000000
  11.         }
  12.     ]
  13. }
参数 类型 说明
timestamp 字符串 设备时间戳；单位（秒）
created_at 整型 唯一标识（微秒时间戳）
user_type 整型 用户类型

开门记录

GET /api/lock/open

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
user_type 整型 可选 用户类型
start_time 整型 可选 起始时间戳
end_time 整型 可选 结束时间戳：默认为0，表示当前 
  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": [
  5.         {
  6.             "user_type": 1,
  7.             "user_avatar": "",
  8.             "user_name": "用户1",
  9.             "timestamp": "15200000000",
  10.             "created_at": 15200000000
  11.         }
  12.     ]
  13. }
参数 类型 说明
timestamp 字符串 时间戳；单位（秒）
created_at 整型 唯一标识（微秒时间戳）
user_type 整型 用户类型
user_name 字符串 锁用户名
user_avatar 字符串 锁用户头像

获取APP配置信息

GET /api/app/config

  1. {
  2.     "code": 0,
  3.     "status": "success",
  4.     "message": {
  5.         "id": 1,
  6.         "appid": "XypDWhPWT2c0k5reNcuCgzHbi7BydFJkB8bnr4YV",
  7.         "created_at": "2018-06-15 00:00:00",
  8.         "updated_at": "2018-06-15 00:00:00",
  9.         "app_version": "V1.0.0",
  10.         "user_protocol": "http://www.baidu.com/"
  11.     }
  12. }
参数 类型 说明
app_version 字符串 app版本号
user_protocol 字符串 用户协议地址 url

轮播

获取轮播列表

GET /api/carousel

  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message":[
  5.         {
  6.             "id": 1,
  7.             "picture_url": "http://xxx.xx/xxx.jpg",
  8.             "picture_index": 1,
  9.             "out_url": "http://xxx.xx/xxx"
  10.         }
  11.     ]
参数 类型 说明
picture_url 字符串 图片地址
picture_index 整型 图片索引
out_url 字符串 跳转地址

报警电话

获取报警电话列表

GET /api/alarm/phone

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid

* 请求回调

  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message":[
  5.         {
  6.             "created_at": 100000000000000,
  7.             "device": "xxxxxxxx",
  8.             "user_id": 1,
  9.             "phone": "18656666666"
  10.         }
  11.     ]
  12. }
参数 类型 说明
created_at 整型 唯一标识（微秒时间戳）
device 字符串 设备uuid
user_id 整型 用户user_id
phone 字符串 报警电话

添加报警电话

POST /api/alarm/phone

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
phone 字符串 是 报警电话

* 请求回调

  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message":{
  5.         "device": "xxxxxx",
  6.         "phone": "18856666666",
  7.         "user_id": 1,
  8.         "created_at": 15555555555555
  9.     }
  10. }
参数 类型 说明
device 字符串 设备uuid
phone 字符串 报警电话
user_id 整型 用户id
created_at 整型 唯一标识（微秒时间戳）

编辑报警电话

PUT /api/alarm/phone/{created_at}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
created_at 整型 url参数；唯一标识（微秒时间戳）
device 字符串 是 设备uuid
phone 字符串 是 报警电话

* 请求回调

  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message": {
  5.         "device": "xxxxxx",
  6.         "phone": "18856666666",
  7.         "user_id": 1,
  8.         "created_at": 15555555555555
  9.     }
  10. }
参数 类型 说明
device 字符串 设备uuid
phone 字符串 报警电话
user_id 整型 用户id
created_at 整型 唯一标识（微秒时间戳）

删除报警电话

DELETE /api/alarm/phone/{created_at}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
created_at 整型 url参数；唯一标识（微秒时间戳）
device 字符串 是 url参数；设备uuid

* 请求回调

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

获取劫持报警电话列表

GET /api/hijack/alarm/phone

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
user_created_at 整型 是 锁用户唯一标识

* 请求回调

  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message":[
  5.         {
  6.             "created_at": 100000000000000,
  7.             "user_created_at": 100000000000000,
  8.             "device": "xxxxxxxx",
  9.             "user_id": 1,
  10.             "phone": "18656666666"
  11.         }
  12.     ]
  13. }
参数 类型 说明
user_created_at 整型 锁用户唯一标识（微秒时间戳）
created_at 整型 唯一标识（微秒时间戳）
device 字符串 设备uuid
user_id 整型 用户user_id
phone 字符串 报警电话

添加劫持报警电话

POST /api/hijack/alarm/phone

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
device 字符串 是 设备uuid
phone 字符串 是 报警电话
user_created_at 整型 是 所用户唯一标识（微秒时间戳）

* 请求回调

  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message": {
  5.         "created_at": 100000000000000,
  6.         "user_created_at": 100000000000000,
  7.         "device": "xxxxxxxx",
  8.         "user_id": 1,
  9.         "phone": "18656666666"
  10.     }
  11. }
参数 类型 说明
user_created_at 整型 所用户唯一标识（微秒时间戳）
created_at 整型 唯一标识（微秒时间戳）
device 字符串 设备uuid
user_id 整型 用户user_id
phone 字符串 报警电话

编辑劫持报警电话

PUT /api/hijack/alarm/phone/{created_at}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
created_at 整型 url参数；唯一标识（微秒时间戳）
device 字符串 是 设备uuid
phone 字符串 是 报警电话

* 请求回调

  1. {
  2.     "code":0, 
  3.     "status":"success",
  4.     "message": {
  5.         "created_at": 100000000000000,
  6.         "user_created_at": 100000000000000,
  7.         "device": "xxxxxxxx",
  8.         "user_id": 1,
  9.         "phone": "18656666666"
  10.     }
  11. }
参数 类型 说明
user_created_at 整型 所用户唯一标识（微秒时间戳）
created_at 整型 唯一标识（微秒时间戳）
device 字符串 设备uuid
user_id 整型 用户user_id
phone 字符串 报警电话

删除劫持报警电话

DELETE /api/hijack/alarm/phone/{created_at}

  1. {
  2.     "Authorization": "Token 123456"
  3. }
参数 类型 必须 说明
created_at 整型 url参数；唯一标识（微秒时间戳）
device 字符串 是 url参数；设备uuid

* 请求回调

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

设备端接口

设备恢复出厂设置

POST /api/device/restore

参数 类型 必须 说明
sn 字符串 是 设备sn号
signature 字符串 是 签名

* 请求回调

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

错误码

自定义错误码

错误码 错误信息 描述
10000 ... 通用错误码
10001 the phone is registered 手机号已注册
10002 the phone is not registered 手机号未注册
10003 触发分钟级流控Permits:1 获取验证码太频繁
10004 invalid token token无效
10005 The code is invalid 验证码无效
10006 The password is invalid 密码错误
10007 invalid phone 手机不合法
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注