Skip to content

数据格式定义

本文针对概述中定义的消息类型,详细描述每种消息类型的数据格式。
当前版本 v1.0.0。

上下线事件

包含设备上线、下线、重新连接等设备状态信息。

字段类型备注是否必选
ProductKeyStringPK
DeviceKeyStringDK
typeEnumONLINE
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
valueInteger 0 - 下线(offline), 1 - 上线(online),2 - 重新连接(reonline)

样例:

json
{
  "productKey": "p12345",
  "deviceKey": "1234567890",
  "type": "ONLINE",
  "createdAt": 1609316592000,
  "ticket": "5f9924d171977c33bc5ad1b1",
  "gateway": {
    "productKey": "p12344",
    "deviceKey": "1234567891"
  },
  "data": {
    "value": 1
  }
}

设备和模组状态

包含设备状态和模组状态信息,如电量、电压、信号强度、版本、ICCID等。

字段类型备注
productKeyStringPK
deviceKeyStringDK
typeEnumSTATUS
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
packetIdInteger上下行数据包Id
kvJSON Object 具体变动的状态属性
(battery,voltage,signal_strength,memory_free,rsrp,rsrq,snr,type,version,mcu_version,cell_id,icc_id,mcc,mnc,lac,phone_num,sim_num)
见设备状态和模组状态字段,上报的字段数量不固定

样例:

json
{
  "productKey": "p12345",
  "deviceKey": "1234567890",
  "type": "STATUS",
  "createdAt": 1609316592000,
  "ticket": "5f9924d171977c33bc5ad1b1",
  "data": {
    "packetId": 3,
    "kv": { "battery": "20", "voltage": "4" }
  }
}

状态字段列表

类别名称键值
设备状态电量battery
电压voltage
信号强度signal_strength
剩余空间memory_free
参考信号接收功率rsrp
LTE参考信号接收质量rsrq
信号与干扰加噪声比snr
模组状态模组型号type
模组版本version
MCU版本mcu_version
基站idcell_id
ICCID号icc_id
移动国家代码mcc
移动网络代码mnc
位置区代码lac
phone号phone_num
SIM号sim_num
SDK版本sdk_ver
定位支持功能locator

设备命令响应数据

指下发到设备的指令状态信息,包括发送成功、失败等。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumREQACK
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码(雪花算法生成)
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
sentAtLong 发送给设备的时间戳,整型,单位毫秒
statusEnum succ - 成功,fail - 失败

样例:

json
{
  "productKey": "p12345",
  "deviceKey": "1234567890",
  "type": "REQACK",
  "createdAt": 1609316592000,
  "ticket": "23924d171977c121325ad1bf",
  "gateway": {
    "productKey": "p12344",
    "deviceKey": "1234567891"
  },
  "data": {
    "sentAt": 1609316592000,
    "status": "succ"
  }
}

设备信息变更

包括设备的增加、修改、删除、重置、认证、激活、注销等信息。

字段名称字段类型是否必填备注
type事件类型String固定为: META_EVENT
ticket消息识别码String当操作类型是激活、认证、注销时,必填,否则,不必填
subtype操作对象类型String固定为DEVICE,表示对设备的操作
operation操作String ADD: 添加
UPDATE: 修改
DELETE: 删除
RESET: 重置
AUTH: 认证
ACTIVE: 激活
LOGOFF: 注销
productKey产品PKString
deviceKey设备唯一码String
createdAt操作时间戳Long消息生成的时间戳,整型,单位毫秒
gateway网关信息JSON Object网关子设备重置/认证/注销等操作时会存在网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
设备 添加/删除/激活/认证/注销
字段字段类型说明
deviceNameString设备名称
snStringSN
修改
字段类型说明
deviceNameJSON Object设备名称修改信息
字段类型说明
oldString修改前设备名称
newString修改后设备名称
snJSON ObjectSN修改信息
字段类型说明
newString修改后的SN名称
timeOffsetJSON Object时区修改信息
字段类型说明
newString修改后的时区偏移量
oldString修改前的时区偏移量

添加/删除 设备消息格式样例:

json
{
  "productKey": "p11376",
  "deviceKey": "132456",
  "type": "META_EVENT",
  "subtype": "DEVICE",
  "operation": "ADD/DELETE",
  "createdAt": 1616375484482,
  "ticket": "1032330579905388544",
  "data": {
    "deviceName": "123789",
    "sn": null
  }
}

激活/认证/注销 设备消息格式样例:

json
{
  "productKey": "p11376",
  "deviceKey": "132456",
  "type": "META_EVENT",
  "subtype": "DEVICE",
  "ticket": "1032330579905388544",
  "operation": "AUTH/ACTIVEL/LOGOFF",
  "createdAt": 1616375484482,
  "gateway": {
    "productKey": "p11371",
    "deviceKey": "112456"
  },
  "data": null
}

修改设备消息格式样例:

json
{
  "productKey": "p11376",
  "deviceKey": "132456",
  "type": "META_EVENT",
  "subtype": "DEVICE",
  "operation": "UPDATE",
  "createdAt": 1616375484482,
  "ticket": "1032330579905388544",
  "data": {
    "deviceName": {
      "old": "修改前设备名称",
      "new": "修改后设备名称"
    },
    "sn": {
      "new": "修改后的SN"
    },
    "timeOffset": {
      "old": "+06:00",
      "new": "+08:00"
    }
  }
}

设备重置消息格式样例:

json
{
  "productKey": "p11376",
  "deviceKey": "132456",
  "type": "META_EVENT",
  "subtype": "DEVICE",
  "operation": "RESET",
  "createdAt": 1616375484482,
  "data": null,
  "ticket": "1032330579905388544",
  "gateway": {
    "productKey": "p11371",
    "deviceKey": "112456"
  }
}

设备绑定信息变更

终端用户针对设备的绑定信息发送变动触发的数据。

字段名称字段类型是否必填备注
productKey产品PKString
deviceKey设备DKString
deviceName设备名称String
type类型String固定为ENDUSER
subtype子类型String固定为USER-BIND
ticket消息识别码String
createdAt创建时间Long操作时间戳,单位毫秒
dataJSON Object
字段类型备注
endUserIdString终端用户ID
endUserDomainString终端用户域
valueInteger 0-删除设备(解绑、用户注销、分享人删除、被分享人删除、设备组成员设备删除)
1-添加设备(绑定、分享、设备组成员设备添加)
2-设备失效(设备重置)
authStatusInteger认证状态 - 1真绑定 2伪绑定
authLevelInteger权限级别 - 1拥有者 2分享者
invalidCauseInteger 删除/失效原因
1 设备解绑
2 设备重置
3 分享过期
4 取消分享
5 覆盖分享
6 添加设备到设备组中
7 从设备组中移出设备
8 设备从真绑定变为伪绑定
9 设备从伪绑定变为真绑定
10 子设备从网关断开
11 子设备连接网关
12 用户被移出家庭
openIdString第三方用户平台的用户唯一标识

样例:

json
{
  "type": "ENDUSER",
  "subtype": "USER-BIND",
  "deviceKey": "132456",
  "productKey": "p11376",
  "createdAt": 1616375484482,
  "deviceName": "某设备",
  "ticket": "23924d171977c121325ad1bf",
  "data": {
    "endUserId": "11376",
    "endUserDomain": "C.DM.5715.1",
    "value": 1
  }
}

透传-设备上行数据

选择物模型或透传数据格式的产品,通过透传通道上报的设备数据。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumRAW
subtypeEnumUPLINK
createdAtLong消息生成的时间戳,整型,单位毫秒
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
ticketString消息识别码
dataJSON Object
字段类型备注
packetIdInteger 上下行数据包Id
rawString base64 encoded string

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "RAW",
  "subtype": "UPLINK",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "data": {
    "packetId": 3,
    "raw": "YSBtZXNzYWdl"
  }
}

透传-设备下行数据

选择物模型或透传数据格式的产品,通过透传通道发送的下行控制指令数据。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumRAW
subtypeEnumDOWNLINK
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
rawString base64 encoded string

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "RAW",
  "subtype": "DOWNLINK",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "data": {
    "raw": "YSBtZXNzYWdl"
  }
}

物模型-物模型属性信息

选择物模型数据格式的产品下设备上下行数据。

MATTR - READ:物模型-读下发

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMATTR
subtypeEnumREAD
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
keysarray 功能id集合

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MATTR",
  "subtype": "READ",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "data": {
    "keys": ["code1", "code2"]
  }
}

MATTR – READRESP:物模型-读响应

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMATTR
subtypeEnumREADRESP
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
packetIdInteger 包Id
kvJSON Object 属性键值对

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MATTR",
  "subtype": "READRESP",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "data": {
    "packetId": 3,
    "kv": {
      "numberKey": "10.2",
      "boolKey": true,
      "enumKey": "1"
    }
  }
}

备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。

MATTR - WRITE:物模型-写下发

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMATTR
subtypeEnumWRITE
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
kvJSON Object 属性键值对

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MATTR",
  "subtype": "WRITE",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "data": {
    "kv": {
      "code1": "1",
      "code2": "3"
    }
  }
}

MATTR – REPORT:物模型-上报

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMATTR
subtypeEnumREPORT
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
extDataJSON Object预留功能信息,键值对格式
字段类型备注
occurredAtString 预留字段,记录模组发生时间;时间戳格式字符串
dataJSON Object
字段类型备注
packetIdInteger 包Id
kvJSON Object 属性键值对
样例:
json
{
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MATTR",
  "subtype": "REPORT",
  "createdAt": 1609316592000,
  "ticket": "5f9924d171977c33bc5ad1b1",
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "extData": {
    "occurredAt": "1652433712899"
  },
  "data": {
    "packetId": 5,
    "kv": {
      "numberKey": "10.2",
      "boolKey": true,
      "enumKey": "1"
    }
  }
}

备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。

物模型-设备上行透传数据

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumRAW
subtypeEnumUPLINK
createdAtLong消息生成的时间戳,整型,单位毫秒
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
ticketString消息识别码
dataJSON Object
字段类型备注
packetIdInteger 上下行数据包Id
rawString base64 encoded string

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "RAW",
  "subtype": "UPLINK",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "data": {
    "packetId": 3,
    "raw": "YSBtZXNzYWdl"
  }
}

备注:透传数据值为 Base64 编码。

物模型-设备下行透传数据

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumRAW
subtypeEnumDOWNLINK
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
rawString base64 encoded string

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "RAW",
  "subtype": "DOWNLINK",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "data": {
    "raw": "YSBtZXNzYWdl"
  }
}

备注:透传数据值为 Base64 编码。

物模型-物模型事件上报-信息

选择物模型数据格式的产品下设备上报的事件信息,且定义级别为INFO。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMEVENT
subtypeEnumINFO
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
extDataJSON Object预留功能信息,键值对格式
字段类型备注
occurredAtString预留字段,记录模组发生时间;时间戳格式字符串
dataJSON Object
字段类型备注
packetIdInteger 包Id
codeString 消息标识符
kvJSON Object 键值对

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MEVENT",
  "subtype": "INFO",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "extData": {
    "occurredAt": 1652433712899
  },
  "data": {
    "packetId": 3,
    "code": "event_code3",
    "kv": {
      "numberKey": "1",
      "boolKey": true,
      "enumKey": "1"
    }
  }
}

备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。

物模型-物模型事件上报-告警

选择物模型数据格式的产品下设备上报的事件信息,且定义级别为WARN。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMEVENT
subtypeEnumWARN
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
extDataJSON Object预留功能信息,键值对格式
字段类型备注
occurredAtString预留字段,记录模组发生时间;时间戳格式字符串
dataJSON Object
字段类型备注
packetIdInteger 包Id
codeString 消息标识符
kvJSON Object 键值对

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MEVENT",
  "subtype": "WARN",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "extData": {
    "occurredAt": 1652433712899
  },
  "data": {
    "packetId": 3,
    "code": "event_code3",
    "kv": {
      "numberKey": "10.36",
      "boolKey": true,
      "enumKey": "1"
    }
  }
}

备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。

物模型-物模型事件上报-故障

选择物模型数据格式的产品下设备上报的事件信息,且定义级别为ERROR。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMEVENT
subtypeEnumERROR
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
extDataJSON Object预留功能信息,键值对格式
字段类型备注
occurredAtString预留字段,记录模组发生时间;时间戳格式字符串
dataJSON Object
字段类型备注
packetIdInteger 包Id
codeString 消息标识符
kvJSON Object 键值对

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MEVENT",
  "subtype": "ERROR",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": " 2345678901234"
  },
  "extData": {
    "occurredAt": 1652433712899
  },
  "data": {
    "packetId": 3,
    "code": "event_code3",
    "kv": {
      "numberKey": "10.3",
      "boolKey": true,
      "enumKey": "1"
    }
  }
}

备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。

物模型-物模型服务调用日志

选择物模型数据格式的产品下设备发送的服务类型数据。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumMSERV
subtypeEnumINPUT/OUTPUT
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
extDataJSON Object预留功能信息,键值对格式
字段类型备注
occurredAtString预留字段,记录模组发生时间;时间戳格式字符串
dataJSON Object
字段类型备注
packetIdInteger 包Id
codeString 服务标识符
kvJSON Object 输入参数

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "MSERV",
  "subtype": "INPUT",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "2345678901234"
  },
  "extData": {
    "occurredAt": 1652433712899
  },
  "data": {
    "packetId": 3,
    "code": "serv_code",
    "kv": {
      "numberKey": "12",
      "boolKey": false
    }
  }
}

备注:平台推送报文时,数值型字段值(物模型定义中 INT,FLOAT,DOUBLE,ENUM)皆以字符串形式推送,接收方可根据物模型定义类型,按需转换为数值型。

设备定位-查询定位信息

发送的设备定位下行数据。

字段类型备注
productKeyStringPK
deviceKeyStringDK
typeEnumLOCATION
subtypeEnumQUERY
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
dataJSON Object
字段类型备注
packetIdInteger 包Id
keysArray 设置模式的集合,可以为空

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "LOCATION",
  "subtype": "QUERY",
  "createdAt": 1609316592000,
  "data": {
    "packetId": 1,
    "keys": []
  }
}

设备定位-原始数据

设备上报的基于NMEA协议的定位数据。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumLOCATION
subtypeEnumINFO-RAW
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
packetIdInteger 包Id
rawString 定位的原始数据, GNSS信息格式参考NMEA-0183协议语句,LBS为自定义:
$LBS,<1>,<2>,<3>,<4>,<5>,<6>*hh<\CR><\LF>
<1>:基站mcc
<2>:基站mnc
<3>:基站lac
<4>:基站cellid
<5>:基站RxLev
<6>:备用

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "LOCATION",
  "subtype": "INFO-RAW",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p12344",
    "deviceKey": "1234567891"
  },
  "data": {
    "packetId": 5,
    "raw": [
      "$GNGGA,095528.000,2318.1133,N,11319.7210,E,1,06,3.7,55.1,M,-5.4,M,,0000*69",
      "$BDGGA,062938.00,3110.4700719,N,12123.2657056,E,1,25,0.6,58.9666,M,0.000,M,99,AAAA*4"
    ]
  }
}

设备定位信息

设备上报的NMEA协议经过平台解析后的定位数据。

设备定位数据支持GPS与LBS两种方式,默认仅支持GPS定位数据推送,若希望推送LBS定位数据,请联系商务。

如果返回为数组,则以多条 INFO-KV 发送。

字段类型备注是否必选
productKeyStringPK
deviceKeyStringDK
typeEnumLOCATION
subtypeEnumINFO-KV 上报原始/非原始
createdAtLong消息生成的时间戳,整型,单位毫秒
ticketString消息识别码
gatewayJSON Object网关信息
字段类型备注
productKeyString网关产品productKey
deviceKeyString网关设备deviceKey
dataJSON Object
字段类型备注
packetIdInteger 包Id
typeString 定位类型,GP/GL/GA/GN/BD/LBS/WIFI
subTypeString 定位子类型,BD/GL(俄国)/GP(美国)/GA(欧洲)/GN(GP+BD联合)/LBS/WIFI
kvJSON Object 解析后的定位信息,默认坐标系: wgs84
ggaStatus:GGA特有,0=初始化;1=GPS单点定位模式;2=差分GPS,SPS模式;3=无效PPS;4=RTK固定解模式;5=RTK浮点解模式;6=估算(航位推算)模式;7=人工输入模式;8=模拟模式;9=WAAS差分;
lat:纬度ddmm.mmmm(度分)格式,单位:分
lng:经度dddmm.mmmm(度分)格式,单位:分
hdop:水平精度:0.5~99.9
latType:N或S(北纬或南纬)
lngType:E或W(东经或西经)
height:海拔高度,单位:米

样例:

json
{
  "ticket": "5f9924d171977c33bc5ad1b1",
  "productKey": "p111KY",
  "deviceKey": "1234567890123",
  "type": "LOCATION",
  "subtype": "INFO-KV",
  "createdAt": 1609316592000,
  "gateway": {
    "productKey": "p111KY",
    "deviceKey": "1234567891"
  },
  "data": {
    "packetId": 5,
    "type": "GP/LBS",
    "subType": "BD(GGA)/LBS",
    "kv": {
      "satellites": "40", //当前卫星数
      "ggaStatus": "4",//定位质量指标 gga数据独有
      "lat": "3959.6107085", //纬度(度分格式ddmm.mmmmmmm)
      "lng": "11619.6423341", //经度(度分格式ddmm.mmmmmmm)
      "wgs_84": {
        "lat": 39.99351180833333, //纬度(度为单位)
        "lng": 116.32737223500001 //经度(度为单位)
      },
      "gcj_02": {
        "lat": 39.994825423430167, //纬度(度为单位)
        "lng": 116.33351545721269 //经度(度为单位)
      },
      "bd_09": {
        "lat": 40.00050264255087, //纬度(度为单位)
        "lng": 116.340146904483 //经度(度为单位)
      },
      "latType": "N/S", //N-北纬;S-南纬;
      "lngType": "W/E", //W-西经;E-东经;
      "hdop": "0.4", //水平精度因子
      "accuracy": "550", //精度,lbs数据独有
      "locateTime": 1609316592000, //定位时间(UTC时间)
      "height": "66.7717" //海拔高度(米为单位)
    }
  }
}

产品信息变更

产品的信息变更消息,包括产品的创建、修改、删除信息。

字段名称字段类型是否必填备注
type事件类型String固定为: META_EVENT
subtype操作对象类型String固定为: PRODUCT,表示对产品的操作
operation操作String ADD: 添加
UPDATE: 修改
DELETE: 删除
productKey产品PKString
createdAt操作时间戳Long操作时间戳(单位: 毫秒)
dataJSON Object产品详细信息
产品 添加/删除
字段字段类型说明
productNameString产品名称
productTypeInteger0-小批量 1-大批量
accessTypeInteger接入类型0-设备 1-网关
dataFmtInteger 0 --透传/自定义
3 --json(标准数据格式)
protocolInteger 1 -- MQTT
2 -- LWM2M/CoAP
logoPathStringlogo下载地址
moduleTypeString模组类型
moduleNameString模组名称
moduleIdLong模组信息id
allowedLimitInteger激活码数
productStatusInteger项目状态,0-进行中, 3-已发布, 9-出错
projectIdLong 项目id
createTimeLong 创建时间,时间戳,单位毫秒
updateTimeLong修改时间,时间戳,单位毫秒
itemCodeString关联产品品类id(通过 产品品类查询接口获得)
产品名称修改
字段类型说明
productNameJSON Object产品名称修改信息
字段类型说明
oldString修改前产品名称
newString修改后产品名称

新增产品 样例:

json
{
  "type": "META_EVENT",
  "subtype": "PRODUCT",
  "operation": "ADD",
  "createdAt": 1616375484482,
  "operator": 1,
  "operatorType": 1,
  "productKey": "p00001",
  "data": {
    "productName": "产品样例",
    "productType": 0,
    "accessType": 1,
    "netWay": "1",
    "dataFmt": 1,
    "protocol": 1,
    "logoPath": "https://xxxx.com/abcdfg.jpeg",
    "moduleType": null,
    "moduleName": null,
    "moduleId": null,
    "allowedLimit": 3,
    "productStatus": 0,
    "projectId": 1,
    "createTime": 1615787274000,
    "updateTime": 1615789235000,
    "itemCode": "anfang"
  }
}

修改产品 样例:

json
{
  "type": "META_EVENT",
  "subtype": "PRODUCT",
  "operation": "UPDATE",
  "createdAt": 1616375484482,
  "operator": 1,
  "operatorType": 1,
  "productKey": "p00001",
  "data": {
    "productName": {
      "old": "修改前产品名称",
      "new": "修改后产品名称"
    }
  }
}

产品授权信息

产品的授权信息变更,包括产品的授权和取消授权。

字段名称字段类型是否必填备注
type事件类型String固定为: META_EVENT
subtype操作对象类型String固定为: GRANT_AUTHORIZED,表示对产品授权相关的操作
operation操作String AUTH: 授权
CANCEL_AUTH: 取消授权
productKey产品PKString
createdAt操作时间戳Long操作时间戳(单位: 毫秒)
dataJSON Object产品授权信息
产品 授权/取消授权
字段字段类型说明
productNameString产品名称
productTypeInteger0-小批量 1-大批量
accessTypeInteger接入类型0-设备 1-网关
dataFmtInteger 0 --透传/自定义
3 --json(标准数据格式)
protocolInteger 1 -- MQTT
2 -- LWM2M/CoAP
logoPathStringlogo下载地址
moduleTypeString模组类型
moduleNameString模组名称
moduleIdLong模组信息id
allowedLimitInteger激活码数
productStatusInteger项目状态,0-进行中, 3-已发布, 9-出错
projectIdLong 项目id
createTimeLong 创建时间,时间戳,单位毫秒
updateTimeLong修改时间,时间戳,单位毫秒
itemCodeString关联产品品类id(通过 产品品类查询接口获得)
netWayString联网方式, 1-wifi, 2-蜂窝, 3-NB, 5-蓝牙

产品授权样例:

json
{
  "createdAt": 1665280943221,
  "data": {
    "moduleType": null,
    "dataFmt": 3,
    "itemCode": "socket",
    "logoPath": null,
    "moduleName": null,
    "netWay": "2",
    "productStatus": 0,
    "allowedLimit": 100,
    "updateTime": 1665286595000,
    "productName": "插座",
    "accessType": 0,
    "protocol": null,
    "createTime": 1665285584000,
    "moduleId": null,
    "projectId": 11338,
    "productType": 0
  },
  "operation": "AUTH",
  "productKey": "p119Cx",
  "subtype": "GRANT_AUTHORIZED",
  "type": "META_EVENT"
}

用户域(App)授权信息

用户域(App)的授权信息变更,包括用户域(App)的授权和取消授权。

字段名称字段类型是否必填备注
type事件类型String固定为:META_EVENT
subtype操作对象类型String固定为:GRANT_USER_DOMAIN
operation操作String AUTH: 授权
CANCEL_AUTH: 取消授权
userDomain用户域String
userDomainId用户域IdLong
createdAt操作时间戳Long操作时间戳(单位: 毫秒)
dataJSON ObjectApp相关信息
字段字段类型说明
appNameString用户域对应的app名称
json
{
  "type": "META_EVENT",
  "subtype": "GRANT_USER_DOMAIN",
  "operation": "AUTH",
  "userDomain": "C.DM.5503.34",

  "userDomainId": 12345645656456,
  "createdAt": 1665280943221,
  "data": {
    "appName": "test"
  }
}

物模型发布信息变更

新发布的物模型信息。

字段名称字段类型是否必填备注
subtype操作对象类型String固定为THING_MODEL,表示对物模型相关的操作
operation操作类型StringRELEASE:发布
productKey产品PKString
createdAt操作时间戳Long操作时间戳,单位毫秒
type事件类型String固定为: META_EVENT
dataJSON Object
字段字段类型说明
tslJsonJSON Object物模型发布后json数据

样例:

json
{
  "type": "META_EVENT",
  "subtype": "THING_MODEL",
  "operation": "RELEASE",
  "productKey": "p11374",
  "operator": 26984,
  "operatorType": 1,
  "createdAt": 1616375484482,
  "data": {
    "tslJson": {
      "profile": {
        "version": "20210406093313373",
        "productKey": "p1137H"
      },
      "properties": [
        {
          "code": "202104011545",
          "dataType": "BOOL",
          "desc": "",
          "id": 1,
          "name": "202104011545",
          "specs": [
            {
              "dataType": "BOOL",
              "name": "TRUE",
              "value": "true"
            },
            {
              "dataType": "BOOL",
              "name": "FALSE",
              "value": "false"
            }
          ],
          "subType": "RW",
          "type": "PROPERTY"
        },
        {
          "code": "202104011700",
          "dataType": "DOUBLE",
          "desc": "",
          "id": 2,
          "name": "202104011700",
          "specs": {
            "max": "2",
            "min": "1",
            "step": "1",
            "unit": "°"
          },
          "subType": "RW",
          "type": "PROPERTY"
        },
        {
          "code": "202104011501",
          "dataType": "TEXT",
          "desc": "",
          "id": 3,
          "name": "202104011501",
          "specs": {
            "length": 123
          },
          "subType": "RW",
          "type": "PROPERTY"
        }
      ]
    }
  }
}

终端用户信息变更

终端用户变更信息,包括终端用户的创建、修改和删除信息。

终端用户信息变更需要通过OpenAPI创建终端用户订阅。

字段名称字段类型是否必填备注
type类型String固定为ENDUSER
subtype子类型String USER-ADD: 添加
USER-UPDATE: 修改
USER-DELETE: 删除
ticket消息识别码String消息唯一识别码
createdAt创建时间Long操作时间戳,单位毫秒
dataJSON Object
字段字段类型说明
endUserIdString终端用户ID
endUserDomainString终端用户域
internationalCodeString手机号国家编码
phoneString手机号
emailString邮箱
wechatIdString微信ID
openIdString第三方用户平台的用户唯一标识

样例:

json
{
  "ticket": "b18be821-5045-4467-801d-ca68c302dc3d",
  "type": "ENDUSER",
  "subtype": "USER-DELETE",
  "createdAt": 1642471712433,
  "data": {
    "endUserId": "C1",
    "endUserDomain": "C.DM.1.15"
  }
}

规则引擎事件

规则引擎推送信息。

字段名称字段类型是否必填备注
type类型String固定为CEP_RULE
subtype子类型String固定为NOTICE
traceId执行动作轨迹IDString执行动作轨迹ID
createdAt创建时间Long操作时间戳,单位毫秒
dataJSON Object
字段类型备注
extraString扩展字段,非必填,创建规则时填写的自定义参数
rawObject触发该规则的设备上行数据
字段类型备注
ticketString消息识别码
productKeyString产品PK
deviceKeyString设备DK
typeString消息类型,MATTR:物模型属性,MEVENT:物模型事件
createdAtLong消息生成时间,毫秒级时间戳
attrsObject属性数据,非必填
eventsArray事件数据,非必填

样例:

json
{
  "traceId": "1228299096116822016",
  "type": "CEP_RULE",
  "subtype": "NOTICE",
  "createdAt": 1713249972992,
  "data": {
    "extra": "{\"key\",\"value\"}",
    "raw": {
      "ticket": "1228217775206039552",
      "productKey": "p113C1",
      "deviceKey": "8686202300000001",
      "type": "MATTR",
      "createdAt": 1713249972997,
      "attrs": {
        "kv": {
          "Temperature": 50,
          "struct": {
            "date": 1690449531456
          },
          "array_int": [1],
          "array_struct": [
            {
              "date": "1690449531456"
            }
          ]
        }
      },
      "events": [
        {
          "code": "BatteryWarning",
          "kv": {
            "Temperature": 50,
            "struct": {
              "date": 1690449531456
            },
            "array_int": [1],
            "array_struct": [
              {
                "date": "1690449531456"
              }
            ]
          }
        }
      ]
    }
  }
}