达实AIoT
文档中心
快速开始
  • 单点登录对接
  • 开放接口对接
  • 领域模型事件对接
  • 私有部署
  • 应用开发指南
  • DASDesign
IoT平台
应用平台
  • 低代码工具
  • 基础服务
  • 系统运维
  • 场景模型
应用
  • 物业管理
  • 数据中心
  • 智慧园区IPS
  • 园区服务
  • 物业管理
  • 场景模型
  • 会议
  • 门禁
  • 停车场
文档中心
快速开始
  • 单点登录对接
  • 开放接口对接
  • 领域模型事件对接
  • 私有部署
  • 应用开发指南
  • DASDesign
IoT平台
应用平台
  • 低代码工具
  • 基础服务
  • 系统运维
  • 场景模型
应用
  • 物业管理
  • 数据中心
  • 智慧园区IPS
  • 园区服务
  • 物业管理
  • 场景模型
  • 会议
  • 门禁
  • 停车场
期待您的声音
  1. 外部事件
  • 领域模型
  • 领域事件
    • 领域模型事件定义
    • 外部事件
      • 2-1 车行场景事件(开发中)
      • 2-2 人行场景事件
      • 2-3 会议事件 (开发中)
      • 2-6 组织事件
      • 2-7 用户事件
      • 2-8 空间事件
      • 2-9 企业事件
      • 2-10 客户事件
      • 2-11 排班事件
      • 2-12安防事件
      • 异常事件处理
    • 平台事件
      • 0-前缀说明 1: IoT 2: 项目
      • 2-1 用户事件
      • 2-2 设备中心事件
      • 2-3 物联网设备属性上报
      • 2-4 物联网设备事件上报
      • 2-5 客户事件
      • 2-6 机构事件(组织)
      • 2-7 空间事件
      • 2-8 客户权限领域事件
      • 2-9 产品事件
      • 2-10 设备空间事件
      • 2-11 告警中心事件
      • 2-12 人行场景事件
      • 2-13 工单事件
      • 2-14 角色事件
  • 云端开发指南
    • 推送业务事件消息
      POST
  1. 外部事件

2-10 客户事件

2.10 客户事件(标准外部事件)#

Topic(租户级):{tenant}/proj_{projectId}/v1-business-model-customer
Topic(租户级):{tenant}/proj_{projectId}/v1-business-model-error-customer
error标识此topic是外部业务模型事件的错误响应消息

2.10.1 客户增删改事件(s0140001)#

事件定义#

事件名称事件类型事件描述
add通知型客户新增事件
edit通知型客户更新事件
delete通知型客户删除事件

客户新增事件#

{
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0140001",
        "appType": "customer",
        "modelId": 140001
    },
    "events": {
        "add": {
            "eventTs": 148813512323,
            "eventType": 1,
            "customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别"
            }]
        }
    }
}

客户新增错误告警事件#

{
  	"msgId":"hfjld729jc927894n02783n49"//建议uuid确定消息唯一性
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0120001",
        "appType": "customer",
        "modelId": 120001
    },
    "events": {
        "add_error": {
            "eventTs": 148813512323,
            "eventType": 2, //2标识这是错误告警
          	"msg":"添加客户失败", //公共参数,数据类型:string;与api公共参数一致
          	"status":"CUSTOMER_ADD_ERROR",//错误码,数据类型:string;与api公共参数一致
          	"code":400,//错误码,默认400,数据类型:int;与api公共参数一致
            "customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别"
            }]
        }
    }
}

字段定义#

字段名称字段类型字段描述是否必传长度
eventTypeint事件类型,此处默认1是
eventTslong事件时间是13
idstring来源方主键id是36
projectIdlong项目id是36
namestring姓名是20
phonestring电话是15
idTypeint证件类型,0:代表空,1:身份证,2:护照,3:港澳通行证,4:其他否11
idNumberstring证件号码否45
sexint性别,0:代表未填,1:男,2:女否2
ageint年龄否10
spaceIdsstring[]所属空间否
customerGradeIdlong客户级别否36
customerTypeIdlong客户类型否36
contractNamestring紧急联系人否50
contractPhonestring紧急联系人电话否15
addressstring地址否50
emailstring邮箱否50
remarkstring备注否100
bornDatelong出生年月否36
nativePlacestring籍贯否20
nationstring名族否20
marriageint婚姻,0:代表未填空,1:未婚,2:已婚,3:离婚,4:丧偶否2
educationint学历,0:代表未填空,1:小学,2:初中,3:中专/高中,4:专科,5:本科,6:硕士,7:博士否2
professionstring职业否20
specialitystring特长否50
intereststring兴趣爱好否20
characterstring性格否20
postalCodestring邮政编码否20
companyIdsstring[]关联企业ids否
jobNumstring员工工号否20
roleIdlong角色id否36
facePhotostring人脸识别否255

客户更新事件#

{
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0140001",
        "appType": "customer",
        "modelId": 140001
    },
    "events": {
        "edit": {
            "eventTs": 148813512323,
            "eventType": 1,
          	"customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别"
            }]
        }
    }
}

客户更新错误告警事件#

{
  	"msgId":"hfjld729jc927894n02783n49"//建议uuid确定消息唯一性
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0120001",
        "appType": "customer",
        "modelId": 120001
    },
    "events": {
        "edit_error": {
            "eventTs": 148813512323,
            "eventType": 2, //2标识这是错误告警
          	"msg":"更新客户失败", //公共参数,数据类型:string;与api公共参数一致
          	"status":"CUSTOMER_EDIT_ERROR",//错误码,数据类型:string;与api公共参数一致
          	"code":400,//错误码,默认400,数据类型:int;与api公共参数一致
            "customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别"
            }]
        }
    }
}

字段定义#

字段名称字段类型字段描述是否必传长度
eventTypeint事件类型,此处默认1是
eventTslong事件时间是13
idstring来源方主键id是36
projectIdlong项目id是36
namestring姓名是20
phonestring电话是15
idTypeint证件类型,0:代表空,1:身份证,2:护照,3:港澳通行证,4:其他否11
idNumberstring证件号码否45
sexint性别,0:代表未填,1:男,2:女否2
ageint年龄否10
spaceIdsstring[]所属空间否
customerGradeIdlong客户级别否36
customerTypeIdlong客户类型否36
contractNamestring紧急联系人否50
contractPhonestring紧急联系人电话否15
addressstring地址否50
emailstring邮箱否50
remarkstring备注否100
bornDatelong出生年月否36
nativePlacestring籍贯否20
nationstring名族否20
marriageint婚姻,0:代表未填空,1:未婚,2:已婚,3:离婚,4:丧偶否2
educationint学历,0:代表未填空,1:小学,2:初中,3:中专/高中,4:专科,5:本科,6:硕士,7:博士否2
professionstring职业否20
specialitystring特长否50
intereststring兴趣爱好否20
characterstring性格否20
postalCodestring邮政编码否20
companyIdsstring[]关联企业ids否
jobNumstring员工工号否20
roleIdlong角色id否36
facePhotostring人脸识别否255

客户删除事件#

{
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0140001",
        "appType": "customer",
        "modelId": 140001
    },
    "events": {
        "delete": {
            "eventTs": 148813512323,
            "eventType": 1,
          	"customerList"[{
              "phone":"手机号",
              "id":"来源方主键id"
        		}]
        }
    }
}

客户删除错误告警事件#

{
  	"msgId":"hfjld729jc927894n02783n49"//建议uuid确定消息唯一性
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0120001",
        "appType": "customer",
        "modelId": 120001
    },
    "events": {
        "delete_error": {
            "eventTs": 148813512323,
            "eventType": 2, //2标识这是错误告警
          	"msg":"删除客户失败", //公共参数,数据类型:string;与api公共参数一致
          	"status":"CUSTOMER_DELETE_ERROR",//错误码,数据类型:string;与api公共参数一致
          	"code":400,//错误码,默认400,数据类型:int;与api公共参数一致
            "customerList"[{
              "phone":"手机号",
              "id":"来源方主键id"
        		}]
        }
    }
}

字段定义#

字段名称字段类型字段描述是否必传长度
eventTypeint事件类型,此处默认1是
eventTslong事件时间是YYYY-mm-dd HH:MM:SS
phonestring手机号否11
idstring来源方主键id是36

2.10 客户事件(非标准外部事件)#

Topic:{tenant}/proj_{projectId}/{version}-customization-{厂商、平台或子系统名称}-customer
Topic:{tenant}/proj_{projectId}/{version}-customization-{厂商、平台或子系统名称}-error-customer
error标识此topic是外部业务模型事件的错误响应消息

2.10.1 客户增删改事件(s0140001)#

事件定义#

事件名称事件类型事件描述
add通知型客户新增事件
edit通知型客户更新事件
delete通知型客户删除事件

客户新增事件#

{
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0140001",
        "appType": "customer",
        "modelId": 140001
    },
    "events": {
        "add": {
            "eventTs": 148813512323,
            "eventType": 1,
            "customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别",
  						"meta":{
                  "key1":"value1",
                  "key2":"value2"
              }
            }]
        }
    }
}

客户新增错误告警事件#

{
  	"msgId":"hfjld729jc927894n02783n49"//建议uuid确定消息唯一性
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0120001",
        "appType": "customer",
        "modelId": 120001
    },
    "events": {
        "add_error": {
            "eventTs": 148813512323,
            "eventType": 2, //2标识这是错误告警
          	"msg":"添加客户失败", //公共参数,数据类型:string;与api公共参数一致
          	"status":"CUSTOMER_ADD_ERROR",//错误码,数据类型:string;与api公共参数一致
          	"code":400,//错误码,默认400,数据类型:int;与api公共参数一致
            "customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别",
  						"meta":{
                  "key1":"value1",
                  "key2":"value2"
              }
            }]
        }
    }
}

字段定义#

字段名称字段类型字段描述是否必传长度
eventTypeint事件类型,此处默认1是
eventTslong事件时间是13
idstring来源方主键id是36
projectIdlong项目id是36
namestring姓名是20
phonestring电话是15
idTypeint证件类型,0:代表空,1:身份证,2:护照,3:港澳通行证,4:其他否11
idNumberstring证件号码否45
sexint性别,0:代表未填,1:男,2:女否2
ageint年龄否10
spaceIdsstring[]所属空间否
customerGradeIdlong客户级别否36
customerTypeIdlong客户类型否36
contractNamestring紧急联系人否50
contractPhonestring紧急联系人电话否15
addressstring地址否50
emailstring邮箱否50
remarkstring备注否100
bornDatelong出生年月否36
nativePlacestring籍贯否20
nationstring名族否20
marriageint婚姻,0:代表未填空,1:未婚,2:已婚,3:离婚,4:丧偶否2
educationint学历,0:代表未填空,1:小学,2:初中,3:中专/高中,4:专科,5:本科,6:硕士,7:博士否2
professionstring职业否20
specialitystring特长否50
intereststring兴趣爱好否20
characterstring性格否20
postalCodestring邮政编码否20
companyIdsstring[]关联企业ids否
jobNumstring员工工号否20
roleIdlong角色id否36
facePhotostring人脸识别否255
metaObject扩展信息(用于传递特殊字段)否

客户更新事件#

{
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0140001",
        "appType": "customer",
        "modelId": 140001
    },
    "events": {
        "edit": {
            "eventTs": 148813512323,
            "eventType": 1,
          	"customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别",
  						"meta":{
                  "key1":"value1",
                  "key2":"value2"
              }
            }]
        }
    }
}

客户更新错误告警事件#

{
  	"msgId":"hfjld729jc927894n02783n49"//建议uuid确定消息唯一性
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0120001",
        "appType": "customer",
        "modelId": 120001
    },
    "events": {
        "edit_error": {
            "eventTs": 148813512323,
            "eventType": 2, //2标识这是错误告警
          	"msg":"更新客户失败", //公共参数,数据类型:string;与api公共参数一致
          	"status":"CUSTOMER_EDIT_ERROR",//错误码,数据类型:string;与api公共参数一致
          	"code":400,//错误码,默认400,数据类型:int;与api公共参数一致
            "customerList"[{
          		"id":"来源方主键id"//对应通行证的全局唯一UserId
              "projectId": "项目id",
              "name": "姓名",
              "phone": "10086",
              "idType": 0,
              "idNumber": "证件号码",
              "sex": 0,
              "age": "年龄",
              "spaceIds": [],
              "customerGradeId": null,
              "customerTypeId": null,
              "contractName": "紧急联系人",
              "contractPhone": "紧急联系人电话",
              "address": "地址",
              "email": "邮箱",
              "remark": "备注",
              "bornDate": null,
              "nativePlace": "籍贯",
              "nation": "名族",
              "marriage": 0,
              "education": 0,
              "profession": "职业",
              "speciality": "特长",
              "interest": "兴趣爱好",
              "character": "性格",
              "postalCode": "邮政编码",
              "companyIds": [
                "1117745722292428800"
              ],
              "jobNum": "员工工号",
              "facePhoto": "人脸识别",
  						"meta":{
                  "key1":"value1",
                  "key2":"value2"
              }
            }]
        }
    }
}

字段定义#

字段名称字段类型字段描述是否必传长度
eventTypeint事件类型,此处默认1是
eventTslong事件时间是13
idstring来源方主键id是36
projectIdlong项目id是36
namestring姓名是20
phonestring电话是15
idTypeint证件类型,0:代表空,1:身份证,2:护照,3:港澳通行证,4:其他否11
idNumberstring证件号码否45
sexint性别,0:代表未填,1:男,2:女否2
ageint年龄否10
spaceIdsstring[]所属空间否
customerGradeIdlong客户级别否36
customerTypeIdlong客户类型否36
contractNamestring紧急联系人否50
contractPhonestring紧急联系人电话否15
addressstring地址否50
emailstring邮箱否50
remarkstring备注否100
bornDatelong出生年月否36
nativePlacestring籍贯否20
nationstring名族否20
marriageint婚姻,0:代表未填空,1:未婚,2:已婚,3:离婚,4:丧偶否2
educationint学历,0:代表未填空,1:小学,2:初中,3:中专/高中,4:专科,5:本科,6:硕士,7:博士否2
professionstring职业否20
specialitystring特长否50
intereststring兴趣爱好否20
characterstring性格否20
postalCodestring邮政编码否20
companyIdsstring[]关联企业ids否
jobNumstring员工工号否20
roleIdlong角色id否36
facePhotostring人脸识别否255
metaObject扩展信息(用于传递特殊字段)否

客户删除事件#

{
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0140001",
        "appType": "customer",
        "modelId": 140001
    },
    "events": {
        "delete": {
            "eventTs": 148813512323,
            "eventType": 1,
          	"customerList"[{
              "phone":"手机号",
              "id":"来源方主键id",
  						"meta":{
                  "key1":"value1",
                  "key2":"value2"
              }
        		}]
        }
    }
}

客户删除错误告警事件#

{
  	"msgId":"hfjld729jc927894n02783n49"//建议uuid确定消息唯一性
    "reportTs": 1661154622,
    "profile": {
        "poiCode": "s0120001",
        "appType": "customer",
        "modelId": 120001
    },
    "events": {
        "delete_error": {
            "eventTs": 148813512323,
            "eventType": 2, //2标识这是错误告警
          	"msg":"删除客户失败", //公共参数,数据类型:string;与api公共参数一致
          	"status":"CUSTOMER_DELETE_ERROR",//错误码,数据类型:string;与api公共参数一致
          	"code":400,//错误码,默认400,数据类型:int;与api公共参数一致
            "customerList"[{
              "phone":"手机号",
              "id":"来源方主键id",
  						"meta":{
                  "key1":"value1",
                  "key2":"value2"
              }
        		}]
        }
    }
}

字段定义#

字段名称字段类型字段描述是否必传长度
eventTypeint事件类型,此处默认1是
eventTslong事件时间是13
phonestring手机号否11
idstring来源方主键id是36
metaObject扩展信息(用于传递特殊字段)否

Tips#

如用gpt生成,可参考的prompt:
将以下json生成一份java类结构,需要满足以下要求:
1、除了events下层的结构是动态的,上层应该是一个泛型;
2、只需要可写。
json是:
如用json生成JavaBean,可用转换工具BEJSON

期待您的宝贵建议

微信扫描二维码,为我们的AIoT产品提出您的宝贵建议,用户体验是我们坚持不懈的追求。

微信扫描二维码
上一页
2-9 企业事件
下一页
2-11 排班事件
Built with