一、设备数据
1.1 设备激活
字段 |
必填 |
类型 |
备注 |
device_id |
True |
Int |
设备ID |
product_id |
True |
String |
产品ID |
corp_id |
True |
String |
企业ID |
time |
True |
String |
触发时间 |
mac |
True |
String |
设备mac |
country |
False |
String |
所在国家 |
province |
False |
String |
所在省份 |
city |
False |
String |
所在城市 |
{
"topic": "/device/activate/product/{product_id}",
"message_id": "消息ID",
"payload": {
"device_id": "设备ID",
"product_id": "产品ID",
"corp_id": "企业ID",
"time": "时间,yyyy-MM-dd'T'HH:mm:ss.SS'Z'",
"mac": "设备mac",
"country": "设备激活时所在国家(APP手动注册时会有)",
"province": "设备激活时所在省份(APP手动注册时会有)",
"city": "设备激活时所在城市(APP手动注册时会有)"
}
}
1.2 设备告警消息
字段 |
必填 |
类型 |
备注 |
product_id |
True |
String |
产品ID |
device.id |
True |
Int |
设备ID |
device.mac |
False |
Stirng |
设备MAC |
corp_id |
True |
String |
企业ID |
alert.exception |
True |
Boolean |
是否异常 |
alert.time |
True |
String |
异常/恢复时间 |
alert.rules |
False |
List<Object> |
相关规则列表 |
alert.rules.id |
False |
String |
规则ID |
alert.rules.status |
False |
Int |
异常状态 |
alert.rules.notify |
False |
Int |
通知类型 |
alert.rules.current |
False |
String |
当前置 |
alert.rules.count |
False |
Int |
累计异常次数 |
alert.rules.new_time |
False |
String |
异常触发最新时间 |
alert.rules.start_time |
False |
String |
异常触发开始时间 |
alert.rules.recover_time |
False |
String |
异常恢复时间 |
alert.rules.processed_time |
False |
String |
异常处理时间 |
alert.rules.exception_describe |
False |
String |
异常描述 |
alert.rules.notification_content |
False |
String |
异常内存 |
{
"topic": "/device/alert/product/{product_id}",
"message_id": "消息ID",
"payload": {
"product_id": "产品ID",
"corp_id": "企业ID",
"device": {
"id": "设备ID",
"mac": "设备MAC"
},
"alert": {
"exception": "当前是否异常,否则为恢复",
"time": "异常/恢复时间, yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"rules": [{
"id": "异常规则ID",
"status": " 异常状态,1报警2恢复3已手动处理",
"notify": "异常规则通知类型,1通知2告警",
"current": "当前值",
"count": "本次累计异常次数",
"new_time": "本次异常触发时间,yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"start_time": "本地异常开始时间,yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"recover_time": "本此异常恢复时间,yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"processed_time": "本此异常处理时间,yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"exception_describe": "异常描述",
"notification_content": "本次异常报警内容"
}]
}
}
}
1.3 设备在线状态
字段 |
必填 |
类型 |
备注 |
product_id |
True |
String |
产品ID |
device_id |
True |
Int |
设备ID |
mac |
True |
String |
设备mac |
is_online |
True |
Int |
在线状态,离线:0,在线:1 |
corp_id |
False |
Stirng |
企业ID |
create_time |
False |
String |
创建时间 |
project_id |
False |
String |
所属项目ID |
{
"topic": "/device-biz/state/product",
"message_id": "消息ID",
"payload": {
"device_id": "设备ID",
"mac": "设备mac",
"is_online": "是否在线",
"product_id": "产品ID",
"corp_id": "企业ID",
"create_time": "时间,yyyy-MM-dd'T'HH:mm:ss.SS'Z'",
"project_id":"设备所属的项目ID"
}
}
1.4 设备订阅变更
字段 |
必填 |
类型 |
备注 |
device_id |
True |
Int |
设备ID |
corp_id |
False |
Stirng |
企业ID |
create_time |
False |
String |
创建时间 |
user_id |
True |
Int |
用户ID |
subscribe |
True |
Boolean |
订阅状态 |
{
"topic": "/subscribe/change/product/{product_id}",
"message_id": "消息ID",
"payload": {
"corp_id": "企业ID",
"device_id": "设备ID",
"user_id": "用户ID",
"create_time": "发生时间,yyyy-MM-dd'T'HH:mm:ss.SS'Z'",
"subscribe": "订阅状态,true:订阅;false:取消订阅"
}
}
1.5 设备信息更新
字段 |
必填 |
类型 |
备注 |
device_id |
True |
Int |
设备ID |
corp_id |
True |
Stirng |
企业ID |
product_id |
True |
String |
产品ID |
mac |
True |
String |
设备MAC |
project_id |
False |
String |
项目ID |
action_type |
True |
Int |
操作类型 |
{
"topic": "/device-biz/info/product",
"message_id": "消息ID",
"payload": {
"corp_id": "企业ID",
"device_id": "设备ID",
"product_id":"产品ID",
"mac":"设备MAC",
"project_id":"项目ID",
"action_type":"1=新增,2=更新,3=删除"
}
}
1.6 设备上报属性
字段 |
必填 |
类型 |
备注 |
version |
True |
Int |
消息版本号 |
time |
True |
Long |
触发时间,毫秒时间戳 |
type |
True |
String |
消息类型,固定为:service |
id |
False |
String |
设备唯一ID |
corp_id |
False |
String |
企业ID |
iot |
False |
Object |
设备IoT信息 |
iot.id |
False |
Int |
物联网平台的设备ID |
iot.mac |
False |
String |
设备MAC |
iot.product |
False |
Object |
产品信息 |
iot.product.id |
False |
String |
产品ID |
iot.attributes |
False |
List<Object> |
属性列表 |
extra.iot.attributes.exception_info |
False |
Object |
属性异常状态信息,属性关联配置了异常规则时,表示属性的异常状态 |
extra.iot.attributes.exception_info.status |
False |
Int |
异常状态,枚举值:1表示异常;2表示正常 |
extra.iot.attributes.exception_info.time |
False |
Long |
异常状态时间戳,表示异常/正常状态变化的时间,毫秒单位 |
iot.attributes.field |
False |
String |
属性字段名 |
iot.attributes.index |
False |
Int |
属性索引 |
iot.attributes.value |
False |
String |
属性值 |
project |
False |
Object |
项目信息 |
project.id |
False |
String |
项目ID |
{
"topic": "/service/device-biz/attribute",
"message_id": "消息ID",
"payload": {
"version": 1,
"time": "触发时间",
"type": "service",
"id": "设备唯一ID",
"corp_id": "企业ID",
"iot": {
"id": "IoT设备ID",
"mac": "IoT设备MAC",
"product": {
"id": "IoT产品ID"
},
"attribute": [{
"exception_info": {
"time": 1642*****0036,
"status": 2
},
"index": 1,
"field": "mode",
"value": "close"
}]
},
"project": {
"id": "项目ID"
}
}
}
1.7 设备上报事件
字段 |
必填 |
类型 |
备注 |
iot.events |
False |
List<Object> |
事件列表 |
iot.events.output.value |
False |
String |
事件参数值 |
iot.events.output |
False |
List<Object> |
事件参数列表 |
iot.events.output.field |
False |
String |
事件参数字段名 |
iot.events.name |
False |
String |
事件名 |
iot.product.id |
False |
String |
产品ID |
iot.product |
False |
Object |
产品信息 |
corp_id |
False |
String |
企业ID |
version |
True |
Int |
消息版本号 |
type |
True |
String |
消息类型,固定为:service |
iot.id |
False |
Int |
物联网平台的设备ID |
time |
True |
Long |
触发时间,毫秒时间戳 |
iot |
False |
Object |
设备IoT信息 |
iot.mac |
False |
String |
设备MAC |
id |
False |
String |
设备唯一ID |
project.id |
False |
String |
项目ID |
project |
False |
Object |
项目信息 |
{
"topic": "/service/device-biz/event",
"message_id": "消息ID",
"payload": {
"version": 1,
"time": "触发时间",
"type": "service",
"id": "设备唯一ID",
"corp_id": "企业ID",
"iot": {
"id": "IoT设备ID",
"mac": "IoT设备MAC",
"product": {
"id": "IoT产品ID"
},
"events": [{
"name": "报警",
"output": [{
"field": "mode",
"value": "close"
}]
}]
},
"project": {
"id": "项目ID"
}
}
}
二、事件中心数据
事件中心的数据分成3大块:
- base是基础部分,它描述事件公有属性的信息;
- extend是扩展部分,它描述每种事件独有属性的信息;拓展字段包体大小限制在5kb,拓展字段数限制在64个。
- process描述事件的处理结果。处理信息,非必传,不传则认为自动恢复
{
"topic": "具体事件topic",
"message_id": "消息ID",
"payload": {
"base":{},
"extend":{},
"proccess":{}
}
}
2.1 事件中心基础数据
{
"topic":"/event/service/{application}/{classification}/{definition}",
"message_id":"消息ID",
"payload":{
"id": "事件标识,长度1-128",
"base": {
"status": "事件状态,1:待处理,2:处理中,3:已处理",
"create_time": "事件触发时间,待处理状态时必传,格式2019-10-20T23:15:22.00Z",
"process_time": "事件处理时间,已处理状态时必传,格式2019-10-20T23:15:22.00Z",
"source": "事件来源,可传可不传,长度0-256",
"desc": "事件描述,可传可不传,长度0-256",
"name": "事件名称,可传可不传,长度0-128",
"project_id": "项目标识,可传可不传,长度0-64",
"biz_organization_id": "所属业务组织标识,可传可不传,长度0-64",
"full_biz_organization_id": "所属业务组织全标识,可传可不传,长度0-64,A:B:C:D:E:F:G",
"area_id": "所属片区标识,可传可不传,长度0-64",
"regions": ["所属区域"],
"definition_id": "所属事件定义标识",
"corp_id": "所属企业标识",
"classification_id": "所属事件分类标识",
"rank_id": "所属事件等级标识",
"priority": "所属优先级",
"tag_id": "事件标签标识",
"space_group_location": "事件所属管理区域(空间分组)位置名称,所有管理区域名称,以分隔符/拼接",
"space_location": "事件所属空间位置名称,全名称,以分隔符/拼接",
"product_id": "事件关联产品标识,可传可不传,长度0-64",
"device_id": "事件关联设备标识,可传可不传",
"device_name": "事件关联设备名称,可传可不传,长度0-128",
"trigger_condition": "时间关联触发条件规则,可传可不传,长度0-128",
"project_name": "事件所属项目名称,可传可不传,长度0-128",
"address": "事件发生位置, 如果是设备则为设备位置,其他看场景,可传可不传,长度0-256"
},
"extend": {
"key1": "value1",
"key2": "value2",
"key3": "value3",
"key4": "value4",
},
"processed": {
"opinion": "处理意见,长度0-256",
"operator_type": "处理人类型,1:自动恢复, 2:物联成员平台, 3: 工单系统",
"operator_id": "处理人标识,可传可不传,长度0-64",
"operator_account": "处理人账号,可传可不传,长度0-64",
"operator_name": "处理人名字,可传可不传,长度0-32"
}
}
}
2.2 车场事件信息
拓展信息如下:
{
"extend": {
"project_id": "项目ID",
"parkinglot_id": "停车场ID",
"area_id": "区域ID",
"channel_id": "通道ID",
"device_id": "道闸ID",
"exception_id": "异常记录ID",
"pass_in_id": "进场ID",
"pass_out_id": "出场ID",
"user_id": "开闸人员ID",
"user_name": "开闸人员姓名",
"plate_no": "车牌号码",
"open_mode": "开闸方式 0硬件开闸 1软件开闸",
"abnormal_time": "开闸时间",
"abnormal_note": "原因(异常抬杆说明)",
"exception_type": "异常类型(0:人工放行;1:手动开展;2:车牌纠正;3:免费放行;4:其他异常)",
"reg_plate_no": "纠正车牌号",
"free_pass_type": "免费通行类型",
"event_id": "图片事件ID",
}
}
2.3 车场月卡推送扩展信息
{
"extend": {
"expire_date": "到期时间,utc格式",
"project_id": "项目ID",
"parkinglot_id": "停车场ID",
"card_id": "月卡id",
"car_plate_nos": "车牌号",
"car_place": "车位",
"car_place.name": "车位名称",
"car_place.no": "车位编号",
"owner_id": "车主id",
"owner_name": "车主名称",
"corp_id": "企业id"
}
}
2.4 车场临停缴费机了推送信息
字段 |
是否必传 |
类型 |
描述 |
record_id |
否 |
string |
记录id |
project_id |
否 |
string |
项目ID |
parkinglot_id |
否 |
string |
停车场ID |
corp_id |
否 |
string |
企业id |
in_time |
否 |
string |
进场时间,utc格式 |
out_time |
否 |
string |
出场时间,utc格式 |
bill_payable |
否 |
long |
应付金额,单位为分 |
real_pay |
否 |
long |
实付金额,单位为分 |
pay_id |
否 |
string |
第三方支付id |
pay_result |
否 |
int |
支付结果0失败 1成功 2处理中 |
pay_type |
否 |
int |
支付类型支付方式 1:现金、2:微信、3:支付宝、4:银联、99:其它 |
coupon_deduction |
否 |
long |
优惠金额 |
coupon_no |
否 |
string |
优惠券id |
payment_date |
否 |
string |
缴费完成日期,utc格式 |
payment_status |
否 |
int |
缴费状态订单状态 0:未缴清费用: 1:已缴清; 2:已完成; 3:超时未支付; 4:已缴费超时未出场; 5:已取消 |
abnormal_amount |
否 |
long |
异常金额,单位为分 |
car_plate_no |
否 |
string |
车牌号 |
discount_type |
否 |
int |
折扣类型折扣方式 0减免 1折扣 |
fail_message |
否 |
string |
失败信息 |
owner_id |
否 |
string |
车主id |
owner_name |
否 |
string |
车主名称 |
corp_id |
否 |
string |
企业id |
pass_in_id |
否 |
string |
进场id |
pass_out_id |
否 |
string |
出场id |
in_area_name |
否 |
string |
进场区域名称 |
in_channel_name |
否 |
string |
进场通道名称 |
in_area_id |
否 |
string |
进场区域id |
in_channel_id |
否 |
string |
进场通道id |
in_device_id |
否 |
string |
进场设备id |
in_device_name |
否 |
string |
进场设备名称 |
in_event_id |
否 |
string |
进场事件id |
parking_time |
否 |
long |
停车时长,单位为s |
out_area_id |
否 |
string |
出场区域id |
out_area_name |
否 |
string |
出场区域名称 |
out_channel_id |
否 |
string |
出场通道id |
out_channel_name |
否 |
string |
出场通道名称 |
out_device_id |
否 |
string |
出场设备id |
out_device_name |
否 |
string |
出场设备名称 |
out_event_id |
否 |
string |
出场事件id |
roll_money |
否 |
long |
回滚金额,单位为分 |
car_pass_type |
否 |
int |
车辆进出类型// 固定卡车辆 FIXED_CARD(1), // 临停 TEMP_STOP(2), // 储值 DEPOSIT(3), // 白名单 WHITE_LIST(4), // VIP VIP(5), // 产权车位车辆 PROPERTY_RIGHT(11), // 访客预约 APPOINTMENT(21), // 共享停车 SHARE(31), // 其它 OTHER(99); |
2.5 车场访客进场记录
字段 |
是否必传 |
类型 |
描述 |
record_id |
否 |
string |
到期时间,utc格式 |
project_id |
否 |
string |
项目ID |
parkinglot_id |
否 |
string |
停车场ID |
corp_id |
否 |
string |
企业id |
area_id |
否 |
string |
区域id |
area_name |
否 |
string |
区域名称 |
device_id |
否 |
string |
设备id |
device_name |
否 |
string |
设备名称 |
car_brand |
否 |
string |
车辆品牌 |
car_model |
否 |
string |
车辆型号 |
car_color |
否 |
string |
车辆颜色 |
car_plate_no |
否 |
string |
车牌号 |
event_id |
否 |
string |
事件id |
in_time |
否 |
string |
进场时间 utc格式 |
car_type |
否 |
int |
车型 大型车0、小型车1、摩托车2、其他99 |
has_plate_no |
否 |
boolean |
是否有车牌 |
plate_no_color |
否 |
int |
车牌颜色1:蓝牌、2:黄牌、3:绿牌、4:黑牌、5:白牌、99:未识别 |
open_mode |
否 |
int |
开闸方式0硬件开闸 1软件开闸 |
2.6 车场黑名单车辆告警记录
字段 |
是否必传 |
类型 |
描述 |
record_id |
否 |
string |
记录id |
project_id |
否 |
string |
项目ID |
parkinglot_id |
否 |
string |
停车场ID |
corp_id |
否 |
string |
企业id |
area_id |
否 |
string |
区域id |
area_name |
否 |
string |
区域名称 |
device_id |
否 |
string |
设备id |
device_name |
否 |
string |
设备名称 |
channel_id |
否 |
string |
通道id |
channel_name |
否 |
string |
通道名称 |
car_plate_no |
否 |
string |
车牌号 |
event_id |
否 |
string |
事件id |
in_time |
否 |
string |
进场时间 utc格式 |
2.7 车场拥堵告警记录推送
字段 |
是否必传 |
类型 |
描述 |
record_id |
否 |
string |
记录id |
project_id |
否 |
string |
项目ID |
parkinglot_id |
否 |
string |
停车场ID |
corp_id |
否 |
string |
企业id |
area_id |
否 |
string |
区域id |
area_name |
否 |
string |
区域名称 |
device_id |
否 |
string |
设备id |
device_name |
否 |
string |
设备名称 |
channel_id |
否 |
string |
通道id |
channel_name |
否 |
string |
通道名称 |
car_plate_no |
否 |
string |
车牌号 |
in_time |
否 |
string |
进场时间 utc格式 |
2.8 设备运维事件
{
"extend": {
"rule_id":"规则id",
"rule_type":"异常告警类型, 1:单数据端点告警, 2:状态告警",
"rule_param":"单数据端点告警以及单数据端点告持续警时,必须,对应的数据端点标识",
"rule_compare":"单数据端点告警以及单数据端点持续告警时,必须,异常告警条件操作符",
"rule_value":"异常告警条件",
“rule_multi_datapoint”:"多数据端点时的告警条件,具体字段描述见https://docs.xlink.cn/pages/viewpage.action?pageId=27235834"
}
}
2.9 门禁事件
{
"extend":{
"person_id":"开门人员的id",
"project_id":"项目id",
"corp_id":"企业id",
"open_time":"开门时间戳",
"open_result":"开门结果(1-开门成功;0-开门失败)",
"device_id":"开门设备id",
"device_mac":"开门设备mac",
"id":"开门记录在xlink平台中的id",
"event_id":"事件id",
"event_level":"事件级别",
"event_title":"事件标题",
"event_content":"事件内容",
"event_type":"告警类型",
"time":"事件发生时间"
}
}
2.10 门禁开门记录推送
字段 |
是否必须 |
类型 |
描述 |
person_id |
是 |
string |
开门人员的id |
project_id |
是 |
string |
项目ID |
corp_id |
是 |
string |
企业id |
open_time |
否 |
string |
开门时间戳。格式2019-10-20T23:15:22.00Z |
open_result |
否 |
string |
开门结果(1-开门成功;0-开门失败) |
device_id |
是 |
string |
开门设备ID |
device_mac |
否 |
string |
开门设备MAC |
id |
否 |
string |
开门记录在xlink平台中的id |
event_id |
否 |
string |
事件id |
event_level |
否 |
string |
事件级别 |
event_title |
否 |
string |
事件标题 |
event_content |
否 |
string |
事件内容 |
event_type |
否 |
string |
事件类型 |
time |
是 |
string |
事件发生时间。格式2019-10-20T23:15:22.00Z |
三、地产数据
3.1 空间数据
字段 |
字段名 |
类型 |
是否必须 |
备注 |
space_type |
空间类型 |
Int |
是 |
1: 项目; 2: 区域; 3 楼栋: 4 单元; 5 楼层 6 房屋 |
data_type |
操作类型 |
int |
是 |
1: 新增; 2: 修改; 3. 删除 |
project_id |
项目ID |
String |
是 |
|
parent_id |
空间的父级ID |
String |
是 |
|
parents |
完整的父级空间列表 |
Array |
是 |
完整的父级空间列表 |
parent.id |
空间ID |
String |
是 |
|
parent.type |
空间类型 |
String |
是 |
|
parent.order |
空间顺序 |
String |
是 |
默认从上到下排序 |
id |
空间ID |
String |
是 |
|
name |
项目名称 |
String |
否 |
|
province |
项目省份 |
String |
否 |
|
city |
城市 |
String |
否 |
|
address |
详细地址 |
String |
否 |
|
remark |
项目描述 |
String |
否 |
|
layout |
项目平面图链接 |
String |
否 |
|
coordinate |
项目经纬度 |
array |
否 |
|
property |
扩展属性 |
Object |
否 |
|
create_time |
创建时间 |
Date |
否 |
|
update_time |
更新时间 |
Date |
否 |
|
is_deleted |
是否删除 |
Boolean |
否 |
|
{
"topic": "/realty/data/space",
"message_id": "消息ID",
"payload": {
"space_type":"空间类型",
"data_type":"数据类型",
"id":"空间ID",
"parent_id":"父级空间的ID",
"parents":[{
"id":"空间ID",
"type":"空间类型",
"order":"顺序"
}]
"name":"空间名称",
"project_id":"项目ID",
"data_type":"数据类型",
"province":"省份",
"city":"城市",
"country":"国家",
"address":"地址",
"remark":"描述",
"layout":"项目平面图链接",
"property":"扩展属性",
"coordinate":[130.11,66.7],
"create_time":"",
"update_time":"",
"is_deleted":""
}
}
3.2 住户数据
字段 |
字段名 |
类型 |
是否必须 |
备注 |
data_type |
操作类型 |
int |
是 |
1: 新增空间关联; 2: 删除空间关联; 3. 住户本身修改; 4. 新增住户; 5 删除住户 |
customer_id |
住户ID |
String |
是 |
|
name |
住户名称 |
String |
否 |
|
gender |
性别 |
Int |
否 |
0:未知,1:男性,2:女性 |
certificate_type |
证件类型 |
Int |
否 |
1:身份证,2:护照,3:军官证,4:港澳通行证 |
certificate_id |
证件号码 |
String |
否 |
|
project_id |
项目ID |
String |
否 |
|
house_id |
房屋ID |
String |
否 |
|
house_role |
房屋角色 |
String |
否 |
1:业主,2:亲属,3:租客,4:安装工 |
phone |
手机号 |
|
|
|
user_ids |
app用户ID |
Array |
否 |
用户数组 |
create_time |
创建时间 |
Long |
否 |
精确到毫秒 |
update_time |
更新时间 |
Long |
否 |
精确到毫秒 |
is_deleted |
是否删除 |
Boolean |
否 |
|
{
"topic": "/realty/data/customer",
"message_id": "消息ID",
"payload": {
"data_type":"数据类型",
"customer_id":"住户ID",
"name":"住户名称",
"gender":"性别",
"certificate_type":"证件类型",
"certificate_id":"证件号码",
"project_id":"项目ID",
"house_id":"房屋ID",
"house_role":"房屋角色",
"phone":"手机号",
"create_time":"",
"update_time":"",
"is_deleted":"",
}
}
3.3 app用户信息
字段 |
字段名 |
类型 |
是否必须 |
备注 |
data_type |
数据类型 |
Integer |
是 |
1,新增; 2 修改 |
user_id |
用户ID |
Integer |
是 |
|
name |
用户名称 |
String |
否 |
|
email |
用户邮箱 |
String |
否 |
|
phone |
用户手机号 |
String |
否 |
|
gender |
性别 |
Integer |
否 |
0:未知,1:男性,2:女性 |
is_valid |
是否有效 |
Integer |
否 |
0: 禁止 1;正常 |
create_time |
创建时间 |
Long |
否 |
精确到毫秒 |
update_time |
更新时间 |
Long |
否 |
精确到毫秒 |
{
"topic": "/user/info",
"message_id": "消息ID",
"payload": {
"data_type":"数据类型",
"user_id":"用户ID",
"name":"用户名称",
"email":"用户邮箱",
"gender":"性别",
"phone":"手机号",
"create_time":"",
"update_time":"",
"is_valid":"用户是否有效",
}
}
3.4 企业成员数据
字段 |
字段名 |
类型 |
是否必须 |
备注 |
uuid |
业务id |
String |
是 |
上游服务传入的id |
opt_type |
变更的类型 |
String |
是 |
add |update|delete |
corp_id |
所属企业标识 |
String |
是 |
|
id |
成员标识 |
Integer |
是 |
|
name |
成员名字 |
String |
否 |
|
phone |
手机号 |
String |
否 |
|
phone_zone |
成员手机区号 |
String |
否 |
|
email |
成员注册邮箱 |
String |
否 |
|
create_time |
成员创建时间 |
Long |
是 |
时间戳 |
status |
成员状态 |
Int |
是 |
0:待激活;1:正常可用;2:停用 |
expire_time |
成员过期时间 |
Long |
否 |
时间戳 |
managed_organizations |
所属行政组织 |
Array |
否 |
组织的ID列表 |
{
"topic": "/corp/member",
"message_id": "消息ID",
"create_time": "1571043881988 毫秒数",
"version": "1 版本",
"payload": {
"uuid": "标识",
"opt_type": "变化类型",
"corp_id": "所属企业标识",
"id": "成员标识",
"name": "成员名称",
"phone": "成员手机号",
"phone_zone": "成员手机区号",
"email": "成员邮箱",
"create_time": "成员创建时间,时间戳",
"status": "成员状态",
"expire_time": "成员过期时间,时间戳",
"managed_organizations": ["所属行政组织"]
}
}
3.5 组织架构数据
字段 |
字段名 |
类型 |
是否必须 |
备注 |
uuid |
业务id |
String |
是 |
上游服务传入的id |
opt_type |
变更的类型 |
String |
是 |
add |update|delete |
corp_id |
所属企业标识 |
String |
是 |
|
id |
组织标识 |
Integer |
是 |
|
name |
组织名字 |
String |
否 |
|
desc |
组织详细描述 |
String |
否 |
|
parent_id |
组织父级标识, 父组织标识集合 |
String |
是 |
举例:C组织属于B组织, B组织属于A组织, A无上级组织, 则此时C组织的pid为A:B", "specific_parent_id": "真实具体的父组织标识, 如C组织属于B组织, 此时组织的specificParentId为B", |
specific_parent_id |
真实具体的父组织标识 |
String |
否 |
如C组织属于B组织, 此时组织的specificParentId为B |
create_time |
组织创建时间 |
Long |
是 |
时间戳 |
update_time |
组织更新时间 |
Long |
否 |
时间戳 |
{
"topic": "/corp/member",
"message_id": "消息ID",
"create_time": "1571043881988 毫秒数",
"version": "1 版本",
"payload": {
"uuid": "标识",
"opt_type": "变化类型",
"corp_id": "所属企业标识",
"id": "组织标识",
"name": "组织名称",
"desc": "组织描述",
"parent_id": "组织父级标识, 父组织标识集合, 如C组织属于B组织, B组织属于A组织, A无上级组织, 则此时C组织的pid为A:B",
"specific_parent_id": "真实具体的父组织标识, 如C组织属于B组织, 此时组织的specificParentId为B",
"create_time": "组织创建时间,时间戳",
"update_time": "组织更新时间,时间戳"
}
}
四、场景数据
4.1 场景执行数据
该消息只包含场景执行的关键信息,如果获取场景执行完整信息,请调用基础场景接口文档的#获取场景执行详细日志接口。
字段 |
必填 |
类型 |
备注 |
version |
True |
Int |
消息版本号 |
time |
True |
Long |
触发时间,毫秒时间戳 |
type |
True |
String |
消息类型,固定为:service |
extra |
True |
List<Object> |
消息附加字段列表 |
extra.scene_id |
True |
String |
场景ID |
extra.scene_name |
True |
String |
场景名称 |
extra.association_type |
True |
Int |
场景关联类型,1工区2普通3家庭 |
extra.association_id |
True |
String |
场景关联 ID |
extra.strategy_id |
False |
String |
策略ID |
extra.group_id |
False |
String |
分组ID |
extra.result |
True |
Int |
执行结果,1:全部执行成功;2:部分执行成功;3:全部执行失败 |
extra.type |
True |
Int |
场景类型 |
extra.push_config |
False |
Object |
推送信息 |
extra.push_config.ali |
False |
Object |
阿里推送信息 |
extra.push_config.ali.app_id |
False |
String |
平台启用阿里推送的安卓应用AppId |
extra.content |
False |
String |
推送消息内容 |
extra.log_id |
False |
String |
场景执行日志ID |
extra.log_detail_id |
False |
String |
场景执行详细日志ID |
{
"topic": "/scene/action",
"message_id": "消息ID",
"payload": {
"version":1,
"time":"时间",
"type":"service ",
"extra":[
{
"scene_id":"场景ID",
"scene_name":"场景名称",
"association_type":"关联类型:1工区2普通3家庭",
"association_id":"关联ID",
"strategy_id":"所属策略ID,工区场景会有该字段",
"type":"场景类型:1自动2手动",
"push_config":{
"ali":{
"app_id":"平台启用阿里推送的安卓应用AppId",
"content":"推送消息内容"
}
},
"log_id":"",
"log_detail_id":""
}
]
}
}