简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

消息类型

更新时间:2022-09-22 06:40:17下载pdf

数据格式

消息类型

业务数据

协议号

不同协议号代表不同的功能。

协议号 描述
4 设备状态数据上报事件
20 设备上线
20 设备离线
20 修改设备名称
20 修改设备功能点名称
20 设备绑定用户
20 删除设备
20 设备升级状态
25 场景执行
40 户外告警消息推送
43 设备物联网卡停机
43 设备物联网卡流量预警
45 三方音箱语音播报
45 三方音箱重置
45 自定义问答数据变更
46 下发人员入住
46 下发人员退房

设备状态数据上报

  • data 数据体说明

    code 数据类型 描述
    dataId String 该条上报数据的唯一标识 ID,无业务含义
    devId String 设备 ID
    productKey String 设备所属的产品 ID
    status List<StatusItem> 该次设备状态数据上报集

    StatusItem 说明

    code 数据类型 描述
    code String 设备状态上报 code
    value Object 设备状态上报 code 的状态值
    t Long 设备状态上报时间戳,13 位
    “{dpId}”:“{dpValue}” String:String “数据点编码(产品定义时对应的数据点编码)”:“数据点对应的值”。开发者可选使用产品定义。
  • 数据示例

    {
    "dataId":"AAXI3c1i6xxx***",
    "devId":"6c95a93fd9xxx***",
    "productKey":"awgmk9pixxx***",
    "status":[
        {
            "code":"switch_1",
            "value":false,
            "t":1628229842692,
            "1":"false"
        }
    ]
    }
    

设备上线

  • bizData 说明

    code 数据类型 描述
    time Long 时间戳
  • 数据示例

    {
      "devId": "002dj00118fe34d9****",
      "productKey": "涂鸦 IoT 开发平台定义产品对应的产品 Key",
      "bizCode": "online",
      "bizData": {
        "time": 146052438362
      }
    }
    

设备离线

  • bizData说明

    code 数据类型 描述
    time Long 时间戳
  • 数据示例

      {
        "devId": "002dj00118fe34d9****",
        "productKey": "涂鸦 IoT 开发平台定义产品对应的产品 Key",
        "bizCode": "offline",
        "bizData": {
          "time": 146052438362
        }
      }
    

修改设备名称

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    name String 设备名称
  • 数据示例

    {
      "devId": "002dj00118fe34d9****",
      "productKey": "涂鸦 IoT 开发平台定义产品对应的产品 Key",
      "bizCode": "nameUpdate",
      "bizData": {
        "devId": "002dj00118fe34d9****",
        "name": "new name"
      }
    }
    

修改设备功能点名称

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    name String DP 名称
    dpId String 功能点 ID
  • 数据示例

    {
      "devId": "002dj00118fe34d9****",
      "productKey": "涂鸦 IoT 开发平台定义产品对应的产品 Key",
      "bizCode": "dpNameUpdate",
      "bizData": {
        "devId": "002dj00118fe34d9****",
        "name": "new name",
        "dpId": "dpId"
      }
    }
    

设备绑定用户

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    uuid String 设备硬件唯一标识
    uid String 设备绑定人
    token String 设备配网 Token
  • 数据示例

    {
      "devId": "002dj00118fe34d9****",
      "productKey": "涂鸦 IoT 开发平台定义产品对应的产品 Key",
      "bizCode": "bindUser",
      "bizData": {
        "devId": "002dj00118fe34d9****",
        "uuid": "06200043b4e618c1****",
        "uid":"ay1529485403390****",
        "token": "IIpQ****"
      }
    }
    

删除设备

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    uid String 设备绑定人
  • 数据示例

    {
      "devId": "002dj00118fe34d9****",
      "productKey": "涂鸦 IoT 开发平台定义产品对应的产品 Key",
      "bizCode": "delete",
      "bizData": {
        "devId": "002dj00118fe34d9****",
        "uid":"ay1529485403390S****"
      }
    }
    

设备升级状态

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    moduleType Int 模块类型:
    • 0:Wi-Fi
    • 1:Bluetooth LE
    • 2:GPRS
    upgradeStatus Int 升级状态:
    • 1:准备升级
    • 2:升级中
    • 3:升级完成
    • 4:升级异常
    • 7:超时异常
    description String 升级描述
    oldVersion String 旧版固件
    newVersion String 升级固件
  • 数据示例

    {
        "bizCode":"upgradeStatus",
        "bizData": {
            "devId":"6ca8756d*****1b4ewsdn",  
            "moduleType":0,
            "upgradeStatus":2,
            "description":"升级测试",
            "oldVersion": "1.0.1",
            "newVersion": "1.0.2"         
        },
        "devId":"6ca8756d*****1b4ewsdn",
        "productKey":"vFHpaEFwu8UD****",
        "ts":1562232522192
    }
    

场景执行

  • bizData 说明

    code 数据类型 描述
    name String 场景名称
    id String 场景 ID
    gid Long 家庭 ID
    uid String 场景添加人 UID
    ts Long 消息投递时间戳
    actions.entityId String 实体 ID
    actions.execStatus Integer 状态:
    • -1:默认
    • 0:失败
    • 1:成功
    • 2:待执行
    • 3:无需执行
    actions.executeTime Long 执行时间(时间戳)
    actions.id String 动作 ID
    actions.errorMsg String 错误信息
  • 数据示例

    {
       "bizData":{
        "name":"开关-开启",
        "id":"azmQ2w8kPSCdcr***",
        "actions":[
            {
                "entityId":"02167073cc****",
                "execStatus":1,
                "executeTime":1625798044277,
                "id":"1jPxz3zaNdL****"
            }
        ]
      },
     "gid":37081***,
     "uid":"ay1622715182388N****",
     "ts":1625798044298
    }
    

户外告警消息推送

  • bizData 说明

    code 数据类型 描述
    automationId String 自动化 ID
    bizData JSON 自定义数据,结合 POST/v1.0/homes/{home_id}/automations/{automation_id}/conditions/trigger 使用
  • 数据示例

    {
        "automationId":"Rc5XAKLSmwpxH***",
        "bizCode":"automationExternalAction",
        "bizData":{
            "code":"mode",
            "value":2,
            "operator":"=="
        }
    }
    

设备物联网卡停机

  • bizData 说明

    code 数据类型 描述
    iccid String SIM 卡 ID
    deviceId String 设备 ID
    uid String 用户 ID
    pid String 产品 ID
    stopReason String SIM 卡停机原因:
    • PACKAGE_EXHAUSTED:流量耗尽
    • EXPIRE_PACKAGE:套餐过期
    • INVOKE:****:业务方调用
    • UNBIND_PACKAGE:套餐解绑
    • UNSUBSCRIBE_PACKAGE:退订套餐
    reportTime Long 上报时间(时间戳)
  • 数据示例

    {
       "bizCode":"simStop",
       "bizData":{
        "iccid": "****",
        "deviceId": "****",
        "uid": "****",
        "pid": "****",
        "stopReason": "FLOW_OUT",
        "reportTime": 1620896040128
      },
     "ts":1625798044298
    }
    

设备物联网卡流量预警

  • bizData 说明

    code 数据类型 描述
    iccid String SIM 卡 ID
    deviceId String 设备 ID
    uid String 用户 ID
    pid String 产品 ID
    totalFlowAmount String 可用总量
    usedFlowAmount String 已使用量
    reportTime Long 上报时间(时间戳)
  • 数据示例

    {
       "bizCode":"simLimitAlarm",
       "bizData":{
        "iccid": "xxxx",
        "deviceId": "xxxx",
        "uid": "xxxx",
        "pid": "xxxx",
        "totalFlowAmount": 10240,
        "usedFlowAmount": 1024,
        "reportTime": 1620896040128
      },
     "ts":1625798044298
    }
    

三方音箱语音播报

  • bizData 说明

    code 数据类型 描述
    brandCode String 音箱设备品牌编码
    voiceId String 音箱设备 ID
    command Array 指令
  • command 说明

    code 数据类型 描述
    intent String 意图,比如 welcome 可以表示欢迎语播报
    content Object 指令内容
  • content 说明

    code 数据类型 描述
    value String 播报的文字
  • 数据示例

    {
        "bizCode":"textToSpeech",
        "bizData":{
            "brandCode":"abc*******",
            "voiceId":"def*******",
            "command": [{ 
                "intent": "welcome",
                "content":{
                    "value": "欢迎入住本酒店"
                }
            }]
        },
        "ts":1636682568127
    }
    

三方音箱重置

  • 消息说明

    删除三方音箱的绑定关系或入住人退房时会发送该消息,语音平台收到该消息后应该清除音箱的使用记录或缓存。

  • bizData 说明

    code 数据类型 描述
    brandCode String 音箱设备品牌编码
    voiceId String 音箱设备 ID
  • 数据示例

    {
        "bizCode":"reset",
        "bizData":{
            "brandCode":"abc*******",
            "voiceId":"def*******"
        },
        "ts":1636682568127
    }
    

自定义问答数据变更

  • bizData 说明

    code 数据类型 描述
    spaceId String 空间 ID
    brandCodeList List 音箱品牌编码列表
  • 数据示例

    {
        "bizCode":"customQAChange",
        "bizData":{
            "spaceId":"123*********",
            "brandCodeList":["abc*******","def*******"]
        },
        "ts":1636682568127
    }
    

下发人员入住

  • bizData 说明

    code 数据类型 描述
    hotel_code String 酒店物业管理系统(PMS)厂家旗下门店唯一编码
    customer_id String 用户 ID
    start_time Long 入住开始时间,值为时间戳
    end_time Long 入住结束时间,值为时间戳
    current_room_path String[] 当前房间关联的多层级路径
  • 数据示例

    {
    "bizCode":"hotelPmsCustomerCheckin",
    "bizData":{
        "hotel_code":"xxxx",
        "customer_id":"xxxx",
        "start_time":1655287277055,
        "end_time":1663236077000,
        "current_room_path":[
            "一幢",
            "一单元",
            "6层",
            "603"
        ]
    },
    "ts":1638943452529
    }
    

下发人员退房

  • bizData 说明

    code 数据类型 描述
    hotel_code String 酒店物业管理系统(PMS)厂家旗下门店唯一编码
    customer_id String 用户 ID
    start_time Long 入住开始时间,值为时间戳
    end_time Long 入住结束时间,值为时间戳
    current_room_path String[] 当前房间关联的多层级路径
  • 数据示例

    {
    "bizCode":"hotelPmsCustomerCheckout",
    "bizData":{
        "hotel_code":"****",
        "customer_id":"****",
        "start_time":1655287277055,
        "end_time":1663236077000,
        "current_room_path":[
            "一幢",
            "一单元",
            "6层",
            "603"
        ]
    },
    "ts":1638943452529
    }