事件推送
注意：method参数为固定值，第三方可以根据该参数做对应格式解析
本地服务器版本：
- V1.9.0
命令值(cmd)：
- 501
####1.通用事件推送
入参说明：
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjCommonEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 |
| logTypeFlag | 1 | 否 | int | 事件Flag | 当eventType=18时有效，为空时，表示未知异常，0 按键短路，1 存储器异常，2 触摸芯片异常，3 低压检测电路异常，4 读卡电路异常，5 检卡电路异常，6 指纹通讯异常，7 RTC晶振电路异常 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| ####2.添加钥匙事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjAddKeyEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=8 表示添加钥匙事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| authorMode | 1 | 是 | int | 授权方式 | 1 有效期授权 2 周期授权 |
| beginTime | 1 | 是 | long | 授权开始时间 | 单位：秒 |
| endTime | 1 | 是 | long | 授权结束时间 | 单位：秒 |
| weeks | 1 | 否 | int | 星期数 | bit0~bit6分别表示，对应bit位数置1，则表示当天钥匙有效，bit0=1 星期一 authorMode=2 有效 |
| dayStartTimes | 1 | 否 | String | 每日起始时间 | authorMode=2 有效 |
| dayEndTimes | 1 | 否 | String | 每日结束时间 | authorMode=2 有效 |
| keyContent | 1 | 否 | String | 钥匙内容 | keyType = 2 表示密码 keyType =4 表示卡号 |
| useNum | 1 | 否 | int | 使用次数 | 0～254：表示剩余有效次数 255：表示无限次 |
| ####3.删除钥匙事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjDeleteKeyEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=9 表示删除钥匙事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| logTypeFlag | 1 | 是 | int | 删除方式 | 0 按编号删除 1 按类型删除 2 按内容删除 3 按用户ID删除 |
| keyGroupId | 1 | 否 | int | 钥匙所属用户ID | logTypeFlag=3有效 |
| keyGroupName | 1 | 否 | String | 钥匙所属用户名 | logTypeFlag=3有效 |
| keyType | 1 | 否 | int | 钥匙类型 | logTypeFlag=1 按位域置1，则删除指定钥匙类型钥匙 logTypeFlag=2 结合lockKeyId固定一个钥匙删除 |
| lockKeyId | 1 | 否 | int | 钥匙ID | logTypeFlag=0有效 |
| keyContent | 1 | 否 | int | 钥匙内容 | 适用离线密码未使用 按内容删除 |
| ####4.周期关闭事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjCycleCloseEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=49 表示周期关闭事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| beginTime | 1 | 是 | long | 授权开始时间 | 单位：秒 |
| endTime | 1 | 是 | long | 授权结束时间 | 单位：秒 |
| weeks | 1 | 否 | int | 星期数 | bit0~bit6分别表示，对应bit位数置1，则表示关闭当天的周期开锁，bit0=1 星期一 |
| ####5.周期开启事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjCycleOpenEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=48 表示周期开锁开启事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| beginTime | 1 | 是 | long | 授权开始时间 | 单位：秒 |
| endTime | 1 | 是 | long | 授权结束时间 | 单位：秒 |
| weeks | 2 | 是 | int | 星期数 | bit0~bit6分别表示，对应bit位数置1，则表示当天周期开启 例如：bit0=1 星期一 |
| dayEndTimes | 3 | 是 | String | 每日结束时间 | - |
| ####6.使能禁止钥匙事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjEnableKeyEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=28 表示使能进制设置事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| logTypeFlag | 1 | 是 | int | 使能禁止flag | logTypeFlag=1按钥匙ID使能 logTypeFlag=2按钥匙类型使能 logTypeFlag=3按用户ID使能 logTypeFlag=4按钥匙ID禁止 logTypeFlag=5按钥匙类型禁止 logTypeFlag=6按用户ID禁止 |
| keyType | 1 | 否 | int | 钥匙类型 | logTypeFlag=2 和 logTypeFlag=5 生效 |
| lockKeyId | 1 | 否 | int | 钥匙ID | logTypeFlag=1 和 logTypeFlag=4 生效 |
| keyGroupId | 1 | 否 | int | 用户ID | logTypeFlag=3 和 logTypeFlag=6 生效 |
| keyGroupName | 1 | 否 | String | 用户名 | logTypeFlag=3 和 logTypeFlag=6 生效 |
| ####7.错误开锁事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjErrorOpenEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=41 表示错误开锁事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| logTypeFlag | 1 | 是 | int | 钥匙校验结果 | 1钥匙在门锁端无法通过校验, 开锁失败 2钥匙在门锁端可以通过校验, 但门锁反锁, 钥匙无法开反锁, 开锁失败 |
| keyContent | 1 | 是 | int | 钥匙内容 | keyType=2 keyContent为密码 keyType=4 keyContent为卡号 |
| ####8.开锁事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjOpenLockEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=4 表示开锁事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| combine | 1 | 是 | int | 是否组合 | 0非组合 1组合 |
| normalOpen | 1 | 是 | int | 是否常开 | 0非常开 1常开 |
| insideOpen | 1 | 是 | int | 是否门内开锁 | 0门外 1门内 |
| keyContent1 | 1 | 否 | String | 钥匙内容 | keyType=2 keyContent1为密码 keyType=4 keyContent1为卡号 |
| keyGroupId2 | 1 | 否 | int | 用户ID | combine=1有效 |
| keyGroupName2 | 1 | 否 | String | 用户名 | combine=1有效 |
| keyType2 | 1 | 否 | int | 钥匙类型 | combine=1有效 |
| lockKeyId2 | 1 | 否 | int | 钥匙ID | combine=1有效 |
| useNum2 | 1 | 否 | int | 剩余有效次数 | combine=1有效 |
| ####9.系统参数设置推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjSystemSetEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=27 表示系统参数事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| lockOpen | 1 | 可选 | int | 开锁模式 | 1~2,1-单一开锁; 2-组合开锁 |
| normallyOpen | 1 | 可选 | int | 常开模式 | 1~2,1-常开模式启用; 2-常开模式关闭 |
| isSound | 1 | 可选 | int | 语音启闭 | 1~2,1开关门语音打开; 2开关门语音关闭 |
| sysVolume | 1 | 可选 | int | 系统音量 | 0~5,0-表示音量不可调节，其他表示音量大小 |
| isTamperWarn | 1 | 可选 | int | 防撬报警启闭 | 0无防撬报警功能; 1防撬报警启动; 2防撬报警功能关闭 |
| isLockCoreWarn | 1 | 可选 | int | 锁芯报警启闭 | 0无锁芯报警功能;1锁芯报警启动; 2锁芯报警功能关闭 |
| isLock | 1 | 可选 | int | 反锁功能启闭 | 0~2 0无反锁开关;1-反锁功能启用; 2-反锁功能关闭 |
| isLockCap | 1 | 可选 | int | 锁头盖报警启闭 | 1~2，1-启用，2关闭 |
| sysLanguage | 1 | 可选 | int | 系统语言 | 1~5,1：简体中文 2：繁体中文 3：英文 4：越南文 5：泰文 |
| ####10.按内容修改钥匙事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjUpdateKeyByContentEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=46 表示按内容修改钥匙事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| authorMode | 1 | 是 | int | 授权方式 | 1 有效期授权 2 周期授权 |
| beginTime | 1 | 是 | long | 授权开始时间 | 单位：秒 |
| endTime | 1 | 是 | long | 授权结束时间 | 单位：秒 |
| weeks | 1 | 否 | int | 星期数 | bit0~bit6分别表示，对应bit位数置1，则表示当天钥匙有效，bit0=1 星期一 authorMode=2 有效 |
| dayStartTimes | 1 | 否 | String | 每日起始时间 | authorMode=2 有效 |
| dayEndTimes | 1 | 否 | String | 每日结束时间 | authorMode=2 有效 |
| keyContent | 1 | 否 | String | 钥匙内容 | keyType = 2 表示密码 keyType =4 表示卡号 |
| useNum | 1 | 否 | int | 使用次数 | 0～254：表示剩余有效次数 255：表示无限次 |
| ####11.修改密码事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjUpdatePwEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=24 表示修改密码事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| lockKeyId | 1 | 是 | int | 钥匙ID | - |
| ####12.修改钥匙有效期事件推送 |
入参说明
| 参数名 | 层级 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| method | 1 | 是 | String | 标识方法 | 固定值：hxjUpdateKeyValidityEventPush |
| lockCode | 1 | 是 | String | 房间的门锁号 | -- |
| eventType | 1 | 是 | int | 事件类型 | 详情见附录：事件类型 eventType=34 表示修改钥匙有效期事件 |
| electricNum | 1 | 是 | int | 门锁电量 | -- |
| eventTime | 1 | 是 | long | 事件触发时间 | 单位：秒 |
| logTypeFlag | 1 | 是 | int | 修改方式 | 1 按钥匙ID修改 2 按用户ID修改 |
| authorMode | 1 | 是 | int | 授权方式 | 1 有效期授权 2 周期授权 |
| beginTime | 1 | 是 | long | 授权开始时间 | 单位：秒 |
| endTime | 1 | 是 | long | 授权结束时间 | 单位：秒 |
| weeks | 1 | 否 | int | 星期数 | bit0~bit6分别表示，对应bit位数置1，则表示当天钥匙有效，bit0=1 星期一 authorMode=2 有效 |
| dayStartTimes | 1 | 否 | String | 每日起始时间 | authorMode=2 有效 |
| dayEndTimes | 1 | 否 | String | 每日结束时间 | authorMode=2 有效 |
| keyContent | 1 | 否 | String | 钥匙内容 | keyType = 2 表示密码 keyType =4 表示卡号 |
| useNum | 1 | 否 | int | 使用次数 | 0～254：表示剩余有效次数 255：表示无限次 |
边缘网关发布Pub(示例):
{
"cmd": 命令值,
"msgId": 122321323,
"data": {
事件数据
}
}
响应参数说明：
| 参数名 | 层级 | 类型 | 条件 | 描述 | 备注 |
|---|---|---|---|---|---|
| -- | -- | -- | -- | -- | -- |
云端响应Sub(示例):
{
"cmd": 命令值,
"msgId": 122321323,
"rslt": "状态码:0成功,其他失败",
"rsn": "原因",
"data": {
}
}