W76D(WiFi面板机API)
W76D 设备接口文档
点击下面的序号展开
1.注册设备
将设备和appid、appsecret绑定
请求URL
https://wdev.wmj.com.cn/deviceApi/register
请求方式
POST
请求格式
json
参数
{
"app_id": "",
"app_secret": "",
"device_sn": ""
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
返回示例
{
"code": 0,
"msg": "注册成功"
}
{
"code": 1005,
"msg": "设备已注册"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 0成功其他异常 |
| msg | string | 描述 |
备注
更多返回错误代码请看首页的错误代码描述
2.开门
开门
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "open",
"info": {
"tts":"欢迎光临",
"volume":80
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 开锁标识open |
| data.info.sn | 否 | string | 一旦传入sn,设备将校验传入sn是否与设备本身sn一致,校验成功才能开门 |
| data.info.tts | 否 | string | 开门提示语音,不传的情况下使用配置语音或默认语音 |
| data.info.volume | 否 | int | 开门提示语音音量0-100或1-7(自动映射到0-100) |
| data.info.### | 否 | any | 可更加实际情况传入,会原值返回 |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "open",
"info": {
"code": 0,
"msg": "门已打开",
"sn": "W76D12345678"
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
3.重启设备
重启设备
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type":"restart",
"info":{}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 重启命令restart |
| data.info | 是 | object | 暂未使用 |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "restart",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
4.语音设置
语音设置
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "set_audio",
"info": {
"pass_tts":"认证成功",
"no_pass_tts":"认证失败",
"launch_tts":"连接成功",
"boot_tts":"系统启动",
"card_success_tts":"刷卡成功",
"card_fail_tts":"刷卡失败",
"password_success_tts":"密码正确",
"password_fail_tts":"密码错误",
"network_connected_tts":"网络已连接",
"network_failed_tts":"网络连接失败",
"volume":80
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 音量设置命令set_audio |
| data.info.pass_tts | 否 | string | 开门成功语音提示 |
| data.info.no_pass_tts | 否 | string | 开门失败语音提示 |
| data.info.launch_tts | 否 | string | 连接服务器成功语音提示 |
| data.info.boot_tts | 否 | string | 系统启动语音提示 |
| data.info.card_success_tts | 否 | string | 刷卡成功语音提示 |
| data.info.card_fail_tts | 否 | string | 刷卡失败语音提示 |
| data.info.password_success_tts | 否 | string | 密码正确语音提示 |
| data.info.password_fail_tts | 否 | string | 密码错误语音提示 |
| data.info.network_connected_tts | 否 | string | 网络已连接语音提示 |
| data.info.network_failed_tts | 否 | string | 网络连接失败语音提示 |
| data.info.volume | 否 | int | 播报音量调节0-100或1-7(自动映射) |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "set_audio",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
5.控制继电器常通常断
通断控制,常开常闭
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "on_off",
"info": {
"status":1
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 控制标识on_off |
| data.info.status | 是 | int | 控制状态 1:常通(继电器保持高电平) 0:常断(继电器保持低电平) |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "on_off",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
6.获取设备信息
获取设备信息
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type":"getdevinfo",
"info":{}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 获取信息getdevinfo |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "getdevinfo",
"info": {
"code": 0,
"msg": "",
"sw_ver": "760.0.07",
"hw_ver": "1.0.0",
"project": "W76D",
"sn": "W76D12345678",
"mac": "A4:CF:12:34:56:78",
"imei": "A4:CF:12:34:56:78",
"ip": "192.168.1.100",
"rssi": -45,
"sta_ssid": "MyWiFi",
"iccid": "MyWiFi/A4:CF:12:34:56:78",
"net_type": "wifi",
"device_pwd": "12345678",
"admin_pwd": "88888888",
"nonc_type": 0,
"workmode": 0,
"door_state": 0,
"es_status": 0,
"relay1": 1500,
"mqtt_beep_enable": 1,
"free_heap": 245678,
"free_psram": 1024000,
"device_time": 1733734800
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
| data.info.sw_ver | string | 软件版本号 |
| data.info.hw_ver | string | 硬件版本号 |
| data.info.project | string | 项目名称 |
| data.info.sn | string | 设备序列号 |
| data.info.mac | string | MAC地址 |
| data.info.imei | string | IMEI(WiFi设备使用MAC) |
| data.info.ip | string | IP地址 |
| data.info.rssi | int | WiFi信号强度 |
| data.info.sta_ssid | string | WiFi SSID |
| data.info.sta_pwd | string | WiFi密码 |
| data.info.iccid | string | ICCID(WiFi设备显示SSID/BSSID) |
| data.info.net_type | string | 网络类型(wifi/eth) |
| data.info.device_pwd | string | 设备密码 |
| data.info.admin_pwd | string | 管理员密码 |
| data.info.nonc_type | int | 常开常闭类型(0=常闭, 1=常开) |
| data.info.workmode | int | 工作模式(0=正常, 1=常开, 2=仅鸣叫) |
| data.info.door_state | int | 门状态(0=关闭, 1=打开) |
| data.info.es_status | int | 门磁状态 |
| data.info.relay1 | int | 继电器延时(毫秒) |
| data.info.mqtt_beep_enable | int | MQTT连接提示音(0=关闭, 1=开启) |
| data.info.free_heap | int | 可用堆内存(字节) |
| data.info.free_psram | int | 可用PSRAM(字节) |
| data.info.device_time | int | 设备当前时间戳 |
7.二维码设置
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "set_qrcode",
"info": {
"qrcode":"https://www.wmj.com.cn",
"mode":"passive"
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 二维码设置set_qrcode |
| data.info.mode | 否 | string | 设备二维码模式 "passive": 设备提供二维码供用户扫描 |
| data.info.qrcode | 否 | string | 显示在屏幕上的二维码内容 |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "set_qrcode",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
8.卡管理
卡管理:
添加、删除、修改、查询、清空、获取卡总数
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
请求示例
// 添加/编辑/删除卡
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "card_add",
"info": {
"card_id": "27598FAF",
"start_time": 1676904446,
"end_time": 1710662359
}
}
}
// 清空所有卡
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "card_clr",
"info": {}
}
}
// 获取卡总数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "card_sum",
"info": {}
}
}
// 查询单张卡
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "card_find",
"info": {
"card_id": "27598FAF"
}
}
}
// 查询所有卡(分页)
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "card_find",
"info": {
"page": 0,
"page_size": 50
}
}
}
参数说明
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 接口参数:用户app_id |
| app_secret | 是 | string | 接口参数:用户app_secret |
| device_sn | 是 | string | 接口参数:设备序列号 |
| data.cmd_type | 是 | string | 业务参数:命令类型 card_add: 新增card_del: 删除card_edit: 编辑card_clr: 清空所有卡card_sum: 获取卡总数card_find: 获取卡详情 |
| data.info.card_id | card_add/del/edit时必选 | string | 业务参数:卡序列号(8位十六进制) |
| data.info.start_time | 否 | integer | 业务参数:启用时间(Unix时间戳),默认0 |
| data.info.end_time | 否 | integer | 业务参数:停用时间(Unix时间戳),默认0x7FFFFFFF |
| data.info.page | card_find时可选 | integer | 业务参数:分页页码(从0开始),不传card_id时有效 |
| data.info.page_size | card_find时可选 | integer | 业务参数:每页数量(默认50,最大100) |
返回示例
// card_add/edit/del 成功
{
"code": 0,
"data": {
"cmd_type": "card_add",
"info": {
"code": 0,
"msg":""
}
}
}
// card_clr 成功
{
"code": 0,
"data": {
"cmd_type": "card_clr",
"info": {
"code": 0,
"msg": ""
}
}
}
// card_sum 成功
{
"code": 0,
"data": {
"cmd_type": "card_sum",
"info": {
"code": 0,
"msg": "",
"card_sum": 10,
"card_max": 1000
}
}
}
// card_find 单卡查询成功
{
"code": 0,
"data": {
"cmd_type": "card_find",
"info": {
"code": 0,
"msg": "",
"card": {
"card_id": "27598FAF",
"start_time": 1676904446,
"end_time": 1710662359
}
}
}
}
// card_find 分页查询成功
{
"code": 0,
"data": {
"cmd_type": "card_find",
"info": {
"code": 0,
"msg": "",
"total": 100,
"page": 0,
"page_size": 50,
"cards": [
{
"card_id": "27598FAF",
"start_time": 1676904446,
"end_time": 1710662359
},
{
"card_id": "B6DC7FA0",
"start_time": 0,
"end_time": 2147483647
}
]
}
}
}
//接口调用失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 必有 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 接口参数:错误码 0: 成功其他: 异常 |
| data.info.code | 是 | int | 业务参数:错误码 0: 成功其他: 失败 |
| data.info.msg | 是 | string | 业务参数:错误信息 |
| data.info.card_sum | 否 | int | 业务参数:卡片总数(card_sum返回) |
| data.info.card_max | 否 | int | 业务参数:最大卡片数(card_sum返回) |
| data.info.card | 否 | object | 业务参数:卡片信息(card_find单卡返回) |
| data.info.total | 否 | int | 业务参数:总卡片数(card_find分页返回) |
| data.info.page | 否 | int | 业务参数:当前页码(card_find分页返回) |
| data.info.page_size | 否 | int | 业务参数:每页数量(card_find分页返回) |
| data.info.cards | 否 | array | 业务参数:卡片列表(card_find分页返回) |
9.设备发卡模式
简要描述
卡管理:
设备发卡设置
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
示例
// W76D风格 (推荐)
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "device_add_card",
"info": {
"enable": 1,
"timeout": 60
}
}
}
// W766风格 (兼容)
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "device_add_card",
"info": {
"state": 1,
"start_time": 0,
"end_time": 2147483647
}
}
}
参数说明
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 接口参数:用户app_id |
| app_secret | 是 | string | 接口参数:用户app_secret |
| device_sn | 是 | string | 接口参数:设备序列号 |
| data.cmd_type | 是 | string | device_add_card |
| data.info.enable | 否 | integer | 业务参数(W76D风格): 1: 开启设备发卡模式 0:关闭设备发卡模式 |
| data.info.state | 否 | integer | 业务参数(W766兼容): 1: 开启设备发卡模式 0:关闭设备发卡模式 注: enable和state二选一 |
| data.info.timeout | 否 | integer | 业务参数:发卡模式超时时间(秒) 默认60秒,范围10-300秒 超时后自动退出发卡模式 |
| data.info.start_time | 否 | integer | 业务参数(W766兼容):新卡生效时间(Unix时间戳),默认0 |
| data.info.end_time | 否 | integer | 业务参数(W766兼容):新卡失效时间(Unix时间戳),默认0x7FFFFFFF |
返回示例
//接口调用成功
{
"code": 0,
"data": {
"cmd_type": "device_add_card",
"info": {
"code": 0,
"msg": ""
}
}
}
//接口调用失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 必有 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 接口参数:错误码 0: 数据传输成功其他: 异常 |
| data.info.code | 是 | int | 业务参数:错误码 0: 业务操作成功其他: 失败 |
| data.info.msg | 是 | string | 业务参数:错误信息 |
备注
设备进入发卡模式后,刷任何卡片都会自动添加到设备中
发卡模式会在超时后自动退出,或通过enable=0手动退出
发卡成功后会触发回调通知(见第13项)
10.密码管理
密码管理:
添加、删除、修改、查询、清空、获取密码总数
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
请求示例
// 添加/编辑密码
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "pwd_add",
"info": {
"pwd": "123456",
"start_time": 1676904446,
"end_time": 1710662359
}
}
}
// 删除密码
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "pwd_del",
"info": {
"pwd": "123456"
}
}
}
// 清空所有密码 (兼容W766)
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "pwd_clr",
"info": {}
}
}
// 获取密码总数 (兼容W766)
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "pwd_sum",
"info": {}
}
}
// 查询单个密码 (兼容W766)
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "pwd_find",
"info": {
"pwd": "123456"
}
}
}
// 查询所有密码(分页)
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "pwd_find",
"info": {
"page": 0,
"page_size": 50
}
}
}
参数说明
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 接口参数:用户app_id |
| app_secret | 是 | string | 接口参数:用户app_secret |
| device_sn | 是 | string | 接口参数:设备序列号 |
| data.cmd_type | 是 | string | 业务参数:命令类型 pwd_add: 新增pwd_del: 删除pwd_edit: 编辑pwd_clr: 清空所有密码pwd_sum: 获取密码总数pwd_find: 获取密码详情 |
| data.info.pwd | pwd_add/del/edit/find单个时必选 | string | 业务参数:密码(4-8位数字) |
| data.info.start_time | 否 | integer | 业务参数:启用时间(Unix时间戳),默认0 |
| data.info.end_time | 否 | integer | 业务参数:停用时间(Unix时间戳),默认0x7FFFFFFF |
| data.info.page | pwd_find时可选 | integer | 业务参数:分页页码(从0开始),不传pwd时有效 |
| data.info.page_size | pwd_find时可选 | integer | 业务参数:每页数量(默认50,最大100) |
返回示例
// pwd_add/edit/del 成功
{
"code": 0,
"data": {
"cmd_type": "pwd_add",
"info": {
"code": 0,
"msg":""
}
}
}
// pwd_clr 成功
{
"code": 0,
"data": {
"cmd_type": "pwd_clr",
"info": {
"code": 0,
"msg": ""
}
}
}
// pwd_sum 成功
{
"code": 0,
"data": {
"cmd_type": "pwd_sum",
"info": {
"code": 0,
"msg": "",
"pwd_sum": 10,
"pwd_max": 1000
}
}
}
// pwd_find 单密码查询成功
{
"code": 0,
"data": {
"cmd_type": "pwd_find",
"info": {
"code": 0,
"msg": "",
"pwd": {
"pwd": "123456",
"start_time": 1676904446,
"end_time": 1710662359
}
}
}
}
// pwd_find 分页查询成功
{
"code": 0,
"data": {
"cmd_type": "pwd_find",
"info": {
"code": 0,
"msg": "",
"total": 10,
"page": 0,
"page_size": 50,
"pwds": [
{
"pwd": "123456",
"start_time": 1676904446,
"end_time": 1710662359
},
{
"pwd": "654321",
"start_time": 0,
"end_time": 2147483647
}
]
}
}
}
//接口调用失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 必有 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int | 接口参数:错误码 0: 成功其他: 异常 |
| data.info.code | 是 | int | 业务参数:错误码 0: 成功其他: 失败 |
| data.info.msg | 是 | string | 业务参数:错误信息 |
| data.info.pwd_sum | 否 | int | 业务参数:密码总数(pwd_sum返回) |
| data.info.pwd_max | 否 | int | 业务参数:最大密码数(pwd_sum返回) |
| data.info.pwd | 否 | object | 业务参数:密码信息(pwd_find单密码返回) |
| data.info.total | 否 | int | 业务参数:总密码数(pwd_find分页返回) |
| data.info.page | 否 | int | 业务参数:当前页码(pwd_find分页返回) |
| data.info.page_size | 否 | int | 业务参数:每页数量(pwd_find分页返回) |
| data.info.pwds | 否 | array | 业务参数:密码列表(pwd_find分页返回) |
11.继电器设置
设置继电器延时时间
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "set_relay",
"info": {
"relay_time": 3000
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 继电器设置set_relay |
| data.info.relay_time | 是 | int | 继电器开启持续时间(毫秒) |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "set_relay",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
12.出门开关设置
设置出门开关状态
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "set_es",
"info": {
"es_status": 1
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 出门开关设置set_es |
| data.info.es_status | 是 | int | 出门开关状态(0=关闭, 1=开启) |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "set_es",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
13.音量设置
设置设备音量
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "set_volume",
"info": {
"volume": 80
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 音量设置set_volume |
| data.info.volume | 是 | int | 音量值0-100或1-7(自动映射到0-100) |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "set_volume",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
14.WiFi配置
配置设备WiFi
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "set_wifi",
"info": {
"ssid": "MyWiFi",
"password": "12345678"
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | WiFi设置set_wifi |
| data.info.ssid | 是 | string | WiFi SSID |
| data.info.password | 是 | string | WiFi密码 |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "set_wifi",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
15.OTA升级
OTA远程升级
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "set_ota",
"info": {
"url": "http://update.wmj.com.cn/firmware_760.0.08.bin"
}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | OTA升级set_ota |
| data.info.url | 是 | string | 固件下载URL |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "set_ota",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
16.重置设备
设备重置,恢复出厂设置
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "reset",
"info": {}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 重置命令reset |
| data.info | 是 | object | 空对象 |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "reset",
"info": {
"code": 0,
"msg": ""
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
备注
重置操作会清空所有卡片、密码、WiFi配置等
设备会恢复到出厂默认设置
操作完成后设备自动重启
17.获取门状态
获取当前门磁状态
请求URL
https://wdev.wmj.com.cn/deviceApi/send
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678",
"data": {
"cmd_type": "getdoorstate",
"info": {}
}
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
| data.cmd_type | 是 | string | 获取门状态getdoorstate |
返回示例
//成功
{
"code": 0,
"data": {
"cmd_type": "getdoorstate",
"info": {
"code": 0,
"msg": "",
"doorstate": 0,
"door_state": 0
}
}
}
//失败
{
"code": 1001,
"msg": "网络超时"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 调用接口错误码 0成功其他异常 |
| data.info.code | int | 业务错误码,0成功其他异常 |
| data.info.msg | string | 业务错误信息 |
| data.info.doorstate | int | 门状态(0=关闭, 1=打开) |
| data.info.door_state | int | 门状态(兼容字段) |
18.回调通知
通知数据将发送到用户注册的回调地址上
a. 门状态变化通知
{
"cmd_type":"door_state_notify",
"device_sn":"W76D12345678",
"info":{
"state":0
}
}
| 参数 | 类型 | 说明 |
|---|---|---|
| cmd_type | String | door_state_notify:开门状态通知 |
| device_sn | String | 通知设备SN |
| info.state | Integer | 门状态 0:关门状态 1:开门状态 |
b. 刷卡开门通知
{
"type":"card",
"device_sn":"W76D12345678",
"info":{
"uid":"27598FAF",
"status":"success"
}
}
| 参数 | 类型 | 说明 |
|---|---|---|
| type | String | card:刷卡开门 |
| device_sn | String | 通知设备SN |
| info.uid | String | 卡号 |
| info.status | String | 状态:success成功,failed失败 |
| info.reason | String | 失败原因(失败时):not_registered未注册expired已过期not_started未生效 |
c. 键盘密码开门通知
{
"type":"keypad",
"device_sn":"W76D12345678",
"info":{
"status":"success"
}
}
| 参数 | 类型 | 说明 |
|---|---|---|
| type | String | keypad:键盘密码开门 |
| device_sn | String | 通知设备SN |
| info.status | String | 状态:success成功 |
d. 设备发卡成功通知 (W766兼容格式)
{
"cmd_type":"add_card_notify",
"type":2,
"device_sn":"W76D12345678",
"info":{
"card_id":"B6DC7FA0",
"start_time":0,
"end_time":2147483647
}
}
| 参数 | 类型 | 说明 |
|---|---|---|
| cmd_type | String | add_card_notify:设备发卡通知 (兼容W766) |
| type | Integer | 2: 设备主动上报通知 |
| device_sn | String | 通知设备SN |
| info.card_id | String | 添加的卡号 |
| info.start_time | Integer | 卡片生效时间(Unix时间戳) |
| info.end_time | Integer | 卡片失效时间(Unix时间戳) |
19.解绑设备
解绑设备,将设备和appid解除绑定关系
请求URL
https://wdev.wmj.com.cn/deviceApi/logout
请求方式
POST
请求格式
json
参数
{
"app_id":"",
"app_secret":"",
"device_sn": "W76D12345678"
}
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| app_id | 是 | string | 用户app_id |
| app_secret | 是 | string | 用户app_secret |
| device_sn | 是 | string | 设备序列号 |
返回示例
//成功
{
"code": 0,
"msg": "解绑成功"
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 0成功其他异常 |
| msg | string | 描述信息 |
最后编辑:极客师傅 更新时间:2025-12-09 01:34