钉钉云推送数据格式

钉钉云推送数据表说明

钉钉云推送插入的数据库表创建请参考设置RDS实例接收钉钉推送。

钉钉云数据推送插入表逻辑

在推送数据表中，如上表格所示，subscribe_id、corp_id、biz_id、biz_type四个字段构成唯一索引。

当同一个订阅者(subscribe_id)订阅了某企业(corp_id)下的一个业务类目(biz_type)的一条数据(biz_id)：

• 一个订阅者订阅一个企业下的相同业务类目下的同一条数据只存在一条

• 当数据发生重复变更时，收件箱会删除老数据再插入新数据，收件箱的自增主键会发生变化

biz_type=2

当biz_type=2时，数据为套件票据suiteTicket最新状态。

该数据为定时推送，插入表open_sync_biz_data中。

biz_data数据如下所示：

{
    "syncAction":"suite_ticket",
    "suiteTicket":"QsfJCEVF1h6E9fAaGwnAzbvYzxxxxxxxx"
}

biz_type=4

当biz_type=4时，数据为企业授权应用的最新状态。

该数据为企业授权微应用、解除微应用授权、变更微应用的授权范围时刻推送，插入表open_sync_biz_data中。

biz_data数据如下：

{
    "syncAction": "org_suite_auth",
    "auth_corp_info": {
        "auth_channel": "",
        "auth_channel_type": "",
        "auth_level": 1,
        "corp_logo_url": "http://url.com",
        "corp_name": "浩倡测试企业申请认证",
        "corpid": "dingxxxxxxxxxxxxxx",
        "industry": "信息技术咨询",
        "invite_code": "000000",
        "invite_url": "http://url.com",
        "is_authenticated": true,
        "license_code": "xxx"
    },
    "auth_info": {
        "agent": [{
            "admin_list": ["aaaa", "bbbb"],
            "agent_name": "Demo",
            "agentid": 16000,
            "appid": 1234,
            "logo_url": "http://url.png"
        }]
    },
    "auth_user_info": {
        "userId": "xxxx"
    },
    "auth_scope": {
        "errcode": 0,
        "condition_field": [],
        "auth_user_field": ["position", "jobnumber", "avatar", "deviceId"],
        "auth_org_scopes": {
            "authed_user": [],
            "authed_dept": [1]
        },
        "errmsg": "ok"
    },
    "permanent_code": "xxxxxxxxxxxxx",
    "ch_permanent_code": "xxxxxxxxxxxxxx"
}

其中：

• syncAction字段的取值如下：

  • org_suite_auth：表示企业授权套件

  • org_suite_change：表示企业变更授权范围

  • org_suite_relieve：表示企业解除授权

• auth_corp_info, auth_info和auth_user_info 三段结构信息请参考获取企业授权信息。

• auth_scope结构信息请参考获取通讯录权限范围。

• permanent_code已废弃。

• ch_permanent_code已废弃。

biz_type=7

当biz_type=7时，数据为企业微应用的最新状态。

该数据为企业停用、启动微应用的时刻推送，插入表open_sync_biz_data中。

biz_data数据如下：

其中，syncAction字段的取值如下：

• org_micro_app_restore：微应用启用

  {
      "agentId":12345677,
      "syncAction":"org_micro_app_restore"
  }

• org_micro_app_stop：微应用停用

  {
      "agentId":12345677,
      "syncAction":"org_micro_app_stop"
  }

• org_micro_app_remove：微应用删除，保留企业对套件的授权

  {
      "agentId":12345677,
      "syncAction":"org_micro_app_remove"
  }

• org_micro_app_scope_update：微应用可见范围变更

  {
      "agentId":12345677,
      "syncAction":"org_micro_app_scope_update"
  }

biz_type=13

当biz_type=13时，数据为企业员工的最新状态。

该数据为在授权微应用的企业中，发生员工的增加、删除、修改的时刻推送，插入表open_sync_biz_data_medium中。

biz_data数据为如下两种Json格式，企业增加或修改员工，字段值来自于查询用户详情接口 。

• 增加企业员工：

  其中syncAction字段取值含义如下：

  • user_add_org：企业增加员工事件之后的员工信息

  • user_modify_org：企业修改员工事件之后的员工信息

  • user_dept_change：企业修改员工所在部门事件之后的员工信息

  • user_role_change：企业修改员工所在角色(包括管理员变更)事件之后的员工信息

  • user_active_org：用户加入企业后的激活信息，active字段为true时表示已激活

  {
      "errcode": 0,
      "unionid": "m8axYHBIiSxxxx",
      "syncAction": "user_modify_org",
      "openId": "kiPw6f4Awmxxxx",
      "roles": [{
          "id": 289179322,
          "name": "角色01",
          "groupName": "职务01",
          "type": 0
      }],
      "userid": "1234567",
      "isCustomizedPortal": true,
      "isLeaderInDepts": "{1234567:false}",
      "isBoss": false,
      "isSenior": false,
      "department": [1234567],
      "email": "",
      "orderInDepts": "{1234567:23422}",
      "mobile": "186xxxxxxxx",
      "errmsg": "ok",
      "active": true,
      "avatar": "http://static.dingtalk.com/media/lADOD3zI380B080B0w_467_467.jpg",
      "isAdmin": false,
      "isHide": false,
      "jobnumber": "90010100999",
      "name": "暖心",
      "stateCode": "86",
      "position": "1111"
  }

• 企业删除员工

  {
      "syncAction":"user_leave_org"
      // 删除员工userid从biz_id中获取
  }

biz_type=14

当biz_type=14时，数据为企业部门的最新状态。

该数据为在授权微应用的企业，发生部门的增加、删除、修改的时刻推送，插入表open_sync_biz_data_medium。

biz_data数据为如下两种Json格式，企业增加或修改部门，字段值来自获取部门详情接口 。

• 企业增加部门：

  其中syncAction字段取值含义如下：

  • org_dept_create：创建部门

  • org_dept_modify：修改部门

  {
      "errcode": 0,
      "userPerimits": "",
      "syncAction": "org_dept_create",
      "orgDeptOwner": "0541092856786053",
      "outerDept": false,
      "errmsg": "ok",
      "deptManagerUseridList": "",
      "parentid": 60398183,
      "groupContainSubDept": false,
      "outerPermitUsers": "",
      "outerPermitDepts": "",
      "deptPerimits": "",
      "createDeptGroup": true,
      "name": "部门02",
      "id": 60397224,
      "autoAddUser": true,
      "deptHiding": false,
      "order": 60397224
  }

• 企业删除部门

  {
      "syncAction":"org_dept_remove"
  }

biz_type=15

当biz_type=15时，数据为企业角色的最新状态。

该数据为在授权微应用的企业中，发生角色的增加、删除、修改的时刻推送，插入表open_sync_biz_data_medium中。

biz_data数据为如下两种Json格式：

• 企业增加/修改角色：企业增加角色事件之后的角色信息

  {
      "role_name": "角色01",
      "role_id": 12345,
      "group_id": 1,
      "group_name": "默认角色组",
      "syncAction": "org_role_add"
  }

• 企业删除角色：企业修改角色事件之后的角色信息

  {
      "syncAction":"org_role_remove"
  }

biz_type=16

当biz_type=16时，数据为企业的最新状态。

该数据为在授权微应用的企业中，企业信息发生变更的时刻推送，插入表open_sync_biz_data_medium中。

biz_data数据为如下两种 Json格式：

• 企业变更

  {
      "errcode": 0,
      "corpid": "dingxxxxxxxxxxxxxx",
      "auth_level": 1,
      "syncAction": "org_update",
      "errmsg": "ok",
      "industry": "信息技术咨询",
      "is_authenticated": true,
      "corp_name": "XX企业",
      "corp_logo_url": "http://static.dingtalk.com/media/lALPBY0V4xtagzFgYA_96_96.png"
  }

• 企业删除

  {
      "syncAction": "org_remove"
  }

biz_type=17

当biz_type=17时，数据为订单信息。

该数据为企业在钉钉服务市场购买开通应用产生订单时刻推送，插入表open_sync_biz_data中。

biz_data数据如下：

{
    "orderId": "312139204444444",
    "suiteId": 123123,
    "suiteKey": "xxxxxxxxx",
    "goodsName": "测试商品",
    "goodsCode": "xxxxxxxxxxx",
    "itemName": "测试规格",
    "itemCode": "xxxxxxx",
    "corpId": "dingxxxxxxxxxxxx",
    "maxOfPeople": 100,
    "minOfPeople": 0,
    "paidtime": 1524897069000,
    "serviceStopTime": 1524897069000,
    "payFee": 1000,
    "orderCreatSource": "xxxx",
    "distributorCorpName": "测试代理企业",
    "distributorCorpId": "dingxxxxxxxxxxxxx",
    "nominalPayFee": 1000,
    "discountFee": 0,
    "discount": 1,
    "subQuantity": 1,
    "serviceStartTime": 168000312000,
    "orderType": "RENEW",
    "unionId": "union1265341625"
}

字段说明：

biz_type=20

当biz_type=20时，数据为企业外部联系人的最新状态。

该数据为在授权微应用的企业中，发生外部联系人的增加、删除、修改的时刻推送，插入表open_sync_biz_data_medium中。

biz_data数据为如下两种 Json格式：

• 企业增加/修改外部联系人：

  • 当syncAction为contact_add_org时表示企业增加外部联系人事件之后的联系人信息。

  • 当syncAction为contact_modify_org时表示企业修改外部联系人事件之后的联系人信息。

    {
        "errcode": 0,
        "shareUserIds": [],
        "syncAction": "contact_modify_org",
        "mobile": "186xxx11111",
        "errmsg": "ok",
        "remark": "",
        "title": "",
        "userId": "2012130422-811754543",
        "shareDeptIds": [62039002],
        "labelIds": [83029],
        "followerUserId": "2000121002668",
        "name": "潜在客户小张",
        "stateCode": "86"
    }

• 企业删除外部联系人

  {"syncAction":"contact_leave_org"}

biz_type=22

当biz_type=22时，数据为由ISV通过接口发起的审批实例数据。

该数据为在授权微应用的企业中，当由ISV通过接口发起的审批出现变更的时刻产生数据推送，插入表open_sync_biz_data_medium中。

biz_data数据如下。

其中"syncAction" 字段取值含义如下：

• isv_bpms：一条审批记录的创建或者流程更新。

• isv_bpms_cancel：一条审批记录撤销（字段保留待开发）

{
    "orderId": "312139204444444",
    "suiteId": 123123xxx,
    "suiteKey": "xxxxxxxxx",
    "goodsName": "测试商品",
    "goodsCode": "xxxxxxxxxxx",
    "itemName": "测试规格",
    "itemCode": "xxxxxxx",
    "corpId": "dingxxxxxxxxxxxx",
    "maxOfPeople": 100,
    "minOfPeople": 0,
    "paidtime": 1524897069000,
    "serviceStopTime": 1524897069000,
    "payFee": 1000,
    "orderCreatSource": "xxxx",
    "distributorCorpName": "测试代理企业",
    "distributorCorpId": "dingxxxxxxxxxxxxx",
    "nominalPayFee": 1000,
    "discountFee": 0,
    "discount": 1.00,
    "subQuantity": 1
}

字段说明，请参考获取单个审批实例详情。

biz_type=32

当biz_type=32时，数据为智能硬件设备管理。

该数据为企业发生硬件设备绑定变更时推送，插入表open_sync_biz_data中。

biz_data数据如下。

• 绑定事件

  {
    "actionType": "bind",
    "corpId": "yourcorpid",
    "syncAction": "device_bind_update",
    "sn": "设备sn",
    "pk": "产品编码",
    "nodeType": 0,
    "deviceId": 设备id
  }

• 解绑事件

  {
    "actionType": "unbind",
    "corpId": "yourcorpid",
    "syncAction": "device_bind_update",
    "sn": "设备sn",
    "pk": "产品编码",
    "nodeType": 0,
    "deviceId": 设备id
  }
  

字段说明：

biz_type=37

当biz_type=37时，数据为订单到期或者退款导致的服务关闭数据。

该数据为企业在钉钉服务市场购买开通应用产生订单时刻推送，插入表open_sync_biz_data中。

biz_data数据如下。

 {
    "suiteId": 123,
    "corpId": "ding6121",
    "orderId": 500******005,
    "itemCode": "FW_GOODS-1***281-4",
    "eventType": "subscription_close",
    "mainGoodsName": "测试商品",
    "closeType": 3,
    "pushType": 0,
    "itemName": "3",
    "payFee": 121.0,
    "mainGoodsCode": "FW_GOODS-1***20281",
    "suiteKey": "suitew****bvi3euo",
    "goodsCode": "FW_GOODS-1***0281",
    "refundId": "2088",
    "serviceStartTime": 167000031311,
    "serviceStopTime": 168000031311,
    "openType":3
}

字段说明：

biz_type=63

应用商品新增个人试用后，增加了应用的触达率，为了方便ISV对客户进行后续跟踪和推广，组织/个人在应用试用后，钉钉后台新增了应用试用记录的回调信息。

目前试用的回调信息有两种：

1. 试用开通的订单信息

   试用开通的订单信息，侧重于订单信息回调。

2. 试用开通记录信息

   试用开通记录回调信息中不一定会有试用订单。

当biz_type=63时，为应用试用开通记录的回调信息。

当组织或个人应用试用开通时推送，插入表open_sync_biz_data中。

示例：

{
    "buyerUnionId":"mLyKVGiiwEXQ5mT0Nwxxxx",
    "suiteId":698002,
    "corpId":"dingd678857e4250521135c2f465xxxx",
    "fromDate":"2020-12-04 10:59:25",
    "endDate":"2020-12-19 10:59:25",
    "EventType":"goods_tryout",
    "appId":1948,
    "tryoutType":"enterprise_tryout",
    "goodsCode":"FW_GOODS-100030xxxx",
    "TimeStamp":"1607050765623"
}

字段说明：

biz_type=67

当biz_type=67时，数据为钉钉假期相关数据

该数据为企业发生假期相关的数据变更时推送，插入表open_sync_biz_data中。

biz_data各数据格式如下。

• 加班转调休假事件（新增、更新时会触发同步）

  {
      "syncAction": "overtime_to_vacation_data",
      "corpId": "ding33f33xxxx",
      "userId": "33506665005555",
      "workDate": "20210311",
      "overtimeDayType": "restDay",
      "overtimeDay": 0.262,
      "overtimeHour": 2.1,
      "workHoursPerDay": 8,
      "vacationRate": 2,
      "leaveCode": "c1f772d2-xxxx-407e-816a-55be5c245569",
      "startTime": 1615392000000,
      "endTime": 1640966399000,
      "delayEndTime": 1640966399000
  }
  

字段说明：

钉钉推送数据处理伪代码

• 处理推送数据的逻辑

  /**
   * @param subscribeId 订阅者ID。格式为套件ID加下划线0。例如12345_0
   */
  processMsgInbox(subscribeId):
      //加锁。对每个订阅者加锁。保证每个订阅者的收件箱同一时刻是有一个线程在处理。
      //如果开发者有多台机器,并发处理数据造成数据被并发重复处理。
      lock = tryLock(subscribeId)
  
      //如果获取锁失败,表示有其他线程在处理收件箱。返回
      //加锁是为了有多台机器或者多个线程同时处理收件箱任务的时候,发生并发问题。
      if !lock
          return
  
      //拉取待处理的收件箱数据列表
      list msgList = getMsgList(subscribeId,subscribeCursor )
  
      //循环处理每条消息数据,处理完之后更新每条数据的处理状态
      //自己定义。0为未处理状态。1为处理完成状态。2为处理失败状态。
      //如果有重试策略,可定义status状态为2,3,4,5表示重试过得次数。当重试次数大于5次不再重试
      //此处要有监控报警。当发现处理失败或者未处理的数据堆积，要报警
      for msg: msgList
          processStatus = processMsg(msg)
          updateMsgStatus(msg.getId,processStatus);
  
      //休眠一段时间,防止msgList 为空的时候死循环执行,系统压力增大
      sleep(500)
  
      //继续执行本方法
      return processMsgInbox(subscribeId)

• 在项目启动的时候立即执行处理钉钉推送数据

  onProjectStart:
      processMsgInbox(subscribeId)

• 定时任务补偿执行处理钉钉推送数据（作为补偿机制存在）

  onTask:
      processMsgInbox(subscribeId)