Tuya.com
简体中文
English
注册
登录 IoT 平台
简体中文
English
注册
登录 IoT 平台
涂鸦 IoT 开发平台
search
根据文档目录筛选
涂鸦 IoT 开发平台云开发消息队列消息类型

消息类型

更新时间：2023-10-18 03:15:06下载pdf

涂鸦物联网消息队列，是基于云端业务数据的流转而产生的消息。涂鸦定义了 bizCode（动作），用来区分不同的消息，例如 设备属性上报 的 bizCode 为 devicePropertyMessage。本文介绍了典型 bizCode 的流转过程，和所有已公开的 bizCode 的详细数据格式。

格式说明

消息队列的数据格式分为两层：

  • 第一层：
    • protocol：协议号。
    • pv：协议版本。
    • t：推送给开发者的系统时间。
    • data：推送给开发者的业务数据。
    • sign：防伪造校验的消息签名。
      其中最关键的 protocol，是比 bizCode 粒度更粗的分类信息，可以帮助您做初步的消息分流。
  • 第二层：data 数据，需要您解密后才能使用。解密后的内容，是一个键值对（key-value）结构的 JSON 字符串。

两层数据的格式如下图所示：

消息类型
  • #msg 和解密后的 #msg.data 都是 JSON 格式。
  • 随着业务升级，涂鸦可能会增加键值对至 #msg 和 #msg.data JSON 结构体中。请确保当增加 key-value 键值对属性时，您的代码处理逻辑不会受到影响。

协议号列表

消息队列中，不同协议号（protocol）代表不同的功能。

选择协议号版本

本文列举了两种版本的协议号：

  • IoT Core 协议号：涂鸦于 2023 年 6 月 20 日升级了 IoT Core 连接服务，详情请参考 云服务 API 调整说明。新版 IoT Core 连接服务包含设备、空间相关的通用底层 API，同时提供了与之配套的消息推送协议。

  • 旧版本协议号：包含家庭、资产、和部分垂直领域配套的消息协议号。

    例如，IoT Core 协议号 1001 推送的 deviceOnline 和旧版本协议号 20 推送的 online，均表示设备上线，只是推送的数据内容不同。

您可以根据具体的云服务来选择消息推送协议。如果您配置了两种推送协议，可能会造成重复接收和处理。如果您同时需要使用两种版本消息，请参考 配置消息推送规则 配置消息的接收。

IoT Core 协议号

业务模块 协议号 bizCode 适用于
设备上报 1000
  • devicePropertyMessage：设备属性上报
  • deviceQueryPropertyMessage：设备属性查询上报
  • deviceEventMessage：设备事件上报
  • deviceActionResponseMessage：设备动作调用
IoT Core
设备管理 1001
  • deviceOnline：设备上线
  • deviceOffline：设备离线
  • deviceTransfer：设备转移
  • deviceFreeze：设备冻结
  • deviceUnFreeze：设备解冻
  • deviceBindSpace：设备绑定
  • deviceUnbindSpace：设备解绑
  • deviceNameUpdate：设备名称变更
IoT Core
设备 OTA 升级 1002
  • deviceOtaProgress：设备固件 OTA 升级
IoT Core
空间 1010
  • spaceCreate：空间创建
  • spaceRemove：空间删除
  • spaceUpdate：空间名称变更
IoT Core
群组 1020
  • groupCreate：群组创建
  • groupDelete：群组删除
  • groupNameUpdate：群组名称变更
  • groupDeviceAdd：群组下设备添加
  • groupDeviceRemove：群组下设备移除
IoT Core
联动规则 1030
  • linkageRuleChangeComplete：联动规则变更
  • linkageRuleExecuteComplete：联动规则执行
IoT Core

旧版本协议号

以下旧版本协议号仅供参考。

业务模块 协议号 bizCode 适用于
设备上报 4
  • 无 bizCode：设备状态数据上报事件
旧版本
设备管理 20
  • online：设备上线
  • offline：设备离线
  • nameUpdate：修改设备名称
  • dpNameUpdate：修改设备功能点名称
  • bindUser：设备绑定用户
  • delete：删除设备
  • upgradeStatus：设备升级状态
旧版本
物联网卡 43
  • simStop：设备物联网卡停机
  • simLimitAlarm：设备物联网卡流量预警
旧版本
三方音箱 45
  • textToSpeech：三方音箱语音播报
  • reset：三方音箱重置
  • customQAChange：自定义问答数据变更
旧版本
自动化 25
  • automationExecute：自动化执行
  • automationEnable：自动化开启
  • automationUpdate：自动化修改
  • automationAdd：自动化添加
  • automationDisable：自动化关闭
  • automationRemove：自动化删除
旧版本
自动化外部动作 22
  • automationExternalAction：自动化外部动作
旧版本
场景 25
  • sceneAdd：场景添加
  • sceneUpdate：场景修改
  • sceneRemove：场景删除
  • sceneEnable：场景开启
  • sceneDisable：场景关闭
  • sceneExecute：场景执行
  • scenesStrategyModify：场景规则变化
旧版本
行业资产 13001
  • industryAssetDeviceBind：行业资产下设备绑定
  • industryAssetDeviceUnbind：行业资产下设备解绑
  • industryAssetChange：行业资产变更
旧版本
安防设备 30
  • preArm：进入布防
  • armed：布防完成
  • disarm：撤防
  • preAlarm：进入报警倒计时
  • cancelAlarm：取消报警
旧版本
红外 50
  • infraredLearnMessage：红外学习保存消息推送
旧版本
设备信息通知 20
  • event_notify：设备信息变更
旧版本
用户属性 32
  • userProperty：用户拓展属性变更事件
旧版本
电子地理围栏 40
  • outdoorsFenceAlarm：电子地理围栏告警
旧版本
用户事件 54
  • userRegisterEvent：用户注册事件
  • userUpdateEvent：用户变更事件
  • userDeleteEvent：用户注销事件，目前注销 7 天后发送用户注销消息
旧版本
家庭事件 35
  • homeCreate：家庭创建
  • homeUpdate：家庭修改
  • homeDelete：家庭删除
  • homeMemberSharing：家庭成员邀请
  • homeMemberUpdate：家庭成员修改
  • homeMemberDelete：家庭成员删除
 旧版本
房间事件 34
  • roomCreate：房间创建
  • roomBatchCreate：批量创建房间
  • roomDelete：房间删除
  • roomSort：房间排序
  • roomNameUpdate：房间名称修改
 旧版本

IoT Core 事件

设备上报（protocol 1000）

设备属性上报

  • bizData 数据体说明

    code 数据类型 描述
    dataId String 该条上报数据的唯一标识 ID，无业务含义
    devId String 设备 ID
    productId String 设备所属的产品 ID
    properties List<PropertyItem> 该次设备属性数据上报集

    PropertyItem 说明

    code 数据类型 描述
    code String 设备属性上报 code
    value String 设备属性上报值
    dpId String 功能点 ID
    time Long 设备属性上报时间戳，13 位

  • 数据示例

    {
    "bizCode": "devicePropertyMessage",
    "bizData": {
    "dataId": "1635186469981261***",
    "devId": "263a15c90bc83eff35***",
    "productId": "ejhcgtdtgtcuh***",
    "properties": [
            {
        "code": "property",
        "dpId": 101,
        "time": 1678693809396,
        "value": "red"
            }
        ]
    },
    "ts": 1678693809396
}

设备属性查询上报

与 设备属性上报 不同的是，查询上报是指云端或者 App 希望主动感知设备状态，向设备发送指令，设备收到对应指令后，发起一次上报。

  • bizData 数据体说明

    code 数据类型 描述
    dataId String 该条上报数据的唯一标识 ID，无业务含义
    devId String 设备 ID
    productId String 设备所属的产品 ID
    properties List<PropertyItem> 该次设备属性数据上报集

    PropertyItem 说明

    code 数据类型 描述
    code String 设备属性上报 code
    value String 设备属性上报值
    dpId String 功能点 ID
    time Long 设备属性上报时间戳，13 位

  • 数据示例

    {
    "bizCode": "deviceQueryPropertyMessage",
    "bizData": {
    "dataId": "1635186469981261***",
    "devId": "263a15c90bc83eff35***",
    "productId": "ejhcgtdtgtcuh***",
    "properties": [
            {
        "code": "property",
        "dpId": 101,
        "time": 1678693809396,
        "value": "red"
            }
        ]
    },
    "ts": 1678693809396
}

设备上报事件

  • bizData 数据体说明

    code 数据类型 描述
    dataId String 该条上报数据的唯一标识 ID，无业务含义
    devId String 设备 ID
    productId String 设备所属的产品 ID
    eventCode String 设备事件 code
    time Long 设备事件上报时间戳，13 位
    outputParams List<OutputParamsItem> 该次设备事件数据上报集

    OutputParamsItem 说明

    code 数据类型 描述
    code String 输出参数名称
    value String 输出参数值

  • 数据示例

    {
    "bizCode": "deviceEventMessage",
    "bizData": {
    "dataId": "1635186587996393***",
    "devId": "263a15c90bc83eff35***",
    "eventCode": "event",
    "outputParams": [
            {
                "code": "event_1",
                "value": "true"
            }
        ],
    "productId": "ejhcgtdtgtcuh***",
    "time": 1678693837533
    },
    "ts": 1678693837789
}

设备调用动作事件

  • bizData 数据体说明

    code 数据类型 描述
    dataId String 该条上报数据的唯一标识 ID，无业务含义
    devId String 设备 ID
    productId String 设备所属的产品 ID
    actionCode String 设备动作 code
    time Long 设备调用动作时间戳，13 位
    responseCode String 结果：
    • 0：成功
    • 非 0：失败
    status String 动作执行状态：
    • SUCCESS：成功
    • TIME_OUT：超时

  • 数据示例

    {
    "bizCode": "deviceActionResponseMessage",
    "bizData": {
    "actionCode": "action_code",
    "dataId": "1443433584600440***",
    "devId": "263a15c90bc83eff35***",
    "productId": "ejhcgtdtgtcuh***",
    "responseCode": 0,
    "status": "SUCCESS",
    "time": 1678693877497
    },
    "ts": 1678693878088
}

设备管理（protocol 1001）

设备上线

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    uid String 设备配网用户 ID
    time Long 设备上线时间戳，13 位

  • 数据示例

        {
        "bizCode": "deviceOnline",
        "bizData": {
        "devId": "6c0946b2fff7b98d6em***",
        "uid": "ay1638425579033A1***",
        "productId": "jv19g49qohpo8***",
        "time": 1678952060301
        },
        "ts": 1678952060418
    }

设备离线

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    uid String 设备配网用户 ID
    time Long 设备离线时间戳，13 位

  • 数据示例

        {
        "bizCode": "deviceOffline",
        "bizData": {
        "devId": "6c0946b2fff7b98d6em***",
        "uid": "ay1638425579033A1***",
        "productId": "jv19g49qohpo8***",
        "time": 1678951891724
        },
        "ts": 1678951891733
    }

设备转移

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    spaceId String 目标空间 ID
    fromSpaceId String 源空间 ID

  • 数据示例

     {
    "bizCode": "deviceTransfer",
    "bizData": {
    "devId": "6c0946b2fff7b98d6em***",
    "spaceId": "151481***",
    "productId": "jv19g49qohpo8***",
    "fromSpaceId": "151482***"
    },
    "ts": 1678952218298
}

设备冻结

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    uid String 设备配网用户 ID
    spaceId String 空间 ID

  • 数据示例

    {
    "bizCode": "deviceFreeze",
    "bizData": {
    "devId": "6c0946b2fff7b98d6em***",
    "uid": "ay1638425579033A1***",
    "spaceId": "151481***",
    "productId": "jv19g49qohpo8***"
    },
    "ts": 1678952317535
}

设备解冻

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    uid String 设备配网用户 ID
    spaceId String 空间 ID

  • 数据示例

    {
    "bizCode": "deviceUnFreeze",
    "bizData": {
    "devId": "6c0946b2fff7b98d6em***",
    "uid": "ay1638425579033A1***",
    "spaceId": "151481***",
    "productId": "jv19g49qohpo8***"
    },
    "ts": 1678952314832
}

设备绑定

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    uid String 设备配网用户 ID
    spaceId String 空间 ID
    uuid String 设备硬件唯一标识
    token String 设备配网 Token

  • 数据示例

    {
    "bizCode": "deviceBindSpace",
    "bizData": {
    "devId": "6c0946b2fff7b98d6em***",
    "uid": "ay1638425579033A1***",
    "spaceId": "151481***",
    "productId": "jv19g49qohpo8***",
    "uuid": "ca4ad1cb06be1***",
    "token": "RuUWe***"
    },
    "ts": 1678952059739
}

设备解绑

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    uid String 设备配网用户 ID
    spaceId String 空间 ID
    sub String 判断是否为子设备：
    • true：是
    • false：不是
    resetFactory String 是否恢复出厂设置
    uuid String 设备硬件唯一标识

  • 数据示例

    {
    "bizCode": "deviceUnbindSpace",
    "bizData": {
    "devId": "6c0946b2fff7b98d6em***",
    "uid": "ay1638425579033A1***",
    "spaceId": "151481***",
    "sub": false,
    "resetFactory": false,
    "productId": "jv19g49qohpo8***",
    "uuid": "ca4ad1cb06be1***"
    },
    "ts": 1678951891665
}

设备名称变更事件

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    productId String 设备所属的产品 ID
    uid String 设备配网用户 ID
    name String 名称
    uuid String 设备硬件唯一标识

  • 数据示例

    {
    "bizCode": "deviceNameUpdate",
    "bizData": {
    "devId": "6c0946b2fff7b98d6em***",
    "uid": "ay1638425579033A1***",
    "productId": "jv19g49qohpo8***",
    "name": "更换名称***",
    "uuid": "ca4ad1cb06be1***"
    },
    "ts": 1678952636853
}

设备 OTA 升级（protocol 1002）

设备 OTA 升级事件

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    upgradeStatus String 升级状态：
    • 0：无升级
    • 1：设备准备就绪
    • 2：升级中
    • 3：升级完成
    • 4：升级异常
    • 7：升级超时
    channel String 通道号：
    • 0：主联网固件通道号
    • 1：蓝牙固件通道号
    • 3：Zigbee 固件通道号
    • 6：Thread 固件通道号
    • 9：MCU 固件通道号
    • 10~19：扩展通道

  • 数据示例

    {
    "bizCode": "deviceOtaProgress",
    "bizData": {
    "devId": "6c622fa1f003b84e74i***",
    "upgradeStatus": 2,
    "channel": 0
    },
    "ts": 1678703050654
}

空间（protocol 1010）

空间新增

  • bizData 数据体说明

    code 数据类型 描述
    spaceId String 空间 ID
    name String 名称

  • 数据示例

    {
    "bizCode": "spaceCreate",
    "bizData": {
    "spaceId": 152082***,
    "name": "校园空间"
    },
    "ts": 1678691050625
}

空间删除

  • bizData 数据体说明

    code 数据类型 描述
    spaceId String 空间 ID

  • 数据示例

    {
    "bizCode": "spaceRemove",
    "bizData": {
    "spaceId": 152082***
    },
    "ts": 1678691097671
}

空间名称变更

  • bizData 数据体说明

    code 数据类型 描述
    spaceId String 空间 ID
    name String 名称

  • 数据示例

    {
    "bizCode": "spaceUpdate",
    "bizData": {
        "spaceId": 152082***,
    "name": "校园空间"
    },
    "ts": 1678691092910
}

群组（protocol 1020）

创建群组

  • bizData 说明

    code 数据类型 描述
    groupId Long 群组 ID
    spaceId String 空间 ID
    name String 名称
    time Long 群组创建时间戳，13 位

  • 数据示例

    {
    "bizCode": "groupCreate",
    "bizData": {
    "spaceId": "151482***",
    "groupId": "12898***",
    "name": "家庭群组",
    "time": 1678950226742
    },
    "ts": 1678950226751
}

删除群组

  • bizData 说明

    code 数据类型 描述
    groupId Long 群组 ID
    spaceId String 空间 ID
    time Long 群组删除时间戳，13 位

  • 数据示例

    {
    "bizCode": "groupDelete",
    "bizData": {
    "spaceId": "151482***",
    "groupId": "12898***",
    "time": "1678950436076"
    },
    "ts": 1678950436087
}

修改群组

  • bizData 说明

    code 数据类型 描述
    groupId Long 群组 ID
    spaceId String 空间 ID
    name String 名称
    time Long 群组修改时间戳，13 位

  • 数据示例

    {
    "bizCode": "groupNameUpdate",
    "bizData": {
    "spaceId": "151482***",
    "groupId": "12898***",
    "name": "家庭群组",
    "time": "1678950411961"
    },
    "ts": 1678950411998
}

群组下添加设备

  • bizData 说明

    code 数据类型 描述
    groupId Long 群组 ID
    spaceId String 空间 ID
    devIds List 设备列表
    time Long 群组添加设备时间戳，13 位

  • 数据示例

    {
    "bizCode": "groupDeviceAdd",
    "bizData": {
    "spaceId": "151482***",
    "groupId": "12898***",
    "devIds": ["vdevo167756814561***"],
    "time": "1678950226762"
    },
    "ts": 1678950226775
}

群组下设备移除

  • bizData 说明

    code 数据类型 描述
    groupId Long 群组 ID
    spaceId String 空间 ID
    devIds List 设备列表
    time Long 群组移除设备时间戳，13 位

  • 数据示例

    {
    "bizCode": "groupDeviceRemove",
    "bizData": {
    "spaceId": "151482***",
    "groupId": "12898***",
    "devIds": ["vdevo166382916152***"],
    "time": "1678950430449"
    },
    "ts": 1678950430462
}

联动规则（protocol 1030）

联动规则变更

  • bizData 说明

    code 数据类型 描述
    ruleId Long 规则 ID
    eventCode String 变更编码：
    • add：新增
    • modify：变更
    • remove：删除
    • disable：禁用
    • enable：启用
    • state：运行类型变更
    time Long 规则变更事件时间戳，13 位
    eventData EventData 规则数据，返回 "eventCode": "state" 时有该值

    EventData 说明

    code 数据类型 描述
    runMode String 运行类型：
    • local：本地联动
    • lan：局域网联动
    • cloud：云端联动

  • 数据示例

    {
    "bizCode": "linkageRuleChangeComplete",
    "bizData": {
    "eventCode": "add",
    "time": 1678950742932,
    "ruleId": "t7sFRCpcMOjsv***"
    },
    "ts": 1678950744321
}

  • eventCode: state

    数据示例

    {
    "bizCode": "linkageRuleChangeComplete",
    "bizData": {
    "eventCode": "state",
    "eventData": {
            "runMode": "local"
    },
    "time": 1678950743000,
    "ruleId": "t7sFRCpcMOjsv***"
    },
    "ts": 1678950744509
}

联动规则执行事件

  • bizData 说明

    code 数据类型 描述
    eventId String 该条上报数据的唯一标识 ID，无业务含义
    ruleId String 规则 ID
    spaceId String 空间 ID
    triggerEntityId String 触发人用户 ID
    startTime Long 规则执行开始时间戳，13 位
    endTime Long 规则执行结束时间戳，13 位
    status Long 状态：
    • success：执行成功
    • fail：执行失败
    • noMatch：条件不匹配

  • 数据示例

    {
    "bizCode": "linkageRuleExecuteComplete",
    "bizData": {
    "eventId": "6412c16547a0a2001f499***_t7sFRCpcMOjsv***",
    "spaceId": "151482***",
    "startTime": 1678950757833,
    "endTime": 1678950757874,
    "triggerEntityId": "bay1618908218427P***",
    "ruleId": "t7sFRCpcMOjsv***",
    "status": "success"
    },
    "ts": 1678950757902
}

旧版本事件

设备上报（protocol 4）

设备状态数据上报

  • 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
    • dpId：数据点编码，即产品定义时对应的数据点编码
    • dpValue：数据点对应的值

  • 数据示例

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

设备管理（protocol 20）

设备上线

  • 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：低功耗蓝牙
    • 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
}

物联网卡（protocol 43）

设备物联网卡停机

  • 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
}

三方音箱（protocol 45）

三方音箱语音播报

  • 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
}

自动化（protocol 25）

自动化执行

  • bizData 说明

    code 数据类型 描述
    gid Long 联动 ID
    uid String 用户 ID
    id String 规则编码
    name String 规则名称
    ts Long 时间戳
    actions List 动作列表

    Action 说明

    code 数据类型 描述
    id String 动作 ID
    execStatus Integer 执行状态：
    • -1：默认
    • 0：失败
    • 1：成功
    • 2：待执行
    • 3：无需执行
    entityId String 实体 ID
    executeTime Long 执行时间戳，13 位

  • 数据示例

    {
    "bizCode":"automationExecute",
    "bizData":{
        "name":"如果 定时:15:28 6 月 20 日",
        "id":"SnKfREPRAA1V****",
        "actions":[
            {
                "entityId":"6c77824debdfd0ae55****",
                "execStatus":1,
                "executeTime":1687246080261,
                "id":"nAawbkQwgYn5iAgA****"
            }
        ]
    },
    "gid":4494****,
    "ts":1687246080541,
    "uid":"ay1638425579033A****"
}

自动化外部动作（protocol 22）

  • 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":"=="
    }
}

场景（protocol 25）

场景执行

  • 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
}

行业资产（protocol 13001）

行业资产下设备绑定

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    assetId String 资产 ID
    uuid String 设备硬件唯一标识
    token String 设备配网 Token

  • 数据示例

    {
    "bizCode":"industryAssetDeviceBind",
    "bizData":{
        "devId":"vdevo16872466190****",
        "assetId":"15845****",
        "uuid":"vdevo16872466190****",
        "token":""
    },
    "ts":1687246619772
}

行业资产下设备解绑

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    assetId String 资产 ID
    uuid String 设备硬件唯一标识

  • 数据示例

    {
    "bizCode":"industryAssetDeviceUnbind",
    "bizData":{
        "devId":"vdevo16872466190****",
        "assetId":"15845****",
        "uuid":"vdevo16872466190****"
    },
    "ts":1687246961902
}

行业资产变更

  • bizData 说明

    code 数据类型 描述
    assetId String 资产 ID
    eventTime String 事件时间戳，13 位
    assetName String 资产名称
    eventType String 事件类型：
    • add：新增资产
    • update：修改资产名称
    • delete：删除资产

  • 数据示例

    {
    "bizCode":"industryAssetChange",
    "bizData":{
        "assetId":"15845****",
        "eventTime":1687247065523,
        "assetName":"my asset",
        "eventType":"add"
    },
    "ts":1687247065715
}

红外（protocol 50）

资产下设备解绑

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    eventType String 事件类型：
    • INFRARED_LEARN：红外学习
    learnCodeList List<CodeItem> 红外学习码列表

    CodeItem 说明

    code 数据类型 描述
    id Long 学习码主键
    code String 学习码
    keyName String 按键描述
    name String 按键名称

  • 数据示例

    {
    "bizCode":"infraredLearnMessage",
    "bizData":{
        "devId":"6c26d974ed10c1f894****",
        "eventType":"INFRARED_LEARN",
        "learnCodeList":{
            "id":4416011,
            "code":"015202f40172f401b****",
            "keyName":"电源",
            "name":"power"
        }
    },
    "ts":1620896040128
}

电子地理围栏（protocol 40）

电子地理围栏告警

  • bizData 说明

    code 数据类型 描述
    devId String 设备 ID
    tag String 维度标签
    fenceId Long 围栏 ID
    fenceName String 围栏名称
    bindType Integer 围栏绑定类型
    • 1：私有围栏
    • 2：公共围栏
    lat Double 当前设备上报纬度
    lon Double 当前设备上报经度
    triggerType String 触发告警类型
    • 1：进围栏
    • 2：出围栏
    reportTime Long 设备上报 13 位时间戳

  • 数据示例

    {
"bizCode":"outdoorsFenceAlarm",
"bizData":{
    "devId":"ay1617****",
    "tag":"*******",
    "fenceId":1000,
    "fenceName":"MyFence",
    "bindType":1,
    "lat":121.234,
    "lon":34.3478,
    "triggerType":"1",
    "reportTime":1620896040128
},
"ts":1620896040128
}

用户事件（protocol 54）

用户注册事件

  • bizData 说明

    code 数据类型 描述
    uid String 用户 ID
    regFrom Integer 注册来源：
    • 0：邮箱注册
    • 1：手机注册
    • 2：其它方式注册
    • 9：第三方 UID
    mobile String 手机号
    nickname String 昵称
    phoneCode String 区号
    timezoneId String 时区 ID
    lang String 多语言
    gmtCreate Long 用户创建时间
    gmtModified Long 用户信息修改时间
    headPic String 头像地址
    username String 用户名称
    lastLoginTime Long 上次登陆时间

  • 数据示例

    {
"bizCode": "userRegisterEvent",
"bizData": {
	"uid": "ay1695****e66",
	"regFrom": 9,
	"mobile": "",
	"nickname": "****",
	"phoneCode": "86",
	"timezoneId": "",
	"lang": "",
	"gmtCreate": 1695625445,
	"gmtModified": 1695710138,
	"headPic": "****",
	"username": "****",
	"lastLoginTime": 1695625445581
},
"ts": 1687246619772
}

用户更新事件

  • bizData 说明

    code 数据类型 描述
    uid String 用户 ID
    regFrom Integer 注册来源：
    • 0：邮箱注册
    • 1：手机注册
    • 2：其它方式注册
    • 9：第三方 UID
    mobile String 手机号
    nickname String 昵称
    phoneCode String 区号
    timezoneId String 时区 ID
    lang String 多语言
    gmtCreate Long 用户创建时间
    gmtModified Long 用户信息修改时间
    headPic String 头像地址
    username String 用户名称
    lastLoginTime Long 上次登陆时间

  • 数据示例

      {
    "bizCode": "userUpdateEvent",
    "bizData": {
        "lastLoginTime": 1695625445581,
        "uid": "ay1695****e66",
        "regFrom": 9,
        "gmtModified": 1695710138,
        "mobile": "",
        "nickname": "****",
        "phoneCode": "86",
        "timezoneId": "",
        "lang": "",
        "gmtCreate": 1695625445,
        "headPic": "****",
        "username": "****"
    },
    "ts": 1687246619772
}

用户注销事件

  • bizData 说明

    code 数据类型 描述
    uid String 用户 ID

  • 数据示例

    {
    "bizCode": "userDeleteEvent",
    "bizData": {
        "uid": "ay1695****e66"
    },
    "ts": 1687246619772
}

家庭事件（protocol 35）

创建家庭

  • bizData 说明

    code 数据类型 描述
    uid String 用户 ID
    homeId String 家庭 ID
    homeName String 家庭名称

  • 数据示例

    {
    "bizCode": "homeCreate",
    "bizData": {
        "uid": "ay16957***0ZXwQ7",
        "homeName": "我的家***",
        "homeId": "***"
    },
    "ts": 1695712142936
}

更新家庭

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    homeName String 家庭名称
    lon Double 经度
    lat Double 纬度

  • 数据示例

      {
  "bizCode": "homeUpdate",
  "bizData": {
  	"lon": xxxx,
  	"lat": xxxx,
  	"homeName": "我的家***",
  	"homeId": "***"
  },
  "ts": 1695712142936
 }

删除家庭

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    homeName String 家庭名称
    memberIds List<String> 家庭下的成员 UID 列表
    devices List<String> 家庭下的设备 ID 列表
    reason Integer 原因：
    • 1：用户注销并清除数据，造成家庭解散清除
    • 2：用户操作解散家庭，造成家庭解散

  • 数据示例

    {
    "bizCode": "homeDelete",
    "bizData": {
        "homeId": "***",
        "homeName": "我的家***",
        "memberIds": [],
        "devices":[],
        "reason": 1
    },
    "ts": 1695712142936
}

家庭成员邀请

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    operatorUid String 邀请人 UID 或操作人 UID
    memberUid String 发生变化的 UID
    eventType String 事件类型：
    • agreeForMember：被邀请者接受成为家庭的普通成员
    • agreeForAdmin：被邀请者接受成为家庭的管理员
    • updateToMember：修改家庭成员的角色为普通家庭成员角色
    • updateToAdmin：修改家庭成员的角色为管理员角色
    • inviteMember：邀请成员

  • 数据示例

      {
    "bizCode": "homeMemberSharing",
    "bizData": {
        "uid": "ay1695****e66",
        "homeId": "***",
        "operatorUid": "***",
        "memberUid": "***",
        "eventType": "agreeForMember"
    },
    "ts": 1687246619772
 }

家庭成员修改

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    operatorUid String 邀请人 UID 或操作人 UID
    memberUid String 发生变化的 UID
    role String 被修改为指定的成员角色：
    • member：家庭成员
    • admin：家庭管理员
    • owner：家庭拥有者

  • 数据示例

     {
    "bizCode": "homeMemberUpdate",
    "bizData": {
        "uid": "ay1695****e66",
        "memberName": "***",
        "memberUid": "***",
        "role": "member"
    },
    "ts": 1687246619772
}

家庭成员删除

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    memberUid String 发生变化的 UID
    role String 被修改为指定的成员角色：
    • member：家庭成员
    • admin：家庭管理员
    • owner：家庭拥有者
    dealType String 处理方式：
    • declineInvitation：拒绝家庭成员邀请
    • removed：正常删除家庭成员

  • 数据示例

    {
    "bizCode": "homeMemberDelete",
    "bizData": {
        "homeId": "1****2",
        "memberUid": "***",
        "role": "****",
        "dealType": "declineInvitation"
    },
    "ts": 1687246619772
}

房间事件（protocol 34）

房间创建

  • bizData 说明

    code 数据类型 描述
    uid String 用户 ID
    roomId Long 房间 ID
    roomName String 房间名称
    homeId String 家庭 ID

  • 数据示例

    {
    "bizCode": "roomCreate",
    "bizData": {
        "roomId": 12***,
        "roomName": "卧室",
        "homeId": "1**2**",
        "uid":"ay16957***0ZXwQ7"
    },
    "ts": 1687246619772
}

批量创建房间

  • bizData 说明

    code 数据类型 描述
    uid String 用户 ID
    roomId String 房间 ID
    rooms List<RoomVO> 创建的房间列表

  • RoomVO 说明

    code 数据类型 描述
    uid String 用户 ID
    roomId Long 房间 ID
    roomName String 房间名称
    homeId String 家庭 ID

  • 数据示例

         {
      "bizCode": "roomBatchCreate",
      "bizData": {
          "roomId": "1***2",
          "uid": "ay16957***0ZXwQ7",
          "rooms": []
      },
      "ts": 1687246619772
   }

房间删除

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    roomId Long 房间 ID

  • 数据示例

    
  {
    "bizCode": "roomDelete",
    "bizData": {
        "homeId": "xxx",
        "roomId": 12
    },
    "ts": 1687246619772
  }

房间排序

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    rooms List<RoomVO> 房间列表

  • RoomVO 说明

    code 数据类型 描述
    roomId Long 房间 ID
    order Integer 排序值，值越小越靠前

  • 数据示例

    {
"bizCode": "roomSort",
"bizData": {
	"homeId": "xxx",
	"rooms": [{
		"roomId": 21,
		"order": 1
	}, {
		"roomId": 11,
		"order": 2

	}]
},
"ts": 1687246619772
}

房间名称修改

  • bizData 说明

    code 数据类型 描述
    homeId String 家庭 ID
    roomId Long 房间 ID
    roomName String 房间名称

  • 数据示例

      {
    "bizCode": "roomNameUpdate",
    "bizData": {
        "homeId": "xxx",
        "roomId": 12xx,
        "roomName": "卧室"
    },
    "ts": 1687246619772
  }
上一篇数据签名
下一篇最佳实践
语言
简体中文
简体中文
English
400-881-8611
7×24小时服务热线
市场合作
marketing@tuya.com
业务合作
service@tuya.com
媒体联络
pr@tuya.com
关注“涂鸦智能”
涂鸦服务尽在掌握
关注“全球智能商业”
第一时间获取物联网资讯
联系我们加入我们Tuya ExpoApp 商城TuyaGoTuyaGo服务商查询
法律声明隐私协议加州隐私权利声明服务条款廉正合规安全应急响应中心
©2014-2023 杭州涂鸦信息技术有限公司 版权
浙ICP备14011795号
浙B2-20210233号
浙公网安备33010602004238号
简体中文
简体中文
English