1. 功能说明

用于账号信息的维护,以及账号之间的关联、网关、设备关系的维护等

2. 协议设计原则

  • 简化原则,目前统一使用POST方法
  • 采用json文本协议,保证协议可读性高和扩展性
  • 不添加额外的HTTP头部信息,只使用标准HTTP头部信息
  • 所有的参数都在http的body部分
  • json内容主要分header和body两部分,最上层为具体服务的缩写,本服务为UMS
  • 所有的字段类型为string
  • 所有请求均需要加密,加密方式如下:
  • 1 所有请求在“body”中新增“sign_timestamp”(当前时间戳--s)
  • 2 将所有参数及在“UMS”最后加上“secret”=“a1ff1dc37485ff9dac7844d975fa2e05”(包括“UMS”的所有内容)做32位MD5加密后转小写作为签名内容A
  • 3 在“UMS”中新增“sign”=“A”

3. 调用地址

POST https://ums.wonlycloud.com:10300

4. 消息类型定义

定义 描述
MSG_SMS_CODE_REQ 请求短信验证码
MSG_SMS_CODE_RSP 应答短信验证码
MSG_USER_REG_REQ 请求用户注册
MSG_USER_REG_RSP 应答用户注册
MSG_USER_DEL_REQ 请求用户删除
MSG_USER_DEL_RSP 应答用户删除
MSG_USER_LOGIN_REQ 请求用户登录
MSG_USER_LOGIN_RSP 应答用户登录
MSG_USER_LOGOUT_REQ 请求用户注销
MSG_USER_LOGOUT_RSP 应答用户注销
MSG_PASSWD_CHANGE_REQ 请求修改密码
MSG_PASSWD_CHANGE_RSP 应答修改密码
MSG_PASSWD_FORGET_REQ 请求忘记密码
MSG_PASSWD_FORGET_RSP 应答忘记密码
MSG_PERSONAL_DATA_UPDATE_REQ 请求更新个人资料
MSG_PERSONAL_DATA_UPDATE_RSP 应答更新个人资料
MSG_USER_CONFIG_UPDATE_REQ 请求更新网关配置
MSG_USER_CONFIG_UPDATE_RSP 应答更新网关配置
MSG_USER_CONFIG_QUERY_REQ 请求查询网关配置
MSG_USER_CONFIG_QUERY_RSP 应答查询网关配置
MSG_CHILD_USER_ADD_REQ 请求添加子用户
MSG_CHILD_USER_ADD_RSP 应答添加子用户
MSG_CHILD_USER_DEL_REQ 请求删除子用户
MSG_CHILD_USER_DEL_RSP 应答删除子用户
MSG_CHILD_USER_QUERY_REQ 请求查询子用户信息
MSG_CHILD_USER_QUERY_RSP 应答查询子用户信息
MSG_GATEWAY_ADD_REQ 请求添加网关
MSG_GATEWAY_ADD_RSP 应答添加网关
MSG_GATEWAY_DEL_REQ 请求删除网关
MSG_GATEWAY_DEL_RSP 应答删除网关
MSG_GATEWAY_QUERY_REQ 请求查询网关信息
MSG_GATEWAY_QUERY_RSP 应答查询网关信息
MSG_DEVICE_ADD_REQ 请求添加设备
MSG_DEVICE_ADD_RSP 应答添加设备
MSG_DEVICE_DEL_REQ 请求删除设备
MSG_DEVICE_DEL_RSP 应答删除设备
MSG_DEVICE_USER_ADD_REQ 请求添加设备用户
MSG_DEVICE_USER_ADD_RSP 应答添加设备用户
MSG_DEVICE_USER_DEL_REQ 请求删除设备用户
MSG_DEVICE_USER_DEL_RSP 应答删除设备用户
MSG_DEVICE_USER_SYNC_REQ 请求同步设备用户
MSG_DEVICE_USER_SYNC_RSP 应答同步设备用户
MSG_DEVICE_QUERY_REQ 请求查询设备信息
MSG_DEVICE_QUERY_RSP 应答查询设备信息
MSG_OPERATED_RECORD_ADD_REQ 请求添加操作记录
MSG_OPERATED_RECORD_ADD_RSP 应答添加操作记录
MSG_OPERATED_RECORD_DEL_REQ 请求删除操作记录
MSG_OPERATED_RECORD_DEL_RSP 应答删除操作记录
MSG_OPERATED_RECORD_QUERY_REQ 请求查询操作记录
MSG_OPERATED_RECORD_QUERY_RSP 应答查询操作记录
MSG_UNLOCK_RECORD_ADD_REQ 请求添加开锁记录
MSG_UNLOCK_RECORD_ADD_RSP 应答添加开锁记录
MSG_UNLOCK_RECORD_DEL_REQ 请求删除开锁记录
MSG_UNLOCK_RECORD_DEL_RSP 应答删除开锁记录
MSG_UNLOCK_RECORD_QUERY_REQ 请求查询开锁记录
MSG_UNLOCK_RECORD_QUERY_RSP 应答查询开锁记录
MSG_ALARM_DATA_ADD_REQ 请求添加报警数据
MSG_ALARM_DATA_ADD_RSP 应答添加报警数据
MSG_ALARM_DATA_DEL_REQ 请求删除报警数据
MSG_ALARM_DATA_DEL_RSP 应答删除报警数据
MSG_ALARM_DATA_QUERY_REQ 请求查询报警数据
MSG_ALARM_DATA_QUERY_RSP 应答查询报警数据
MSG_DISCOVER_DATA_GET_REQ 请求获取发现展示数据
MSG_DISCOVER_DATA_GET_RSP 应答获取发现展示数据
MSG_USER_FEEDBACK_REQ 请求用户意见反馈
MSG_USER_FEEDBACK_RSP 应答用户意见反馈
MSG_DEVICE_USER_MOD_REQ 请求修改设备用户别名
MSG_DEVICE_USER_MOD_RSP 应答修改设备用户别名
MSG_GATEWAY_DEVICE_CHANGEDFLAG_REQ 请求更新设备列表变动标识
MSG_GATEWAY_DEVICE_CHANGEDFLAG_RSP 应答更新设备列表变动标识
MSG_KEEPER_KEEPALIVE_REQ 请求机器人小管家保活
MSG_KEEPER_KEEPALIVE_RSP 应答机器人小管家保活
MSG_CHILD_USER_LIST_QUERY_REQ 请求授权用户列表
MSG_CHILD_USER_LIST_QUERY_RSP 应答授权用户列表
MSG_DEVICE_ACTIVE_STATE_QUERY_REQ 请求获取锁激活状态
MSG_DEVICE_ACTIVE_STATE_QUERY_RSP 应答获取锁激活状态
MSG_DOORMACHINE_REMOTE_OPEN_REQ 请求门口机开门
MSG_DOORMACHINE_REMOTE_OPEN_RSP 应答门口机开门
MSG_GET_UNREAD_NUMBER_REQ 请求获取未读消息记录
MSG_GET_UNREAD_NUMBER_RSP 应答获取未读消息记录
MSG_MARK_READ_RECORD_REQ 请求标记已读
MSG_MARK_READ_RECORD_RSP 应答标记已读
MSG_UPLOAD_HUAWEI_PUSH_TOKEN_REQ 请求华为APPtoken上传
MSG_UPLOAD_HUAWEI_PUSH_TOKEN_RSP 应答华为APPtoken上传
MSG_SCENE_CONFIG_UPDATE_REQ 请求更新场景配置
MSG_SCENE_CONFIG_UPDATE_RSP 应答更新场景配置
MSG_SCENE_CONFIG_QUERY_REQ 请求查询场景配置
MSG_SCENE_CONFIG_QUERY_RSP 应答查询场景配置
MSG_ROBOT_GET_LOGIN_CODE_REQ 请求小管家robot获取扫描登陆的二维码
MSG_ROBOT_GET_LOGIN_CODE_RSP 应答小管家robot获取扫描登陆的二维码
MSG_SCAN_CONFIRM_ROBOT_LOGIN_REQ 请求扫码确认小管家robot登陆
MSG_SCAN_CONFIRM_ROBOT_LOGIN_RSP 应答扫码确认小管家robot登陆
MSG_GET_SCAN_CONFIRM_LOGIN_STATUS_REQ 请求小管家robot获取登陆状态
MSG_GET_SCAN_CONFIRM_LOGIN_STATUS_RSP 应答小管家robot获取登陆状态
MSG_TV_CONFIG_UPDATE_REQ 请求更新红外宝电视频道配置
MSG_TV_CONFIG_UPDATE_RSP 应答更新红外宝电视频道配置
MSG_GET_LOCAL_TV_CHANNEL_REQ 请求查询电视频道
MSG_GET_LOCAL_TV_CHANNEL_RSP 应答查询电视频道
MSG_GET_LOCAL_TV_CHANNEL_REQ 请求查询电视频道
MSG_GET_LOCAL_TV_CHANNEL_RSP 应答查询电视频道
MSG_SWITCH_GATEWAY_REQ 请求APP端切换网关
MSG_SWITCH_GATEWAY_RSP 应答APP端切换网关
MSG_ALARM_CLOCK_ADD_REQ 请求添加闹钟
MSG_ALARM_CLOCK_ADD_RSP 应答添加闹钟
MSG_ALARM_CLOCK_DEL_REQ 请求删除闹钟
MSG_ALARM_CLOCK_DEL_RSP 应答删除闹钟
MSG_ALARM_CLOCK_QUERY_REQ 请求查询闹钟
MSG_ALARM_CLOCK_QUERY_RSP 应答查询闹钟
MSG_ALARM_CLOCK_UPDATE_REQ 请求修改闹钟
MSG_ALARM_CLOCK_UPDATE_RSP 应答修改闹钟
MSG_GET_WEATHER_REQ 请求查询天气
MSG_GET_WEATHER_RSP 应答查询天气
MSG_ALARM_CLOCK_STOP_REQ 请求停止闹钟
MSG_ALARM_CLOCK_STOP_RSP 应答停止闹钟
MSG_ROBOT_INSTRUCT_CONFIG_UPDATE_REQ 请求小管家机器人指令配置更新
MSG_ROBOT_INSTRUCT_CONFIG_UPDATE_RSP 应答小管家机器人指令配置更新

5. 协议详解

每条协议都包含请求应答示例、请求参数说明、应答参数说明三个部分

5.1 短信验证码

  • 请求应答示例

MSG_SMS_CODE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SMS_CODE_REQ",
            "seq_id": "1"
        },
        "body": {
            "global_roaming": "0086",
            "username": "18888888888"
        }
    }
}

MSG_SMS_CODE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SMS_CODE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "public_key": "xxxxxx"
        }
    }
}
参数 选项 说明 备注
global_roaming 必填 国际区号 国际电话区号表
username 必填 用户名 必须为11位手机号
参数 说明 备注
public_key 公钥 加密用的公钥

5.2 注册用户

  • 请求应答示例

注意:需要使用应答包里的标准HTTP头Set-Cookie字段

MSG_USER_REG_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_REG_REQ",
            "seq_id": "1"
        },
        "body": {
            "global_roaming": "0086",
            "user_alias": "xxxxxxx",
            "username": "18888888888",
            "password": "xxxxxxxxxx",
            "sms_code": "666666",
            "phone": {
                "uuid": "xxxxxxxxxx",
                "endpoint_type": "OPPO R9s",
                "platform": "android",
                "platform_version": "4.3",
                "network_type": "3G"
            }
        }
    }
}

MSG_USER_REG_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_REG_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
global_roaming 必填 国际区号 国际电话区号表
user_alias 可选 用户别名 当前用户的别名
username 必填 用户名 必须为11位手机号
password 必填 密码 经过加密的用户密码
sms_code 必填 短信验证码 通过接口获取的短信验证码
phone:uuid 可选 手机序列号 手机唯一标识码
phone:endpoint_type 可选 终端设备类型 终端设备的类型
phone:platform 可选 手机系统 公共参数
phone:platform_version 可选 手机系统版本 具体系统的版本
phone:network_type 可选 手机网络类型 具体的网络类型

5.3 删除用户

  • 请求应答示例

MSG_USER_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "type": "WonlyBtLock"
        }
    }
}

MSG_USER_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
  • 请求参数说明

    headerHTTP API 公共包头

    body主要是具体协议的内容,见下表

  • 参数 选项 说明 备注
    type 可选 爱感蓝牙锁 WonlyBtLock (爱感蓝牙锁)robot (机器人)
  • 应答参数说明

    headerHTTP API 公共包头

    body 没有body

5.4 用户登录

  • 请求应答示例

注意:需要使用应答包里的标准HTTP头Set-Cookie字段

MSG_USER_LOGIN_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_LOGIN_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "18888888888",
            "password": "xxxxxxxxx",
            "sms_code": "666666",
            "type": "robot",
            "phone": {
                "uuid": "xxxxxxxxxx",
                "endpoint_type": "OPPO R9s",
                "platform": "android",
                "platform_version": "4.3",
                "network_type": "3G"
            }
        }
    }
}

MSG_USER_LOGIN_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_LOGIN_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "secret_key": "xxxxxxxxx",
            "user_alias": "xxxxxxx",
            "father_username": "xxxxxxxxx",
            "gateway_list": [
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxxxx"
                },
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxxxx"
                }
            ],
            "child_user_list": [
                {
                    "username": "xxxxxxx",
                    "user_alias": "老婆"
                },
                {
                    "username": "xxxxxxx",
                    "user_alias": "女儿"
                }
            ],
            "slideshow": [
                "https://download.wonlycloud.com/slideshow/banner1.png",
                "https://download.wonlycloud.com/slideshow/banner2.png",
                "https://download.wonlycloud.com/slideshow/banner3.png"
            ]
        }
    }
}
参数 选项 说明 备注
username 必填 用户名 必须为11位手机号
password 必填 密码 经过加密的用户密码
sms_code 可选 短信验证码 通过接口获取的短信验证码
type 可选 APP设备类型 机器人小管家标识:robot (机器人)
phone:uuid 可选 手机序列号 手机唯一标识码
phone:endpoint_type 可选 终端设备类型 终端设备的类型
phone:platform 可选 手机系统 公共参数
phone:platform_version 可选 手机系统版本 具体系统的版本
phone:network_type 可选 手机网络类型 具体的网络类型
参数 说明 备注
secret_key 用户密钥 用于申请Token
user_alias 用户别名 当前账户的别名
father_username 父用户 当前账户的父账户
gateway_list:vendor_name 网关供应商名 公共参数
gateway_list:uuid 网关序列号 网关唯一标识码
gateway_list:username 网关用户名 登录网关时所用用户名
gateway_list:password 网关密码 登录网关所用密码
gateway_list:authorization 网关权限 admin user
gateway_list:note 网关别名 网关的别名,用于显示在界面上
gateway_list:version 网关版本 网关的版本信息
child_user_list:username 网关用户名 登录网关时所用用户名
child_user_list:user_alias 子用户昵称 子用户的昵称
slideshow 轮播图 轮播图的地址

5.5 用户注销

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_USER_LOGOUT_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_LOGOUT_REQ",
            "seq_id": "1"
        },
        "body": {
            "type": "robot"
        }
    }
}

MSG_USER_LOGOUT_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_LOGOUT_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
  • 请求参数说明

    headerHTTP API 公共包头

    body 主要是具体协议的内容(机器人加填body)

参数 选项 说明 备注
type 可选 机器人类型 机器人类型:robot

5.6 修改密码

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_PASSWD_CHANGE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PASSWD_CHANGE_REQ",
            "seq_id": "1"
        },
        "body": {
            "password": "xxxxxxxxx",
            "new_password": "yyyyyyy"
        }
    }
}

MSG_PASSWD_CHANGE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PASSWD_CHANGE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
password 必填 用户密码 用户当前的密码
new_password 必填 新的用户密码 新的用户密码

5.7 忘记密码

  • 请求应答示例

MSG_PASSWD_FORGET_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PASSWD_FORGET_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "18888888888",
            "new_password": "yyyyyyy",
            "sms_code": "666666"
        }
    }
}

MSG_PASSWD_FORGET_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PASSWD_FORGET_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
username 必填 用户名 必须为11位手机号
new_password 必填 新的用户密码 新的用户密码
sms_code 必填 短信验证码 通过接口获取的短信验证码

5.8 更新个人资料

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_PERSONAL_DATA_UPDATE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PERSONAL_DATA_UPDATE_REQ",
            "seq_id": "1"
        },
        "body": {
            "safe_update": "true",
            "password": "xxxxxxxx",
            "new_alias": "王力小王子",
            "new_username": "xxxxxx",
            "new_sms_code": "666666"
        }
    }
}

MSG_PERSONAL_DATA_UPDATE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_PERSONAL_DATA_UPDATE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
safe_update 必填 是否安全更新用户信息 true false
password 可选 当前用户密码 在safe_update参数为true的情况下变为必填
new_alias 可选 新用户别名 新的用户别名
new_username 可选 新用户名 新的用户名
new_sms_code 可选 新用户短信验证码 新用户手机接收到的短信验证码,在new_username不为空的时候变为必填

5.9 更新网关配置

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_USER_CONFIG_UPDATE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_CONFIG_UPDATE_REQ",
            "seq_id": "1"
        },
        "body": {
            "isfull": "true",
            "gateway_vendor_name": "feibee",
            "gateway_uuid": "xxxxxxxxxx",
            "type":"robot"
            "device_list": [
                {
                    "operation": "modify",
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "猫眼",
                    "note": "设设的设备"
                },
                {
                    "operation": "add",
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "门锁",
                    "note": "备备的设备"
                }
            ],
            "scene_list": [
                {
                    "operation": "modify",
                    "rule_note":"xxxxx",
                    "scene_switch":"xxxxx",
                    "uuid": "xxxxx",
                    "note": "回家"
                },
                {
                    "operation": "delete",
                    "rule_note":"xxxxx",
                    "scene_switch":"xxxxx",
                    "uuid": "xxxxx",
                    "note": "上班"
                }
            ]
        }
    }
}

MSG_USER_CONFIG_UPDATE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_CONFIG_UPDATE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
isfull 必填 是否全部覆盖 true false
*:operation 可选 具体的更新操作 add delete modify 在isfull参数为false的情况下生效
gateway_vendor_name 必填 网关供应商名 公共参数, 在operation为add的情况下为必填
gateway_uuid 必填 网关序列号 网关唯一标识码, 在operation为add的情况下为必填
type 可选 机器人类型 机器人必填,robot (机器人)
device_list:vendor_name 必填 常用设备供应商 常用设备的供应商, 在operation为add的情况下为必填
device_list:uuid 必填 常用设备序列号 常用设备的序列号, 在operation为add的情况下为必填
device_list:type 必填 常用设备类型 常用设备的类型, 在operation为add的情况下为必填
device_list:note 可选 常用设备别名 常用设备的别名
scene_list:rule_note 必填 规则别名 常用场景的规则别名
scene_list:scene_switch 必填 场景触发开关 场景触发开关,开门:unlock,客流减少(针对展厅平板镶嵌):fewPeople
scene_list:uuid 必填 常用场景序列号 常用场景的序列号, 在operation为add的情况下为必填
scene_list:note 可选 常用场景别名 常用场景的别名

5.10 查询网关配置

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_USER_CONFIG_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_CONFIG_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "gateway_vendor_name": "feibee",
            "gateway_uuid": "xxxxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_USER_CONFIG_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_CONFIG_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "slideshow": [
                "https://download.wonlycloud.com/slideshow/banner1.png",
                "https://download.wonlycloud.com/slideshow/banner2.png",
                "https://download.wonlycloud.com/slideshow/banner3.png"
            ],
            "device_list": [
                "device_list": [
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "门锁",
                    "username": "xxxxxxx",
                    "password": "xxxxxxx",
                    "room_id": "xxxxx",
                    "room_name": "卧室",
                    "note": "备备的设备",
                    "context_vendor_name": "feibee",
                    "context_uuid": "xxxxxxx",
                    "authorize_code": "xxxxxxx",
                    "secretkey": "xxxxxxx",
                    "room_no":"1-1-1-15-3",
                    "online_state":1,
                    "unread_num":20,
                    "unread_unlock_num":10,
                    "unread_alarm_num":10,
                    "capability":25
                },
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "门锁",
                    "username": "xxxxxxx",
                    "password": "xxxxxxx",
                    "room_id": "xxxxx",
                    "room_name": "卧室",
                    "note": "备备的设备",
                    "context_vendor_name": "feibee",
                    "context_uuid": "xxxxxxx",
                    "authorize_code": "xxxxxxx",
                    "secretkey": "xxxxxxx",
                    "room_no":"1-1-1-15-3",
                    "online_state":1,
                    "unread_num":20,
                    "unread_unlock_num":10,
                    "unread_alarm_num":10,
                    "capability":35
                }
            ],
            "scene_list": [
                {
                    "rule_note":"xxxxx",
                    "scene_switch":"xxxxx",
                    "uuid": "xxxxx",
                    "note": "回家"
                },
                {
                    "rule_note":"xxxxx",
                    "scene_switch":"xxxxx",
                    "uuid": "xxxxx",
                    "note": "上班"
                }
            ]
        }
    }
}
参数 选项 说明 备注
gateway_vendor_name 必填 网关供应商名 公共参数
gateway_uuid 必填 网关序列号 网关唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
参数 说明 备注
slideshow 轮播图 轮播图的地址
device_list:vendor_name 设备供应商 设备的提供商,见公共参数->vendor_name
device_list:uuid 设备序列号 设备唯一标识码
device_list:type 设备类型 设备的类型,比如猫眼、锁等,见公共参数->device_type
device_list:username 设备用户名 设备登录所需用户名
device_list:password 设备密码 设备登录所需密码
device_list:room_id 房间ID 设备所属的房间区域ID
device_list:room_name 房间区域 设备所属的房间区域信息
device_list:note 设备别名 设备的别名
device_list:context_vendor_name 设备供应商 设备的提供商
device_list:context_uuid 设备的上下文设备ID 比如猫眼会关联一个门锁,此处则为门锁的UUID
device_list:authorize_code 授权码 爱感蓝牙锁授权码
device_list:secretkey 密钥 爱感蓝牙锁密钥
device_list:room_no 门口机设备相关的房间号 房间号格式:1-1-1-15-3,解释:1区-1栋-1单元-15楼-3号房间,说明:小区分区-楼栋号-单元号-楼层号-房间号
device_list:online_state NB锁在线状态 0-离线,大于0-在线
device_list:unread_num NB锁消息未读数 NB锁消息未读数
device_list:unread_unlock_num NB锁开门消息未读数 NB锁开门消息未读数
device_list:unread_alarm_num NB锁报警消息未读数 NB锁报警消息未读数
device_list:capability 设备功能集 设备功能集
scene_list:rule_note 规则别名 常用场景的规则别名
scene_list:scene_switch 场景触发开关 场景触发开关,开门:unlock,客流减少(针对展厅平板镶嵌):fewPeople
scene_list:uuid 常用场景序列号 常用场景的序列号
scene_list:note 常用场景别名 常用场景的别名

5.11 添加子用户

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_CHILD_USER_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "global_roaming": "0086",
            "username": "18888888888",
            "password": "xxxxxxx",
            "sms_code": "666666",
            "user_alias": "老婆",
            "type":"WonlyBtLock",
            "gateway_list": [
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxx"
                },
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxx"
                }
            ],
            "device_list": [
                {
                    "vendor_name":"general",
                    "uuid": "XXXXXXXX",
                    "permissions": "2"
                },
                {
                    "vendor_name":"general",
                    "uuid": "XXXXXXXX",
                    "permissions": "2"
                }
            ]
        }
    }
}

MSG_CHILD_USER_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
global_roaming 必填 子用户国际区号 国际电话区号表
username 必填 子用户名 必须为11位手机号
password 可选 子用户密码 新增为必填,经过加密的用户密码
sms_code 必填 子用户短信验证码 通过接口获取的短信验证码
user_alias 可选 子用户昵称 子用户的昵称
type 可选 设备类型 爱感蓝牙锁必选,机器人必选,设备的类型,见1.1 公共参数,飞比的使用device_id字段,WonlyVideoLock (视频锁) WonlySmartEye (猫眼) WonlySmartAirer (晾霸) WonlyBtLock (爱感蓝牙锁)robot (机器人)
gateway_list:vendor_name 必填 网关供应商名 公共参数
gateway_list:uuid 必填 网关序列号 网关唯一标识码,(爱感蓝牙锁,则填要添加的子用户名(虚拟网关))
gateway_list:username 必填 网关用户名 登录网关时所用用户名,(爱感蓝牙锁,则填要添加的子用户名(虚拟网关))
gateway_list:password 必填 网关密码 登录网关所用密码
gateway_list:authorization 必填 网关权限 admin user
gateway_list:note 可选 网关别名 网关的别名,用于显示在界面上
gateway_list:version 可选 网关版本 网关的版本信息
device_list:vendor_name 可选(爱感蓝牙锁必选) 蓝牙锁厂家 蓝牙锁厂家
device_list:uuid 可选(爱感蓝牙锁必选) 蓝牙锁MAC 蓝牙锁
device_list:permissions 可选(爱感蓝牙锁必选) 子用户对该设备的权限 0-超级管理,1-管理员(管理蓝牙锁用户),2-普通用户(开锁)

5.12 删除子用户

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_CHILD_USER_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "xxxxxxxx",
            "vendor_name": "general",
            "uuid": "xxxxxxxxxx",
            "type": "WonlyBtLock"
        }
    }
}

MSG_CHILD_USER_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
username 必填 子用户名 必须为11位手机号
vendor_name 可选,爱感蓝牙锁必选 设备供应商 设备的提供商见公共参数
uuid 可选 设备序列号,爱感蓝牙锁必选 设备唯一标识码,有些设备是IEEE编号
type 可选 设备类型,爱感蓝牙锁必选 1.1 公共参数,设备类型:WonlyBtLock (爱感蓝牙锁),机器人必填,robot (机器人)

5.13 查询子用户信息

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_CHILD_USER_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "username": "xxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_CHILD_USER_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "father_username": "xxxxxxxxx",
            "user_alias": "老婆",
            "gateway_list": [
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxx"
                },
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxx"
                }
            ]
        }
    }
}
参数 选项 说明 备注
username 必填 子用户名 必须为11位手机号
type 可选 机器人类型 机器人必填,robot (机器人)
参数 说明 备注
father_username 父用户 当前账户的父账户
user_alias 子用户昵称 子用户的昵称
gateway_list:vendor_name 网关供应商名 公共参数
gateway_list:uuid 网关序列号 网关唯一标识码
gateway_list:username 网关用户名 登录网关时所用用户名
gateway_list:password 网关密码 登录网关所用密码
gateway_list:authorization 网关权限 admin user
gateway_list:note 网关别名 网关的别名,用于显示在界面上
gateway_list:version 网关版本 网关的版本信息

5.14 添加网关

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_GATEWAY_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "username": "xxxxxxxxx",
            "password": "xxxxxxxxx",
            "authorization": "admin",
            "note": "网网的网关",
            "version": "xxx",
            "type": "WonlyBtLock",
            "location": {
                "longitude": "xxxx",
                "latitude": "xxxx",
                "highly": "xxxx",
                "countries": "xxxx",
                "province": "xxxx",
                "city": "xxxx",
                "partition": "xxxx",
                "street": "xxxx"
            },
            "ispush_msgnoti":1
        }
    }
}

MSG_GATEWAY_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 网关供应商名 公共参数
uuid 必填 网关序列号 网关唯一标识码
username 必填 网关用户名 登录网关时所用用户名
password 必填 网关密码 登录网关所用密码
authorization 必填 网关权限 admin user
note 可选 网关别名 网关的别名,用于显示在界面上
version 可选 网关版本 网关的版本信息
type 可选 蓝牙锁必选,机器人必填 WonlyBtLockrobot (机器人)
location:longitude 可选 网关所处的经度 网关所处的经度
location:latitude 可选 网关所处的纬度 网关所处的纬度
location:highly 可选 网关所处的高度 网关所处的高度
location:countries 可选 网关所处的国家 网关所处的国家
location:province 可选 网关所处的省/州 网关所处的省/州
location:city 可选 网关所处的市 网关所处的市
location:partition 可选 网关所处的区 网关所处的区
location:street 可选 网关所处的街道 网关所处的街道
ispush_msgnoti 可选 推送选项 推送选项:0-推送notification,1-推送message

5.15 删除网关

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_GATEWAY_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_GATEWAY_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 网关供应商名 公共参数
uuid 必填 网关序列号 网关唯一标识码

5.16 查询网关信息

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_GATEWAY_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot",
            "device": {
                 "vendor_name": ["ys7","general"]
            }
        }
    }
}

MSG_GATEWAY_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "username": "xxxxxxxxx",
            "password": "xxxxxxxxx",
            "authorization": "admin",
            "note": "网网的网关",
            "version": "xxx",
            "device_has_changed": "true",
            "ispush_msgnoti":1,
            "location": {
                "longitude": "xxxx",
                "latitude": "xxxx",
                "highly": "xxxx",
                "countries": "xxxx",
                "province": "xxxx",
                "city": "xxxx",
                "partition": "xxxx",
                "street": "xxxx"
            },
            "device_list": [
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "门锁",
                    "username": "xxxxxxx",
                    "password": "xxxxxxx",
                    "room_id": "xxxxx",
                    "room_name": "卧室",
                    "note": "备备的设备",
                    "context_vendor_name": "feibee",
                    "context_uuid": "xxxxxxx",
                    "authorize_code": "xxxxxxx",
                    "secretkey": "xxxxxxx",
                    "room_no":"1-1-1-15-3",
                    "online_state":1,
                    "unread_num":20,
                    "unread_unlock_num":10,
                    "unread_alarm_num":10,
                    "capability":25
                },
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "门锁",
                    "username": "xxxxxxx",
                    "password": "xxxxxxx",
                    "room_id": "xxxxx",
                    "room_name": "卧室",
                    "note": "备备的设备",
                    "context_vendor_name": "feibee",
                    "context_uuid": "xxxxxxx",
                    "authorize_code": "xxxxxxx",
                    "secretkey": "xxxxxxx",
                    "room_no":"1-1-1-15-3",
                    "online_state":1,
                    "unread_num":20,
                    "unread_unlock_num":10,
                    "unread_alarm_num":10,
                    "capability":35
                }
            ]
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 网关供应商名 公共参数
uuid 必填 网关序列号 网关唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
device:vendor_name 选填 设备供应商名,可传数组 公共参数,小管家获取指定设备。
参数 说明 备注
username 网关用户名 登录网关时所用用户名
password 网关密码 登录网关所用密码
authorization 网关权限 admin user
note 网关别名 网关的别名,用于显示在界面上
version 网关版本 网关的版本信息
device_has_changed 设备变动标识 设备变动标识,true:表示变动过,false: 或该字段没有则没有变动过。
ispush_msgnoti 推送选项 推送选项:0-推送notification,1-推送message
location:longitude 网关所处的经度 网关所处的经度
location:latitude 网关所处的纬度 网关所处的纬度
location:highly 网关所处的高度 网关所处的高度
location:countries 网关所处的国家 网关所处的国家
location:province 网关所处的省/州 网关所处的省/州
location:city 网关所处的市 网关所处的市
location:partition 网关所处的区 网关所处的区
location:street 网关所处的街道 网关所处的街道
device_list:vendor_name 设备供应商 设备的提供商,见公共参数->vendor_name
device_list:uuid 设备序列号 设备唯一标识码
device_list:type 设备类型 设备的类型,比如猫眼、锁等,见公共参数->device_type
device_list:username 设备用户名 设备登录所需用户名
device_list:password 设备密码 设备登录所需密码
device_list:room_id 房间ID 设备所属的房间区域ID
device_list:room_name 房间区域 设备所属的房间区域信息
device_list:note 设备别名 设备的别名
device_list:context_vendor_name 设备供应商 设备的提供商
device_list:context_uuid 设备的上下文设备ID 比如猫眼会关联一个门锁,此处则为门锁的UUID
device_list:authorize_code 授权码 爱感蓝牙锁授权码
device_list:secretkey 密钥 爱感蓝牙锁密钥
device_list:room_no 门口机设备相关的房间号 房间号格式:1-1-1-15-3,解释:1区-1栋-1单元-15楼-3号房间,说明:小区分区-楼栋号-单元号-楼层号-房间号
device_list:online_state NB锁在线状态 0-离线,大于0-在线
device_list:unread_num NB锁消息未读数 NB锁消息未读数
device_list:unread_unlock_num NB锁开门消息未读数 NB锁开门消息未读数
device_list:unread_alarm_num NB锁报警消息未读数 NB锁报警消息未读数
device_list:capability 设备功能集 设备功能集

5.17 添加设备

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "gateway_vendor_name": "feibee",
            "gateway_uuid": "xxxxxxxxxx",
            "type":"robot"
            "device": {
                "vendor_name": "feibee",
                "uuid": "xxxxxxxxxx",
                "type": "1001",
                "random": "XXXXXX",
                "username": "xxxxxxx",
                "password": "xxxxxxx",
                "room_id": "xxxxx",
                "room_name": "卧室",
                "note": "备备的设备",
                "version": "xxxxx",
                "context_vendor_name": "feibee",
                "context_uuid": "xxxxxxx",
                "short_id": "123123",
                "dev_model": "Z501",
                "dev_id": "xxxxxxx",
                "authorize_code": "xxxxxxx",
                "secretkey": "XXXXXXXXXXXX",
                "volume_level": "xxxxxxx",
                "open_mode": "xxxxxxx",
                "passwd_switch": "xxxxxxx",
                "remote_switch": "xxxxxxx",
                "hidden_mode": "XXXX",
                "q_battery":66,
                "timestamp": "xxxxxxxxx",
                "permissions": "0",
                "is_push":1,
                "room_no":"1-1-1-15-3",
                "tel_no": "13838383388",
                "alarm_type": "noatmpt,forced_break",
                "air_switch":"1",
                "air_mode":"xxxxx",
                "air_temp":"xxxxx",
                "air_wind":"xxxxx",
                "air_wind_direct":"xxxxx",
                "detail_type":"PSG-6021"
            }
        }
    }
}

MSG_DEVICE_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
gateway_vendor_name 必填 网关供应商名 公共参数
gateway_uuid 必填 网关序列号 网关唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
device:vendor_name 必填 设备供应商 设备的提供商见公共参数
device:uuid 必填 设备序列号 设备唯一标识码,有些设备是IEEE编号,红外宝uuid:红外宝根据设备类型不一样uuid加上后缀,电视机:uuid_tv,空调:uuid_air
device:type 必填 设备类型 设备的类型,见1.1 公共参数,飞比的使用device_id字段,WonlyVideoLock (视频锁) WonlySmartEye (猫眼) WonlySmartAirer (晾霸) WonlyBtLock (爱感蓝牙锁) WonlySmartEyeYs7 (萤石智能猫眼)WonlyNBLock (王力NB锁)WonlyCameraYs7 (萤石摄像头) WonlyDoorMachine (萤石门口机) WonlyTV (电视机)WonlyAirConditioner (空调)
device:random 可选 设备标识码 设备的标识码,唯一的。萤石设备(ys7)的校验码。
device:username 可选 设备用户名 设备登录所需用户名
device:password 可选 设备密码 设备登录所需密码
device:room_id 可选 房间ID 设备所属的房间区域ID
device:room_name 可选 房间区域 设备所属的房间区域信息
device:note 可选 设备别名 设备的别名
device:version 可选(蓝牙锁必选) 设备版本 设备的版本信息,如果是general的设备为必填,爱感蓝牙锁也需要
device:context_vendor_name 可选 设备供应商 设备的提供商
device:context_uuid 可选 设备的上下文设备ID 比如猫眼会关联一个门锁,此处则为门锁的UUID
device:short_id 可选 设备短ID 短ID,有些设备是UUID编号
device:dev_model 可选 设备型号 设备型号
device:dev_id 可选(蓝牙锁必选) 设备串码 设备串码,爱感蓝牙锁也需要
device:authorize_code 可选(蓝牙锁必选) 授权码 第一次绑定蓝牙锁,提交授权码到服务器
device:secretkey 可选(蓝牙锁必选) 密钥 密钥
device:volume_level 可选(蓝牙锁必选) 音量等级 蓝牙门锁音量等级
device:open_mode 可选(蓝牙锁必选) 常开模式 蓝牙门锁常开模式
device:passwd_switch 可选(蓝牙锁必选) 密码开关 蓝牙门锁密码开关
device:remote_switch 可选(蓝牙锁必选) 远程开关 蓝牙门锁远程开关
device:hidden_mode 可选(蓝牙锁必选) 隐藏模式 蓝牙门锁,隐藏模式
device:q_battery 可选(蓝牙锁必选) 电量 蓝牙门锁电池电量百分比
device:timestamp 可选(蓝牙锁必选) 时间戳 蓝牙门锁时间戳
device:permissions 可选(蓝牙锁必选) 权限 0-超级管理,1-管理员(管理蓝牙锁用户),2-普通用户(开锁)
device:is_push 可选 推送开关 萤石设备推送开关,0-推送,1-关闭推送
device:room_no 可选 门口机设备相关的房间号 房间号格式:1-1-1-15-3,解释:1区-1栋-1单元-15楼-3号房间,说明:小区分区-楼栋号-单元号-楼层号-房间号
device:tel_no 可选 告警语音通知的电话号码 告警语音通知的电话号码
device:alarm_type 可选 哪些告警需要语音通知给用户 告警类型字符串,选择了多个告警,用逗号","隔开,noatmpt (非法操作),forced_break (强拆报警), fakelock (假锁),nolock (门未关),batt (低电量), infra (红外感应)
device:air_switch 可选 空调开关 空调开关,0-关闭,1-打开
device:air_mode 可选 空调模式 空调模式
device:air_temp 可选 空调温度 空调温度
device:air_wind 可选 空调风速 空调风速
device:air_wind_direct 可选 空调风向 空调风向
device:detail_type 可选 设备详细类型 设备详细类型

5.18 删除设备

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "gateway_vendor_name": "feibee",
            "gateway_uuid": "xxxxxxxxxx",
            "type":"robot"
            "device": {
                "vendor_name": "feibee",
                "uuid": "xxxxxxxxxx",
                "type": "WonlyNBLock",
                "dev_id": "xxxxxxx",
                "reset": "1"
            }
        }
    }
}

MSG_DEVICE_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
gateway_vendor_name 必填 网关供应商 网关的供应商
gateway_uuid 必填 网关序列号 网关唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
device:vendor_name 必填 设备供应商 设备的供应商
device:uuid 必填 设备序列号 设备唯一标识码
device:type 可选 设备类型 1.1 公共参数,王力NB锁(WonlyNBLock),必填
device:dev_id 可选 设备序列号 王力NB锁(WonlyNBLock),必填
device:reset 可选 重置设备 爱感蓝牙锁重置,reset=1,操作记录清空

5.19 添加设备用户

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_USER_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "general",
            "type" : "WonlyBtLock",
            "uuid": "xxxxxxxxxx",
            "device_user_version" : "1000",
            "device_user": {
                "id": "001",
                "note": "保姆",
                "unlock_maintype" : "01",
                "unlock_subtype" : "00",
                "without_notice_user_list": [
                    "18888888888",
                    "16666666666"
                ]
            }
        }
    }
}

MSG_DEVICE_USER_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
type 可选(爱感蓝牙锁必填) 爱感蓝牙锁 爱感蓝牙锁:WonlyBtLock,机器人必填,robot (机器人)
uuid 必填 设备序列号 设备唯一标识码
device_user_version 可选(爱感蓝牙锁必填) 版本号 蓝牙锁用户版本号
device_user:id 必填 设备用户id 设备用户的id
device_user:note 可选(爱感蓝牙锁必填) 设备用户别名 设备用户的别名
device_user:unlock_maintype 可选(爱感蓝牙锁必填) 开锁方式主代号 密码-1,指纹-2,刷卡-3等等
device_user:unlock_subtype 可选(爱感蓝牙锁必填) 开锁方式次代号 (0:正常密码,1:胁迫密码等)
device_user:without_notice_user_list 可选 无需通知的用户名 不需要通知的用户名

5.20 删除设备用户

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_USER_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "type" : "WonlyBtLock",
            "uuid": "xxxxxxxxxx",
            "device_user_version" : "1000",
            "device_user": {
                "id": "001",
                "unlock_maintype": "01",
                "unlock_subtype": "00"
            }
        }
    }
}

MSG_DEVICE_USER_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
type 可选(爱感蓝牙锁必填) 爱感蓝牙锁 爱感蓝牙锁WonlyBtLock,机器人必填,robot (机器人)
uuid 必填 设备序列号 设备唯一标识码
device_user_version 可选(爱感蓝牙锁必填) 版本号 蓝牙锁用户版本号
device_user:id 必填 设备用户id 设备用户的id
device_user:unlock_maintype 可选(爱感蓝牙锁必填) 开锁方式主代号 开锁方式主代号(密码-1,指纹-2,刷卡-3等等),删除是按一组全删除的方式,如果是00则是删除该用户
device_user:unlock_subtype 可选(爱感蓝牙锁必填) 开锁方式次代号 开锁方式次代号,00,01

5.21 同步设备用户

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_USER_SYNC_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_SYNC_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "general",
            "type" : "WonlyBtLock",
            "uuid": "xxxxxxxxxx",
            "device_user_version" : "1000",
            "device_user_list": [
            {
                "id": "20181010",
                "note": "何工",
                "unlock_type_list": [
                    {
                        "unlock_maintype": "01",
                        "main_list": [
                            {
                                "unlock_subtype": "00",
                                "sub_num": 02
                            },
                            {
                                "unlock_subtype": "01",
                                "sub_num": 01
                            }
                        ]
                    },
                    {
                        "unlock_maintype": "02",
                        "main_list": [
                            {
                                "unlock_subtype": "00",
                                "sub_num": 02
                            },
                            {
                                "unlock_subtype": "01",
                                "sub_num": 01
                            }
                        ]
                    }
                ]
            },
            {
                "id": "20181011",
                "note": "赵工",
                "unlock_type_list": [
                    {
                        "unlock_maintype": "01",
                        "main_list": [
                            {
                                "unlock_subtype": "00",
                                "sub_num": 2
                            },
                            {
                                "unlock_subtype": "01",
                                "sub_num": 01
                            }
                        ]
                    },
                    {
                        "unlock_maintype": "02",
                        "main_list": [
                            {
                                "unlock_subtype": "00",
                                "sub_num": 2
                            },
                            {
                                "unlock_subtype": "01",
                                "sub_num": 1
                            }
                        ]
                    }
                ]
            }
        ]
        }
    }
}

MSG_DEVICE_USER_SYNC_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_SYNC_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
type 必填 爱感蓝牙锁 爱感蓝牙锁(WonlyBtLock),机器人必填,robot (机器人)
uuid 必填 设备序列号 设备唯一标识码
device_user_version 必填 版本号 蓝牙锁用户版本号
device_user_list:id 可选 设备用户的id 设备用户id
device_user_list:note 可选 设备用户的别名 设备用户别名
device_user_list:unlock_type_list:unlock_maintype 可选 开锁方式主代号,密码-1,指纹-2,刷卡-3等等 爱感蓝牙锁特有
device_user_list:
unlock_type_list:
unlock_maintype:
main_list:
unlock_subtype
可选 开锁方式次代号,0:正常密码,1:胁迫密码等 爱感蓝牙锁特有
device_user_list:
unlock_type_list:
unlock_maintype:
main_list:
sub_num
可选 开锁方式次代号数量 爱感蓝牙锁特有

5.22 查询设备信息

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "short_id": "123123",
            "type":"robot"
        }
    }
}

MSG_DEVICE_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "type": "1001",
            "username": "xxxxxxx",
            "password": "xxxxxxx",
            "room_area": "卧室",
            "note": "备备的设备",
            "version": "xxxxx",
            "context_vendor_name": "feibee",
            "context_uuid": "Z103",
            "device_user_version" : "1000",
            "device_user_list": [
                {
                    "id": "001",
                    "note": "设设的设备",
                    "without_notice_user_list": [
                        "18888888888",
                        "16666666666"
                    ],
                    "level": "adm",
                    "unlock_type_list": [
                    {
                        "unlock_maintype": "01",
                        "main_list": [
                            {
                                "unlock_subtype": "00",
                                "sub_num": 2
                            },
                            {
                                "unlock_subtype": "01",
                                "sub_num": 1
                            }
                        ]
                    },
                    {
                        "unlock_maintype": "02",
                        "main_list": [
                            {
                                "unlock_subtype": "00",
                                "sub_num": 2
                            },
                            {
                                "unlock_subtype": "01",
                                "sub_num": 01
                            }
                        ]
                    }
                ]
                },
                {
                    "id": "002",
                    "note": "备备的设备",
                    "without_notice_user_list": [
                        "18888888888",
                        "16666666666"
                    ],
                    "level": "usr",
                    "finger":4,
                    "ffinger":1,
                    "passwd":2,
                    "card":2,
                    "face":1,
                    "count":5,
                    "remainder":3,
                    "date" :  {"start":"181201", "end":"181201"},
                    "time":[
                        {"start":"1005","end":"1205"},
                        {"start":"1005","end":"1205"},
                        {"start":"1005","end":"1205"}
                    ]
                }
            ],
            "bind_username_list": [
                "18888888888",
                "18888888888"
            ],
            "network_ssid": "xxxxxxxxx",
            "infrared_alarm_interval_time": "30",
            "infrared_alarm_type": "txt",
            "volume_level": 2,
            "infrared_sensitivity": "50",
            "auth_mode": 1,
            "activation_code": "12311",
            "on_off": "0,1,1,0,1,0,1,0",
            "mac_addr": "xxxxxxxxx",
            "short_id": "123123",
            "dev_model": "Z501",
            "dev_id": "xxxxxxx",
            "uuid": "xxxxxxxxx",
            "authorize_code": "xxxxxxx",
            "secretkey": "xxxxxxx",
            "open_mode": 1,
            "passwd_switch": 1,
            "remote_switch": 1,
            "hidden_mode": "XXXX",
            "q_battery":66,
            "timestamp": "xxxxxxxxx",
            "fVer":"V1.1.120",
            "fType":"Z201",
            "hasScr":1,
            "bVer":"V1.1.120",
            "bType":"xx",
            "NB_Ver":"xxxxx",
            "is_push":1,
            "sim":"xxxxx",
            "ipc_sn":"xxxxx",
            "active_mode":0,
            "nolock_switch":1,
            "fakelock_switch":1,
            "infra_switch":1,
            "infra_time":5,
            "alarm_switch":1,
            "wifi_ssid":"xxxxx",
            "device_state":1,
            "tel_no":"13838383388",
            "alarm_type":"noatmpt,forced_break",
            "bell_switch":1,
            "productID":"XXXXXXXX",
            "fbreak_switch":1,
            "ble_switch":1,
            "tv_list":[
                {
                    "id": "10",
                    "note": "湖南卫视"
                },
                {
                    "id": "21",
                    "note": "浙江卫视"
                },
                {
                    "id": "30",
                    "note": "中央一套"
                }
            ],
            "air_switch":"1",
            "air_mode":"xxxxx",
            "air_temp":"xxxxx",
            "air_wind":"xxxxx",
            "air_wind_direct":"xxxxx",
            "unsupport":1,
            "capability":5,
            "bindid":"xxxx",
            "bindstr":"xxxx"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
short_id 可选 设备短ID 短ID,有些设备是UUID编号
type 可选 机器人类型 机器人必填,robot (机器人)
参数 说明 备注
vendor_name 设备供应商 设备的提供商
uuid 设备序列号 设备唯一标识码
type 设备类型 设备的类型,见1.1 公共参数,飞比的使用device_id字段,WonlyVideoLock (视频锁) WonlySmartEye (猫眼) WonlySmartAirer (晾霸) WonlyBtLock (爱感蓝牙锁)WonlySmartEyeYs7 (萤石智能猫眼)WonlyNBLock (王力NB锁)WonlyCameraYs7 (萤石摄像头)
username 设备用户名 设备登录所需用户名
password 设备密码 设备登录所需密码
room_area 房间区域 设备所属的房间区域信息
note 设备别名 设备的别名
version 设备版本 设备的版本信息,(爱感蓝牙锁也需要)
context_vendor_name 设备供应商 设备的提供商
context_uuid 设备的上下文设备ID 比如猫眼会关联一个门锁,此处则为门锁的UUID
device_user_version 设备用户版本号 设备用户版本号
device_user_list:id 设备用户id 设备用户的id
device_user_list:note 设备用户别名 设备用户的别名
device_user_list:without_notice_user_list 无需通知的用户名 不需要通知的用户名
device_user_list:level 设备用户等级 设备用户的等级,管理员:adm, 普通用户:usr,临时用户:tmp
device_user_list:unlock_type_list:unlock_maintype 开锁方式主代号(爱感蓝牙锁特有) (密码-1,指纹-2,刷卡-3等等)
device_user_list:
unlock_type_list:
unlock_maintype:
main_list:
unlock_subtype
开锁方式次代号(爱感蓝牙锁特有) 0:正常密码,1:胁迫密码等
device_user_list:
unlock_type_list:
unlock_maintype:
main_list:
sub_num
开锁方式次代号数量(爱感蓝牙锁特有) 开锁方式次代号数量
device_user_list:finger 指纹数量 指纹数量
device_user_list:ffinger 胁迫指纹数量 胁迫指纹数量
device_user_list:passwd 密码数量 密码数量
device_user_list:card 卡数量 卡数量
device_user_list:face 人脸数量 人脸数量
device_user_list:count 临时用户开门次数 开门次数,0为无限次
device_user_list:remainder 开门剩余次数 临时用户开门剩余次数
device_user_list:date 临时用户有效日期 开始有效时间 : 年月日,BCD码字符,截止有效时间 : 年月日,BCD码字符
device_user_list:time 临时用户有效时间段 时段1,开始时间:时分BCD码,例10点5分—1005,结束时间:时分BCD码,例12点5分—1205
bind_username_list 绑定用户列表 绑定此设备的用户列表
network_ssid 网络的SSID 网络的SSID
infrared_alarm_interval_time 红外报警检测时间 红外报警检测的间隔时间,30 - 120
infrared_alarm_data_type 报警数据类型 报警的数据类型,txt pic av
volume_level 音量等级 1 - 3,(爱感蓝牙锁也需要)
infrared_sensitivity 红外灵敏度 1 - 100
auth_mode 验证模式 1 (单人验证) 2 (双人验证)
activation_code 激活码 激活码
on_off 功能开关 0,1,1,0,1,0,1,0 对应 关闭红外报警,开启门锁常开,开启门未关报警,关闭假锁报警,开启密码功能,关闭红外检测,开启网络常在线,关闭远程控制
short_id 设备短ID 短ID,有些设备是UUID编号
dev_model 设备型号 设备型号
dev_id 设备串码 设备串码,(爱感蓝牙锁也需要)
uuid 蓝牙锁uuid(爱感蓝牙锁) 蓝牙锁,蓝牙门锁特有。
authorize_code 授权码(爱感蓝牙锁) 授权码,蓝牙门锁特有。
secretkey 蓝牙门锁密钥(爱感蓝牙锁) 蓝牙门锁密钥,蓝牙门锁特有。
open_mode 常开模式 常开模式,(0:常开模式模式关闭,开门需要指纹,卡,密码等验证模式,1:常开模式打开,即门外不需要指纹,密码,卡等验证模式就可以直接开门,并使用验证模式开门后自动关闭常开模式)
passwd_switch 密码开关 密码开关(0:无法使用密码开锁,1:可以使用密码开锁)
remote_switch 远程开关 远程开关(0:无法使用远程开锁,1:可以使用远程开锁)
hidden_mode 隐藏模式 蓝牙门锁隐藏模式,蓝牙门锁特有
q_battery 电量 门锁电池电量百分比
timestamp 时间戳 蓝牙门锁时间戳
fVer 前板版本号 前板版本号
fType 前板类型 前板类型
hasScr 是否带屏幕 是否带屏幕(1-带屏幕,0-不带屏幕)
bVer 后板版本号 后板版本号
bType 后板类型 后板类型
NB_Ver NB版本号 NB版本号
is_push 设备推送开关 萤石设备推送开关,0-推送,1-关闭推送
sim sim卡号 NB锁上的sim卡号
ipc_sn IPC序列号 NB锁上的网络摄像头序列号
active_mode 远程开锁激活方式 NB锁上的远程开锁激活方式,0:门锁唤醒后立即激活,1:输入激活码激活
nolock_switch 门未关开关 门未关开关,0:关闭,1:开启
fakelock_switch 假锁开关 假锁开关,0:关闭,1:开启
infra_switch 人体感应报警开关 NB视频锁,人体感应报警开关,0:关闭,1:开启
infra_time 人体感应报警时间 红外持续监测到多少秒 就上报消息
alarm_switch 报警类型开关 NB视频锁,报警类型开关,0:关闭,1:拍照+录像,2:拍照
wifi_ssid wifi的ssid wifi的ssid
device_state 锁状态 锁状态:0-关门, 1-开门,2-假锁, 3-门未关报警
tel_no 告警语音通知的电话号码 告警语音通知的电话号码
alarm_type 哪些告警需要语音通知给用户 告警类型字符串,选择了多个告警,用逗号","隔开,noatmpt (非法操作),forced_break (强拆报警), fakelock (假锁),nolock (门未关),batt (低电量), infra (红外感应)
bell_switch 门铃开关 0:关闭, 1:开启
productID 产品ID 智能锁条码ID(订单批次,厂家批次)
fbreak_switch 防拆报警开关 0:关闭, 1:开启
ble_switch 蓝牙无感开关 0:关闭, 1:开启
tv_list:id 电视频道序号 红外宝电视频道编辑,"id"-频道序号
tv_list:note 电视频道名称 红外宝电视频道编辑,"note"-频道名称
air_switch 空调开关 空调开关, 0-关闭,1-打开
air_mode 空调模式 空调模式
air_temp 空调温度 空调温度
air_wind 空调风速 空调风速
air_wind_direct 空调风向 空调风向
unsupport NB锁不支持的功能 NB锁不支持的功能,0-所有功能支持,1-临时用户时段不支持
capability 能力集 锁的能力集,无符号整型(4个字节)0:密码;1:IC卡;2:指纹;3:人脸;4:蓝牙无感;5:视频
bindid 飞比网关id 飞比网关id
bindstr 飞比网关str 飞比网关str
platform 设备所属平台 1:飞燕平台;2:onenet平台;3:MQ(平板镶嵌);4:wonly IOT平台(庆科);5:飞比

5.23 添加操作记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

注意:主要针对第三方厂商,自己的设备不需要调用

MSG_OPERATED_RECORD_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_OPERATED_RECORD_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "operated_record_list": [
                {
                    "timestamp": "1499681215",
                    "timestamp_end": "1599681215",
                    "device_user_id": "001,002",
                    "device_user_note": "阿三,阿九",
                    "be_operated": {
                        "mode": "del",
                        "object": "001",
                        "object_level": "adm",
                        "object_note": "阿四",
                        "unlock_mode": "pwd,fp,card"
                    },
                    "just_log": "true"
                },
                {
                    "timestamp": "1499681215",
                    "timestamp_end": "1599681215",
                    "device_user_id": "002,003",
                    "device_user_note": "阿三,阿九",
                    "be_operated": {
                        "mode": "add",
                        "object": "001",
                        "object_level": "adm",
                        "object_note": "阿四",
                        "unlock_mode": "pwd,fp,card"
                    },
                    "just_log": "true"
                }
            ]
        }
    }
}

MSG_OPERATED_RECORD_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_OPERATED_RECORD_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
operated_record_list:timestamp 必填 时间戳 设备的UNIX时间戳,填0则以服务器时间为准
operated_record_list:timestamp_end 选填 时间戳 设备的UNIX时间戳,填0则以服务器时间为准,视频操作填视频结束时间。
operated_record_list:device_user_id 必填 设备用户id 设备用户的id,双人和多重验证为多个授权人的id,格式001,002,003,王力小管家id
operated_record_list:device_user_note 必填 设备用户别名 设备用户的别名,格式阿三,阿九,王力小管家
operated_record_list:be_operated:object 必填 被操作对象 被操作的对象,可以是具体用户的id,也可以是用户组和所有用户adm_grp usr_grp tmp_grp all(萤石设备类型)
operated_record_list:be_operated:object_level 必填 被操作对象的等级 被操作用户的等级,设备用户的等级,adm usr tmp
operated_record_list:be_operated:object_note 可选 被操作对象的别买 被操作对象的别名
operated_record_list:be_operated:mode 必填 操作方式 操作的方式,create add del updatevideo(可视对讲)
operated_record_list:be_operated:result 可选 操作结果 操作的结果,success fail
operated_record_list:be_operated:unlock_mode 必填 开锁方式 开锁的方式,格式为pwd,fp,card,可以多选,all (所有) pwd (密码) fp (指纹) card (刷卡) face (人脸) rf (感应) eye (虹膜) vena (指静脉) remote (远程) rf_ble (蓝牙感应开锁) timeslot (时间段)
operated_record_list:just_log 可选 历史记录 是否只是历史记录 true false,不填默认为false

5.24 删除操作记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_OPERATED_RECORD_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_OPERATED_RECORD_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "end_timestamp": "1499681215",
            "start_timestamp": "1499681215",
            "_id_list": [
                "5420013272fe096c39901048",
                "5420013272fe096c39901049"
            ]
        }
    }
}

MSG_OPERATED_RECORD_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_OPERATED_RECORD_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
end_timestamp 可选 结束时间戳 不填默认为服务器时间,删除end_timestamp到start_timestamp之间所有的记录
start_timestamp 可选 开始时间戳 不填则默认为end_timestamp之前所有的记录删除
_id_list 可选 记录id列表 需要删除的记录id列表,填写此字段则忽略end_timestamp和start_timestamp字段

5.25 查询操作记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_OPERATED_RECORD_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_OPERATED_RECORD_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "end_timestamp": "1499681215",
            "start_timestamp": "1499681215",
            "record_number": "10",
            "has_deleted": "false"
        }
    }
}

MSG_OPERATED_RECORD_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_OPERATED_RECORD_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": [
            {
                "_id": "5420013272fe096c39901048",
                "timestamp": "1499681215",
                "device_user_id": "001,002",
                "device_user_note": "阿三,阿九",
                "be_operated": {
                    "mode": "del",
                    "object": "001",
                    "object_level": "adm",
                    "object_note": "阿四",
                    "unlock_mode": "pwd,fp,card"
                }
            },
            {
                "_id": "5420013272fe096c39901049",
                "timestamp": "1499681215",
                "device_user_id": "002,003",
                "device_user_note": "阿三,阿九",
                "be_operated": {
                    "mode": "add",
                    "object": "001",
                    "object_level": "adm",
                    "object_note": "阿四",
                    "unlock_mode": "pwd,fp,card"
                }
            }
        ]
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
end_timestamp 可选 结束时间戳 不填默认为服务器时间,查询end_timestamp到start_timestamp之间所有的记录
start_timestamp 可选 开始时间戳 不填则默认查询end_timestamp之前所有的记录
record_number 可选 记录数 最大50条,需要查询多少条记录(填写此字段则从end_timestamp往前推查询record_number条记录,包括end_timestamp这秒的记录,否则查询end_timestamp和start_timestamp之间所有记录,end_timestamp、start_timestamp、record_number三个字段都不填则查询所有记录)
has_deleted 可选 已被删除 查询记录的类型,查询是否已被删除的记录 true false
参数 说明 备注
_id 记录id 记录的唯一id
timestamp 时间戳 设备的UNIX时间戳,填0则以服务器时间为准
device_user_id 设备用户id 设备用户的id,双人和多重验证为多个授权人的id,格式001,002,003
device_user_note 设备用户别名 设备用户的别名,格式阿三,阿九
be_operated:object 被操作对象 被操作的对象,可以是具体用户的id,也可以是用户组和所有用户adm_grp usr_grp tmp_grp all
be_operated:object_level 被操作对象的等级 被操作用户的等级,设备用户的等级,adm usr tmp
be_operated:object_note 被操作对象的别买 被操作对象的别名
be_operated:mode 操作方式 操作的方式,create add del update
be_operated:unlock_mode 开锁方式 开锁的方式,格式为pwd,fp,card,可以多选,all (所有) pwd (密码) fp (指纹) card (刷卡) face (人脸) rf (感应) eye (虹膜) vena (指静脉) remote (远程) rf_ble (蓝牙感应开锁) timeslot (时间段)

5.26 添加开锁记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

注意:主要针对第三方厂商,自己的设备不需要调用

MSG_UNLOCK_RECORD_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UNLOCK_RECORD_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "unlock_record_list": [
                {
                    "timestamp": "1499681215",
                    "device_user_id": "001",
                    "device_user_note": "阿三",
                    "unlock_mode": "pwd",
                    "auth_mode": "dbl",
                    "stress_status": "false",
                    "op_type": "enter_menu",
                    "just_log": "true",
                    "unlock_message":"xxxxxx"
                },
                {
                    "timestamp": "1499681215",
                    "device_user_id": "001",
                    "device_user_note": "阿三",
                    "unlock_mode": "pwd",
                    "auth_mode": "dbl",
                    "stress_status": "false",
                    "op_type": "enter_menu",
                    "just_log": "true",
                    "unlock_message":"xxxxxx"
                }
            ]
        }
    }
}

MSG_UNLOCK_RECORD_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UNLOCK_RECORD_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
unlock_record_list:timestamp 必填 时间戳 设备的UNIX时间戳,填0则以服务器时间为准
unlock_record_list:device_user_id 必填 设备用户id 设备用户的id, (爱感蓝牙锁告警则填设备uuid)
unlock_record_list:device_user_note 必填 设备用户别名 设备用户的别名,格式阿三,爱感蓝牙锁同device_user_id
unlock_record_list:unlock_mode 必填 开锁方式 开锁的方式,pwd (密码) fp (指纹) card (刷卡) face (人脸) rf (感应) eye (虹膜) vena (指静脉) remote (远程) rf_ble (蓝牙感应开锁)timeslot (时间段)
unlock_record_list:auth_mode 必填 验证方式 验证的方式,sgl (单人) dbl (双人) mutil (多人),爱感蓝牙锁填sgl
unlock_record_list:stress_status 必填 胁迫状态 是否被胁迫,true false
unlock_record_list:op_type 必填 操作类型 enter_menu (进入菜单) off_lock (取消常开) on_lock (启用常开) default (恢复出厂设置) on_infra (启用红外报警) off_infra (取消红外报警)btlock(爱感蓝牙锁填)nblock(NB锁填)nbvideolock(NB锁填)
unlock_record_list:just_log 可选 历史记录 是否只是历史记录 true false,不填默认为false
unlock_record_list:unlock_message 可选 NB视频锁抓拍的图片 NB视频锁抓拍的图片

5.27 删除开锁记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_UNLOCK_RECORD_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UNLOCK_RECORD_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "end_timestamp": "1499681215",
            "start_timestamp": "1499681215",
            "_id_list": [
                "5420013272fe096c39901048",
                "5420013272fe096c39901049"
            ]
        }
    }
}

MSG_UNLOCK_RECORD_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UNLOCK_RECORD_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
end_timestamp 可选 结束时间戳 不填默认为服务器时间,删除end_timestamp到start_timestamp之间所有的记录
start_timestamp 可选 开始时间戳 不填则默认为end_timestamp之前所有的记录删除
_id_list 可选 记录id列表 需要删除的记录id列表,填写此字段则忽略end_timestamp和start_timestamp字段

5.28 查询开锁记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_UNLOCK_RECORD_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UNLOCK_RECORD_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "end_timestamp": "1499681215",
            "start_timestamp": "1499681215",
            "record_number": "10",
            "has_deleted": "false"
        }
    }
}

MSG_UNLOCK_RECORD_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UNLOCK_RECORD_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": [
            {
                "_id": "5420013272fe096c39901049",
                "timestamp": "1499681215",
                "device_user_id": "001",
                "device_user_note": "阿三",
                "unlock_mode": "pwd",
                "auth_mode": "dbl",
                "stress_status": "false",
                "op_type": "enter_menu",
                "unlock_message_type":"pic",
                "unlock_message":"xxxxx",
                "has_read": "true"
            },
            {
                "_id": "5420013272fe096c39901048",
                "timestamp": "1499681215",
                "device_user_id": "001",
                "device_user_note": "阿三",
                "unlock_mode": "pwd",
                "auth_mode": "dbl",
                "stress_status": "false",
                "op_type": "enter_menu",
                "unlock_message_type":"pic",
                "unlock_message":"xxxxx",
                "has_read": "true"
            }
        ]
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
end_timestamp 可选 结束时间戳 不填默认为服务器时间,查询end_timestamp到start_timestamp之间所有的记录
start_timestamp 可选 开始时间戳 不填则默认查询end_timestamp之前所有的记录
record_number 可选 记录数 最大50条,需要查询多少条记录(填写此字段则从end_timestamp往前推查询record_number条记录,包括end_timestamp这秒的记录,否则查询end_timestamp和start_timestamp之间所有记录,end_timestamp、start_timestamp、record_number三个字段都不填则查询所有记录)
has_deleted 可选 已被删除 查询记录的类型,查询是否已被删除的记录 true false
参数 说明 备注
_id 记录id 记录的唯一id
timestamp 时间戳 设备的UNIX时间戳,填0则以服务器时间为准
device_user_id 设备用户id 设备用户的id
device_user_note 设备用户别名 设备用户的别名,格式阿三
unlock_mode 开锁方式 开锁的方式,pwd (密码) fp (指纹) card (刷卡) face (人脸) rf (感应) eye (虹膜) vena (指静脉) rf_ble (蓝牙感应开锁) remote (远程)
auth_mode 验证方式 验证的方式,sgl (单人) dbl (双人) mutil (多人)
stress_status 胁迫状态 是否被胁迫,true false
op_type 操作类型 enter_menu (进入菜单) off_lock (取消常开) on_lock (启用常开) default (恢复出厂设置) on_infra (启用红外报警) off_infra (取消红外报警)
unlock_message_type 消息内容类型 消息内容unlock_message类型,txt pic av
unlock_message NB视频锁抓拍的图片 NB视频锁抓拍的图片
has_read 消息已读标记 消息已读标记,true为已读

5.29 添加报警数据

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

注意:主要针对第三方厂商,自己的设备不需要调用

MSG_ALARM_DATA_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_DATA_ADD_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "alarm_data_list": [
                {
                    "timestamp": "1499681215",
                    "device_user_id": "001",
                    "device_user_note": "阿三",
                    "alarm_type": "noatmpt",
                    "alarm_message":  "https://download.wonlycloud.com/slideshow/banner1.png",
                    "alarm_message_type": "pic",
                    "just_log": "true"
                },
                {
                    "timestamp": "1499681215",
                    "device_user_id": "002",
                    "device_user_note": "阿三",
                    "alarm_type": "call",
                    "alarm_message": "https://download.wonlycloud.com/slideshow/banner1.png",
                    "alarm_message_type": "pic",
                    "just_log": "true"
                }
            ]
        }
    }
}

MSG_ALARM_DATA_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_DATA_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
alarm_data_list:timestamp 必填 时间戳 设备的UNIX时间戳,填0则以服务器时间为准
alarm_data_list:device_user_id 可选 设备用户id 设备用户的id
alarm_data_list:device_user_note 可选 设备用户别名 设备用户的别名,格式阿三
alarm_data_list:alarm_type 必填 报警类型 报警的类型,noatmpt (非法操作) not_noatmpt (除非法操作) fakelock (假锁) not_fakelock (除假锁) nolock (门未关) not_nolock (除门未关) batt (低电量) not_batt (除低电量) infra (红外感应) not_infra (除红外感应) call (门铃呼叫) not_call (除门铃呼叫)doormachine_call (门口机呼叫) relock (解除门未关) not_relock (除解除门未关) rm_fake (解除假锁) not_rm_fake (除解除假锁)forced_break (强拆报警)
alarm_data_list:alarm_message 可选 报警消息 报警视频或报警图片的地址
alarm_data_list:alarm_message_type 必填 报警数据类型 报警的数据类型,txt pic av
alarm_data_list:just_log 可选 历史记录 是否只是历史记录 true false,不填默认为false

5.30 删除报警数据

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ALARM_DATA_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_DATA_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "end_timestamp": "1499681215",
            "start_timestamp": "1499681215",
            "_id_list": [
                "5420013272fe096c39901048",
                "5420013272fe096c39901049"
            ],
            "alarm_type": "not_call"
        }
    }
}

MSG_ALARM_DATA_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_DATA_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
end_timestamp 可选 结束时间戳 不填默认为服务器时间,删除end_timestamp到start_timestamp之间所有的记录
start_timestamp 可选 开始时间戳 不填则默认为end_timestamp之前所有的记录删除
_id_list 可选 记录id列表 需要删除的记录id列表,填写此字段则忽略end_timestamp和start_timestamp字段
alarm_type 可选 报警类型 报警的类型,noatmpt (非法操作) not_noatmpt (除非法操作) fakelock (假锁) not_fakelock (除假锁) nolock (门未关) not_nolock (除门未关) batt (低电量) not_batt (除低电量) infra (红外感应) not_infra (除红外感应) call (门铃呼叫) not_call (除门铃呼叫)doormachine_call (门口机呼叫) relock (解除门未关) not_relock (除解除门未关) rm_fake (解除假锁) not_rm_fake (除解除假锁)forced_break (强拆报警)

5.31 查询报警数据

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ALARM_DATA_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_DATA_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "end_timestamp": "1499681215",
            "start_timestamp": "1499681215",
            "record_number": "10",
            "alarm_type": "not_call",
            "has_deleted": "false"
        }
    }
}

MSG_ALARM_DATA_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_DATA_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": [
            {
                "_id": "5420013272fe096c39901049",
                "timestamp": "1499681215",
                "device_user_id": "001",
                "device_user_note": "阿三",
                "alarm_type": "noatmpt",
                "alarm_message": "https://download.wonlycloud.com/slideshow/banner1.png",
                "alarm_message_type": "pic",
                "has_read": "true"
            },
            {
                "_id": "5420013272fe096c39901048",
                "timestamp": "1499681215",
                "device_user_id": "002",
                "device_user_note": "阿三",
                "alarm_type": "noatmpt",
                "alarm_message": "https://download.wonlycloud.com/slideshow/banner1.mp4",
                "alarm_message_type": "pic",
                "has_read": "true"
            }
        ]
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
end_timestamp 可选 结束时间戳 不填默认为服务器时间,查询end_timestamp到start_timestamp之间所有的记录
start_timestamp 可选 开始时间戳 不填则默认查询end_timestamp之前所有的记录
record_number 可选 记录数 最大50条,需要查询多少条记录(填写此字段则从end_timestamp往前推查询record_number条记录,包括end_timestamp这秒的记录,否则查询end_timestamp和start_timestamp之间所有记录,end_timestamp、start_timestamp、record_number三个字段都不填则查询所有记录)
alarm_type 可选 报警类型 报警的类型,noatmpt (非法操作) not_noatmpt (除非法操作) fakelock (假锁) not_fakelock (除假锁) nolock (门未关) not_nolock (除门未关) batt (低电量) not_batt (除低电量) infra (红外感应) not_infra (除红外感应) call (门铃呼叫) not_call (除门铃呼叫)doormachine_call (门口机呼叫) relock (解除门未关) not_relock (除解除门未关) rm_fake (解除假锁) not_rm_fake (除解除假锁)forced_break (强拆报警)
has_deleted 可选 已被删除 查询记录的类型,查询是否已被删除的记录 true false
参数 说明 备注
_id 记录id 记录的唯一id
timestamp 时间戳 设备的UNIX时间戳,填0则以服务器时间为准
device_user_id 设备用户id 设备用户的id
device_user_note 设备用户别名 设备用户的别名,格式阿三
alarm_type 报警类型 报警的类型,noatmpt (非法操作) not_noatmpt (除非法操作) fakelock (假锁) not_fakelock (除假锁) nolock (门未关) not_nolock (除门未关) batt (低电量) not_batt (除低电量) infra (红外感应) not_infra (除红外感应) call (门铃呼叫) not_call (除门铃呼叫)doormachine_call (门口机呼叫) relock (解除门未关) not_relock (除解除门未关) rm_fake (解除假锁) not_rm_fake (除解除假锁)forced_break (强拆报警)
alarm_message 报警消息 报警视频或报警图片的地址
alarm_message_type 报警数据类型 报警的数据类型,txt pic av
has_read 消息已读标记 消息已读标记,true为已读

5.32 获取发现展示数据

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DISCOVER_DATA_GET_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DISCOVER_DATA_GET_REQ",
            "seq_id": "1"
        },
        "body": {
            "type":"robot"
        }
    }
}

MSG_DISCOVER_DATA_GET_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DISCOVER_DATA_GET_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "discover_list": [
                {
                    "img_url": "https://download.wonlycloud.com/slideshow/banner3.png",
                    "link_url": "https://detail.tmall.com/item.htm?spm=a1z10.1-b.w5003-17283987398.16.443cf2b5fIM1uK&id=557044357082&scene=taobao_shop",
                    "explain": "Z100: 王力智能,更便捷/更安全/更耐用"
                },
                {
                    "img_url": "https://download.wonlycloud.com/slideshow/banner3.png",
                    "link_url": "https://detail.tmall.com/item.htm?spm=a1z10.1-b.w5003-17283987398.16.443cf2b5fIM1uK&id=557044357082&scene=taobao_shop",
                    "explain": "Z100: 王力智能,更便捷/更安全/更耐用"
                },
                {
                    "img_url": "https://download.wonlycloud.com/slideshow/banner3.png",
                    "link_url": "https://detail.tmall.com/item.htm?spm=a1z10.1-b.w5003-17283987398.16.443cf2b5fIM1uK&id=557044357082&scene=taobao_shop",
                    "explain": "Z100: 王力智能,更便捷/更安全/更耐用"
                },
                {
                    "img_url": "https://download.wonlycloud.com/slideshow/banner3.png",
                    "link_url": "https://detail.tmall.com/item.htm?spm=a1z10.1-b.w5003-17283987398.16.443cf2b5fIM1uK&id=557044357082&scene=taobao_shop",
                    "explain": "Z100: 王力智能,更便捷/更安全/更耐用"
                },
                {
                    "img_url": "https://download.wonlycloud.com/slideshow/banner3.png",
                    "link_url": "https://detail.tmall.com/item.htm?spm=a1z10.1-b.w5003-17283987398.16.443cf2b5fIM1uK&id=557044357082&scene=taobao_shop",
                    "explain": "Z100: 王力智能,更便捷/更安全/更耐用"
                }
            ]
        }
    }
}
  • 请求参数说明

    headerHTTP API 公共包头

    body 没有body

  • 参数 说明 备注
    type 可选 机器人类型 机器人必填,robot (机器人)
  • 应答参数说明

    headerHTTP API 公共包头

    body 主要是具体协议的内容

参数 说明 备注
discover_list:img_url 图片地址 需要显示的图片的地址
discover_list:link_url 链接地址 点击图片的链接地址
discover_list:explain 备注说明 图片的配套说明文字

5.33 用户意见反馈

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_USER_FEEDBACK_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_FEEDBACK_REQ",
            "seq_id": "1"
        },
        "body": {
            "content": "XXXXXXXXXXXXXX",
            "type":"robot"
        }
    }
}

MSG_USER_FEEDBACK_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_FEEDBACK_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
content 必填 内容 用户反馈内容,APP端需要限定输入的长度(200)
type 可选 机器人类型 机器人必填,robot (机器人)

5.34 修改设备用户别名

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_USER_MOD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_MOD_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "general",
            "type" : "WonlyBtLock",
            "uuid": "xxxxxxxxxx",
            "device_user_id" : "0001"/1,
            "device_user_note" : "别名"
        }
    }
}

MSG_DEVICE_USER_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_USER_MOD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
type 必填 爱感蓝牙锁 爱感蓝牙锁(WonlyBtLock),机器人必填,robot (机器人)
uuid 必填 设备序列号 设备唯一标识码
device_user_id 必填 设备用户id 设备用户id,如果type=WonlyBtLock,则设备用户id为字符串,type=WonlyNBLock,设备用户id则为整型,后续设备用户id均采用整型。
device_user_note 必填 设备用户别名 设备用户的别名

5.35 更新设备列表变动标识

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_GATEWAY_DEVICE_CHANGEDFLAG_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_DEVICE_CHANGEDFLAG_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "general",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_GATEWAY_DEVICE_CHANGEDFLAG_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GATEWAY_DEVICE_CHANGEDFLAG_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 网关供应商名 1.1 公共参数:vendor_name
uuid 必填 网关序列号 网关唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)

5.36 机器人小管家保活

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_KEEPER_KEEPALIVE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_KEEPER_KEEPALIVE_REQ",
            "seq_id": "1"
        },
        "body": {
            "type": "robot",
            "phone": {
                "uuid": "xxxxxxxxxx",
                "endpoint_type": "OPPO R9s",
                "platform": "android",
                "platform_version": "4.3",
                "network_type": "3G"
            }
        }
    }
}

MSG_KEEPER_KEEPALIVE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_KEEPER_KEEPALIVE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
type 必填 APP设备类型 机器人小管家标识:robot
phone:uuid 必填 手机序列号 手机唯一标识码
phone:endpoint_type 可选 终端设备类型 终端设备的类型
phone:platform 可选 手机系统 公共参数
phone:platform_version 可选 手机系统版本 具体系统的版本
phone:network_type 可选 手机网络类型 具体的网络类型

5.37 授权用户列表

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_CHILD_USER_LIST_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_LIST_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "general",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_CHILD_USER_LIST_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_CHILD_USER_LIST_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "child_user_permit_list": [
            {
                "username": "XXXXX",
                "user_alias": "xxxxxxxxxx",
                "permissions": "xxxxxxxxxx",
                "timestamp": "XXXXXXXXXX"
            },
            {
                "username": "XXXXX",
                "user_alias": "xxxxxxxxxx",
                "permissions": "xxxxxxxxxx",
                "timestamp": "XXXXXXXXXX"
            }]
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商名 公共参数
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)

应答参数说明

headerHTTP API 公共包头

body 主要是具体协议的内容

参数 说明 备注
child_user_permit_list:username 用户名 用户名
child_user_permit_list:user_alias 别名 别名
child_user_permit_list:permissions 用户权限 用户权限
child_user_permit_list:timestamp 授权时间 授权时间

5.38 获取锁激活状态

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_DEVICE_ACTIVE_STATE_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_ACTIVE_STATE_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "general",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_DEVICE_ACTIVE_STATE_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DEVICE_ACTIVE_STATE_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "timestamp": 1XXXXXXXXXX
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商名 公共参数
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)

应答参数说明

headerHTTP API 公共包头

body 主要是具体协议的内容

参数 说明 备注
timestamp 时间戳 锁激活时间,单位:秒

5.39 门口机开门

  • 请求应答示例

MSG_DOORMACHINE_REMOTE_OPEN_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DOORMACHINE_REMOTE_OPEN_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "ys7",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_DOORMACHINE_REMOTE_OPEN_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_DOORMACHINE_REMOTE_OPEN_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商名 公共参数
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)

5.40 获取开门/报警消息未读数量

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_GET_UNREAD_NUMBER_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_UNREAD_NUMBER_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "xxxx",
            "uuid": "xxxxxxxxxx",
            "tag": "unlock",
            "type":"robot"
        }
    }
}

MSG_GET_UNREAD_NUMBER_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_UNREAD_NUMBER_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "totals": 100
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
tag 可选 区分查询 一、不传该字段,则为统计开锁/报警所有的未读数量;二、分别查询:1、开门未读记录数:unlock,2、报警未读记录数:alarm
type 可选 机器人类型 机器人必填,robot (机器人)
参数 说明 备注
totals 未读记录数 未读记录数

5.41 标记开门/报警消息为已读

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_MARK_READ_RECORD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_MARK_READ_RECORD_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "xxxx",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "tag": "unlock",
            "_id_list": [
                "5420013272fe096c39901048",
                "5420013272fe096c39901049"
            ]
        }
    }
}

MSG_MARK_READ_RECORD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_MARK_READ_RECORD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
tag 必填 开门/报警区分 分别标记:1、标记开门记录为已读:unlock,2、标记报警记录为已读:alarm
_id_list 可选 记录id列表 需要标记为已读的记录id列表,不填该字段则将所有的记录标记为已读

5.42 华为APP推送token上传(用户退出登录时首先调此接口)

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_UPLOAD_HUAWEI_PUSH_TOKEN_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UPLOAD_HUAWEI_PUSH_TOKEN_REQ",
            "seq_id": "1"
        },
        "body": {
            "tag": "120687",
            "token": "xxxxxxxxxxx",
            "tag_old": "120686",
            "type":"robot"
        }
    }
}

MSG_UPLOAD_HUAWEI_PUSH_TOKEN_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_UPLOAD_HUAWEI_PUSH_TOKEN_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
tag 可选(用户退出登录时不传) 推送tag 推送tag,目前NB锁采用锁uuid
token 必填 华为APPtoken 华为APPtoken
tag_old 可选 切换网关,旧的推送tag 切换网关,带上此tag_old,旧的推送tag
type 可选 机器人类型 机器人必填,robot (机器人)

5.43 更新场景配置

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_SCENE_CONFIG_UPDATE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCENE_CONFIG_UPDATE_REQ",
            "seq_id": "1"
        },
        "body": {
            "isfull": "true",
            "gateway_vendor_name": "feibee",
            "gateway_uuid": "xxxxxxxxxx",
            "type":"robot"
            "scene_list": [
                {
                    "operation": "add",
                    "vendor_name": "feibee",
                    "uuid": "528184",
                    "type": "10",
                    "note": "Z101",

                    "rule_note": "场景设置",
                    "scene_switch": "unlock",
                    "scene_id": "7",
                    "scene_note": "NB视频锁开"
                },
                {
                    "operation": "delete",

                    "vendor_name": "feibee",
                    "uuid": "528184",
                    "type": "10",
                    "note": "Z101",

                    "rule_note": "场景设置",
                    "scene_switch": "unlock",
                    "scene_id": "5",
                    "scene_note": "彩灯亮"
                }
            ]
        }
    }
}

MSG_SCENE_CONFIG_UPDATE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCENE_CONFIG_UPDATE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
isfull 必填 是否全部覆盖 true false
*:operation 可选 具体的更新操作 add delete modify 在isfull参数为false的情况下生效
gateway_vendor_name 必填 网关供应商名 公共参数, 在operation为add的情况下为必填
gateway_uuid 必填 网关序列号 网关唯一标识码, 在operation为add的情况下为必填
type 可选 机器人类型 机器人必填,robot (机器人)
scene_list:vendor_name 必填 常用设备供应商 常用设备的供应商, 在operation为add的情况下为必填
scene_list:uuid 必填 常用设备序列号 常用设备的序列号, 在operation为add的情况下为必填
scene_list:type 必填 常用设备类型 常用设备的类型, 在operation为add的情况下为必填
scene_list:note 可选 常用设备别名 常用设备的别名
scene_list:rule_note 必填 规则名称 常用场景的规则名称
scene_list:scene_switch 必填 场景触发开关 场景触发开关,开门:unlock,客流减少(针对展厅平板镶嵌):fewPeople
scene_list:scene_id 必填 常用场景序列号 常用场景的序列号
scene_list:scene_note 可选 常用场景别名 常用场景的别名

5.44 查询场景配置

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_SCENE_CONFIG_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCENE_CONFIG_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "gateway_vendor_name": "feibee",
            "gateway_uuid": "xxxxxxxxxx",
            "type":"robot"
        }
    }
}

MSG_SCENE_CONFIG_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCENE_CONFIG_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "scene_list": [
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "猫眼",
                    "note": "设设的设备"

                    "rule_note":"xxxxx",
                    "scene_switch":"xxxxx",
                    "uuid": "xxxxx",
                    "note": "回家"
                },
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "type": "猫眼",
                    "note": "设设的设备"

                    "rule_note":"xxxxx",
                    "scene_switch":"xxxxx",
                    "uuid": "xxxxx",
                    "note": "上班"
                }
            ]
        }
    }
}
参数 选项 说明 备注
gateway_vendor_name 必填 网关供应商名 公共参数
gateway_uuid 必填 网关序列号 网关唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
参数 说明 备注
scene_list:vendor_name 常用设备供应商 常用设备的供应商
scene_list:uuid 常用设备序列号 常用设备的序列号
scene_list:type 常用设备类型 常用设备的类型
scene_list:note 常用设备别名 常用设备的别名
scene_list:rule_note 规则名称 常用场景的规则名称
scene_list:scene_switch 场景触发开关 场景触发开关,开门:unlock,客流减少(针对展厅平板镶嵌):fewPeople
scene_list:scene_id 常用场景序列号 常用场景的序列号
scene_list:scene_note 常用场景别名 常用场景的别名

5.45 机器人获取扫描登陆的二维码

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ROBOT_GET_LOGIN_CODE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ROBOT_GET_LOGIN_CODE_REQ",
            "seq_id": "1"
        },
        "body": {
            "robot": {
                "uuid":"xxxxxx"
            }
        }
    }
}

MSG_ROBOT_GET_LOGIN_CODE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ROBOT_GET_LOGIN_CODE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
        "body": {
            "login_code":"xxxxxx"
        }
    }
}
参数 选项 说明 备注
robot:uuid 必填 robot的uuid robot的uuid
参数 说明 备注
login_code 登录码 机器人从服务器获取到的登录码

5.46 扫码确认机器人登陆

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_SCAN_CONFIRM_ROBOT_LOGIN_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCAN_CONFIRM_ROBOT_LOGIN_REQ",
            "seq_id": "1"
        },
        "body": {
            "login_code": "xxxxxx"
        }
    }
}

MSG_SCAN_CONFIRM_ROBOT_LOGIN_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCAN_CONFIRM_ROBOT_LOGIN_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
login_code 必填 login_code login_code

5.47 机器人获取登陆状态

  • 请求应答示例

注意:需要使用应答包里的标准HTTP头Set-Cookie字段

MSG_GET_SCAN_CONFIRM_LOGIN_STATUS_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_SCAN_CONFIRM_LOGIN_STATUS_REQ",
            "seq_id": "1"
        },
        "body": {
            "login_code": "xxxxxxxxx"
        }
    }
}

MSG_GET_SCAN_CONFIRM_LOGIN_STATUS_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_SCAN_CONFIRM_LOGIN_STATUS_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "user_name": "xxxxxx",
            "secret_key": "xxxxxxxxx",
            "user_alias": "xxxxxxx",
            "father_username": "xxxxxxxxx",
            "gateway_list": [
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxxxx"
                },
                {
                    "vendor_name": "feibee",
                    "uuid": "xxxxxxxxxx",
                    "username": "xxxxxxxxx",
                    "password": "xxxxxxxxx",
                    "authorization": "admin",
                    "note": "网网的网关",
                    "version": "xxxxx"
                }
            ],
            "child_user_list": [
                {
                    "username": "xxxxxxx",
                    "user_alias": "老婆"
                },
                {
                    "username": "xxxxxxx",
                    "user_alias": "女儿"
                }
            ],
            "instruct_list": [
                "打开电视",
                "打开空调",
                "打开卧室灯"
            ],
            "slideshow": [
                "https://download.wonlycloud.com/slideshow/banner1.png",
                "https://download.wonlycloud.com/slideshow/banner2.png",
                "https://download.wonlycloud.com/slideshow/banner3.png"
            ]
        }
    }
}
参数 选项 说明 备注
login_code 必填 登录码 登录码
参数 说明 备注
secret_key 用户密钥 用于申请Token
user_alias 用户别名 当前账户的别名
father_username 父用户 当前账户的父账户
gateway_list:vendor_name 网关供应商名 公共参数
gateway_list:uuid 网关序列号 网关唯一标识码
gateway_list:username 网关用户名 登录网关时所用用户名
gateway_list:password 网关密码 登录网关所用密码
gateway_list:authorization 网关权限 admin user
gateway_list:note 网关别名 网关的别名,用于显示在界面上
gateway_list:version 网关版本 网关的版本信息
child_user_list:username 网关用户名 登录网关时所用用户名
child_user_list:user_alias 子用户昵称 子用户的昵称
slideshow 轮播图 轮播图的地址

5.48 更新红外宝电视频道配置

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_TV_CONFIG_UPDATE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TV_CONFIG_UPDATE_REQ",
            "seq_id": "1"
        },
        "body": {
            "isfull": "true",
            "vendor_name": "infra",
            "uuid": "xxxxxxxxxx",
            "type": "WonlyTV",
            "tv_list": [
                {
                    "operation": "add",
                    "id": "22",
                    "note": "湖南卫视"
                },
                {
                    "operation": "delete",

                    "id": "24",
                    "note": "浙江卫视"
                }
            ]
        }
    }
}

MSG_TV_CONFIG_UPDATE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_TV_CONFIG_UPDATE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
isfull 必填 是否全部覆盖 true false
*:operation 可选 具体的更新操作 add delete modify 在isfull参数为false的情况下生效
vendor_name 必填 供应商名 公共参数, 在operation为add的情况下为必填,WonlyTV (电视机)WonlyAirConditioner (空调)
uuid 必填 设备序列号 设备唯一标识码, 在operation为add的情况下为必填
type 必填 设备类型 WonlyTV (电视机)WonlyAirConditioner (空调)
tv_list:id 必填 电视频道序号 电视频道序号, 在operation为add的情况下为必填
tv_list:note 必填 电视频道名称 电视频道名称, 在operation为add的情况下为必填

5.51 添加小卫士闹钟

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ALARM_CLOCK_ADD_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_LOCAL_TV_CHANNEL_REQ",
            "seq_id": "1"
        },
        "body":{
            "device_uuid":"xxxxxx",
            "clock_time":"6:40",
            "clock_voice_type":"3",
            "clock_cycle":{
                    1,
                    3,
                    5
                }
        }
    }
}

MSG_ALARM_CLOCK_ADD_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_ADD_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body":{
             "online":"1",
             "msg":""
        }
    }
}
参数 选项 说明 备注
device_uuid 必填 小卫士设备uuid
clock_time 必填 设置的闹钟时间 hh:mm格式
clock_voice_type 必填 设置的闹钟铃声
clock_cycle 必填 设置的闹钟响铃周期集合 周一为1,周二为2...以此类推,设置全部时,集合为1234567
参数 说明 备注
online 是否在线的标记 0离线1在线
msg 离线的提示语 该设备无法操作,请稍后重试!

5.52 删除小卫士闹钟

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ALARM_CLOCK_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "device_uuid":"xxxxx",
            "clock_id": "xxx"
        }
    }
}

MSG_ALARM_CLOCK_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body":{
             "online":"1",
             "msg":""
        }
    }
}
参数 选项 说明 备注
device_uuid 必填 小卫士设备uuid
clock_id 必填 小卫士闹钟id
参数 说明 备注
online 是否在线的标记 0离线1在线
msg 离线的提示语 该设备无法操作,请稍后重试!

5.53 查询小卫士闹钟

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ALARM_CLOCK_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_QUERY_REQ",
            "seq_id": "1"
        },
        "body":{
            "device_uuid":"xxxx",
            "clock_id":"xxxx",
            "record_number":"24"
        }
    }
}

MSG_ALARM_CLOCK_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": [{
            "clock_time":"6:40",
            "clock_voice_type":"3",
            "clock_cycle":[
                    "1",
                    "3",
                    "5"
                ],
            "clock_id":"xxxx",
            "clock_status":"1"
            }
       ]
    }
}
参数 选项 说明 备注
device_uuid 必填 小卫士设备uuid
clock_id 选填 小卫士闹钟id
record_number 选填 查询多少条记录 默认24条
参数 说明 备注
clock_time 设置的闹钟时间 hh:mm格式
clock_voice_type 设置的闹钟铃声
clock_cycle 设置的闹钟响铃周期集合 周一为1,周二为2...以此类推,设置全部时,集合为1234567
clock_id 闹钟id
clock_status 闹钟状态 0关闭1开启

5.54 修改小卫士闹钟

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ALARM_CLOCK_UPDATE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_UPDATE_REQ",
            "seq_id": "1"
        },
        "body": {
            "device_uuid":"xxxxx",
            "clock_id": "xxx",
            "clock_time":"6:40",
            "clock_voice_type":"3",
            "clock_status":"1",
            "clock_cycle":[
                    "1",
                    "3",
                    "5"
                ]
        }
    }
}

MSG_ALARM_CLOCK_UPDATE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_UPDATE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body":{
             "online":"1",
             "msg":""
        }
    }
}
参数 选项 说明 备注
device_uuid 必填 小卫士设备uuid
clock_id 必填 小卫士闹钟id
clock_time 必填 设置的闹钟时间 hh:mm格式
clock_voice_type 必填 设置的闹钟铃声
clock_cycle 必填 设置的闹钟响铃周期集合 周一为1,周二为2...以此类推,设置全部时,集合为1234567
clock_status 必填 闹钟状态 0禁用1启用
参数 说明 备注
online 是否在线的标记 0离线1在线
msg 离线的提示语 该设备无法操作,请稍后重试!

5.55 查询天气信息

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_GET_WEATHER_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_WEATHER_REQ",
            "seq_id": "1"
        },
        "body":{
            "device_uuid":"xxxx"
        }
    }
}

MSG_GET_WEATHER_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_WEATHER_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "weather":"0",
            "temperature":"25",
            "humidity":"76"
            }
    }
}
参数 选项 说明 备注
device_uuid 必填 小卫士设备uuid
参数 说明 备注
weather 天气返回的类型 0晴1雨2多云
temperature 温度 摄氏度温度
humidity 相对湿度 0~100,单位为百分比

5.56 停止小卫士闹钟

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ALARM_CLOCK_STOP_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_STOP_REQ",
            "seq_id": "1"
        },
        "body":{
            "device_uuid":"xxxx"
        }
    }
}

MSG_ALARM_CLOCK_STOP_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ALARM_CLOCK_STOP_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
device_uuid 必填 小卫士设备uuid

5.57 小管家机器人指令配置更新

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_ROBOT_INSTRUCT_CONFIG_UPDATE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ROBOT_INSTRUCT_CONFIG_UPDATE_REQ",
            "seq_id": "1"
        },
        "body": {
            "isfull": "false",
            "instruct_list": [
                {
                    "operation": "add",
                    "instruct": "打开电视"
                },
                {
                    "operation": "delete",
                    "instruct": "打开卧室空调"
                }
            ]
        }
    }
}

MSG_ROBOT_INSTRUCT_CONFIG_UPDATE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_ROBOT_INSTRUCT_CONFIG_UPDATE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
isfull 必填 是否全部覆盖 true false
*:operation 可选 具体的更新操作 add delete modify 在isfull参数为false的情况下生效
instruct_list:instruct 必填 机器人指令 机器人指令

5.58 查询网关绑定列表

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_BINDING_GATEWAY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_BINDING_GATEWAY_REQ",
            "seq_id": "1"
        },
        "body":{
            "gateway_uuid":"xxxx"
        }
    }
}

MSG_BINDING_GATEWAY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_BINDING_GATEWAY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "bindSum":1,
            "bindNo":"15987463636",
            "msg":"该网关已被:15987463636绑定!"
            }
    }
}
参数 选项 说明 备注
gateway_uuid 必填 网关账号
参数 说明 备注
bindSum 网关被多少人绑定 0未被绑定1一个人绑定2多个人绑定
bindNo 绑定的账号 只有bindSum为1时有账号信息,否则为""
msg 弹出的消息 若bindSum为0,此项为"",否则为对应的弹出信息

5.59 阿里云物联网查询设备在线状态

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_GET_ALIYUN_DEVICE_STATUS_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_ALIYUN_DEVICE_STATUS_REQ",
            "seq_id": "1"
        },
        "body":{
            "device_name":"xxxx",
            "product_key":"xxxx",
        }
    }
}

MSG_GET_ALIYUN_DEVICE_STATUS_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_GET_ALIYUN_DEVICE_STATUS_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "status":"ONLINE"
            }
    }
}
参数 选项 说明 备注
device_name 必填 设备名称
product_key 必填 产品物联网key
参数 说明 备注
status 在线或离线 ONLINE:在线,OFFLINE:离线

5.60 查询设备绑定状态

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_BINDING_DEVICE_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_BINDING_DEVICE_REQ",
            "seq_id": "1"
        },
        "body":{
            "gateway_vendor_name": "general",
            "gateway_uuid": "xxxxxxxxxx",
            "device": {
                "vendor_name": "general",
                "uuid": "xxxxxxxxxx",
                "type": "1001"
            }
        }
    }
}

MSG_BINDING_DEVICE_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_BINDING_DEVICE_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "bindSum":1,
            "bindNo":"15987463636",
            "msg":"该设备已被15987463636绑定,绑定网关为:77595"
            }
    }
}
参数 选项 说明 备注
gateway_vendor_name 必填 网关供应商名 公共参数
gateway_uuid 必填 网关账号
device:vendor_name 必填 设备供应商 公共参数
device:uuid 必填 设备序列号 设备唯一标识码
device:type 必填 设备类型 1.1 公共参数,王力NB锁(WonlyNBLock),必填
参数 说明 备注
bindSum 设备被多少人绑定 0未被绑定1一个人绑定2多个人绑定3被绑定但网关被删除
bindNo 绑定的账号 只有bindSum为1时有账号信息,否则为""
msg 弹出的消息 若bindSum为0,此项为"",否则为对应的弹出信息

5.61 扫码或手动输入设备号添加设备时获取设备信息

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_SCAN_QR_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCAN_QR_REQ",
            "seq_id": "1"
        },
        "body":{
            "qr_code":"Z105_867726039900719"
        }
    }
}

MSG_SCAN_QR_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_SCAN_QR_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": {
            "vendor":"general",
            "uuid":"867726039900719",
            "type":"WonlyNBLock",
            "detail_type":"PSR-AD6020"
            }
    }
}
参数 选项 说明 备注
qr_code 选填(input_uuid有值,此项不填) 扫描得到的二维码
input_uuid 选填(qr_code有值,此项不填) 用户输入的设备uuid
参数 说明 备注
vendor 设备供应商
uuid 设备唯一id
type 设备类型 公共参数,新增FBDev为飞比设备,ys7为萤石设备
detail_type 设备详细类型 若设备为公司自有产品,有值

5.62 查询锁操作记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_USER_OP_LOG_QUERY_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_OP_LOG_QUERY_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot"
            "end_timestamp": "1499681215",
            "start_timestamp": "1499681215",
            "record_number": "10"
        }
    }
}

MSG_USER_OP_LOG_QUERY_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_OP_LOG_QUERY_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        },
        "body": [
            {
                "_id": "5420013272fe096c39901049",
                "devType": "wifiLock",
                "devId": "xxxxxxxxxxxxxxxx",
                "vendor": "general",
                "note": "门锁",
                "userNote": "1499681215",
                "userNote2": "1499681215",
                "opUserNote": "1499681215",
                "userId": 5,
                "userType": 1,
                "userId2": 6,
                "opType": 0,
                "opUser": 6,
                "opValue": 2,
                "time":1592866976
            },
            {
                "_id": "5420013272fe096c39901049",
                "devType": "wifiLock",
                "devId": "xxxxxxxxxxxxxxxx",
                "vendor": "general",
                "note": "门锁",
                "userNote": "1499681215",
                "userNote2": "1499681215",
                "opUserNote": "1499681215",
                "userId": 5,
                "userType": 1,
                "userId2": 6,
                "opType": 0,
                "opUser": 6,
                "opValue": 2,
                "time":1592476976
            }
        ]
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
end_timestamp 可选 结束时间戳 不填默认为服务器时间,查询end_timestamp到start_timestamp之间所有的记录
start_timestamp 可选 开始时间戳 不填则默认查询end_timestamp之前所有的记录
record_number 可选 记录数 最大50条,需要查询多少条记录(填写此字段则从end_timestamp往前推查询record_number条记录,包括end_timestamp这秒的记录,否则查询end_timestamp和start_timestamp之间所有记录,end_timestamp、start_timestamp、record_number三个字段都不填则查询所有记录)
参数 说明 备注
_id 记录id 记录的唯一id
time 时间戳 设备的UNIX时间戳,秒
note 锁别名 锁别名
userId 设备用户id 操作用户id
userNote 用户别名 操作用户别名(此字段为空,则别名为userId+"号用户")
userId2 设备用户id 单人模式为oxffff(65535),此字段单人模式无用
userNote2 用户别名2 单人模式无用(非单人模式,此字段为空,则别名为userId2+"号用户")
opUser opType不为5时为被操作用户id,opType为5时为设置的参数值 参数值:1-音量,2-常开模式,3-密码开关,4-远程开关,6-开门模式,7-时间,8-远程开锁激活方式,9-门未关开关,10-假锁开关,11-人体感应报警开关,12-报警类型,14-门铃开关,15-WIFI_SSID,17-等待关门时间,18-开门角度,19-开门速度,20-关门速度,21-左角度修复值,22-右角度修复值,23-防拆报警开关
opUserNote 被操作用户别名 可为空(此字段为空,若opType为5且opUser有值,则别名为opUser+"号用户")
userType 用户类型 用户类型:1-锁操作,2-app操作
opType 操作类型 0-新增用户,1-修改用户,2-删除用户,3-删除普通组,4-删除临时组,5-设置参数,(3,4,XX用户(与XX用户)删除普通(临时)组),6-远程开锁
opValue 具体操作 当操作不为3,4,5,6时有效,0-用户整体,1-密码,2-刷卡,3-指纹,5-人脸,12-蓝牙

5.63 删除锁用户操作记录

  • 请求应答示例

注意:需要在请求包的标准HTTP头里加上Cookie字段

MSG_USER_OP_LOG_DEL_REQ

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_OP_LOG_DEL_REQ",
            "seq_id": "1"
        },
        "body": {
            "vendor_name": "feibee",
            "uuid": "xxxxxxxxxx",
            "type":"robot",
            "_id":"5420013272fe096c39901048",
            "mark": 0
        }
    }
}

MSG_USER_OP_LOG_DEL_RSP

{
    "UMS": {
        "header": {
            "api_version": "1.0",
            "message_type": "MSG_USER_OP_LOG_DEL_RSP",
            "seq_id": "1",
            "http_code": "200",
            "return_string": "RETURN_SUCCESS_OK_STRING"
        }
    }
}
参数 选项 说明 备注
vendor_name 必填 设备供应商 设备的供应商
uuid 必填 设备序列号 设备唯一标识码
type 可选 机器人类型 机器人必填,robot (机器人)
_id 可选 记录id列表 需要删除的记录id列表,填写此字段则忽略mark字段
mark 可选 是否全删的标记 全删传1(int),不全删忽略