跳到主要内容

企业与员工相关回调

一. 员工认证成功回调通知​

1. 回调触发时机​

员工认证成功

2. 回调消息类型​

VerifyStaffInfo

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OrganizationIdString企业 ID，为32位字符串
UserIdString员工ID，为32位字符串
NameString员工姓名

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "VerifyStaffInfo",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
    "Name": "张三"
  }
}

二. 员工变更角色回调通知​

1. 回调触发时机​

员工变更角色

2. 回调消息类型​

RolesChange

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OrganizationIdString企业 ID，为32位字符串
UserIdString员工ID，为32位字符串
NameString员工姓名
BeforeRoleNamesstring 数组变更前角色名数组
AfterRoleNamesstring 数组变更后角色名数组

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "RolesChange",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
    "Name": "张三",
    "BeforeRoleNames": [],
    "AfterRoleNames": []
  }
}

三. 审批员工加入成功回调通知​

1. 回调触发时机​

审批员工加入成功

2. 回调消息类型​

ApproveEmployeeJoin

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OrganizationIdString企业 ID，为32位字符串
UserIdString员工ID，为32位字符串
NameString员工姓名

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "ApproveEmployeeJoin",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
    "Name": "张三"
  }
}

四. 员工离职回调通知​

1. 回调触发时机​

员工离职

2. 回调消息类型​

QuiteJob

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
UserIdString员工ID，为32位字符串
UserNameString员工姓名
UserMobileString员工的手机号

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "QuiteJob",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
    "UserName": "张三",
    "UserMobile": "188****1234"
  }
}

五. 企业超管变更回调通知​

1. 回调触发时机​

企业超管变更

2. 回调消息类型​

SuperAdminChange

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OrganizationIdString企业 ID，为32位字符串
OldAdminUserIdString旧超管的员工ID，为32位字符串
OldAdminNameString旧超管的姓名
OldAdminMobileString旧超管的手机号
NewAdminUserIdString新超管的员工ID，为32位字符串
NewAdminNameString新超管的姓名
NewAdminMobileString新超管的手机号

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "SuperAdminChange",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "OldAdminUserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
    "OldAdminName": "张三",
    "OldAdminMobile": "188****1234",
    "NewAdminUserId": "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R",
    "NewAdminName": "李四",
    "NewAdminMobile": "189****1111"
  }
}

六. 企业基础信息变更回调通知​

1. 回调触发时机​

企业基础信息变更

2. 回调消息类型​

ModifyOrganizationBaseInfo

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OrganizationIdString企业 ID，为32位字符串
OrganizationChangeBaseInfoOrganizationChangeBaseInfo变更基础信息
OperatorString操作人姓名
OperateTimeInteger操作的Unix时间戳

OrganizationChangeBaseInfo结构体定义

参数名称参数类型参数描述
OrganizationNameNewString修改后的企业名
LegalNameNewString修改后的法人姓名
RegionNewString修改后的企业地区
AddressNewString修改后的企业地址
OrganizationNameString修改前的企业名
LegalNameString修改前的法人姓名
RegionString修改前的企业地区
AddressString修改前的企业地址

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "ModifyOrganizationBaseInfo",
  "MsgVersion": "CustomApp",
  "Operator": "张三",
  "OperateTime": 1683545268,
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "OrganizationChangeBaseInfo": {
      "OrganizationNameNew": "企业名2",
      "LegalNameNew": "李四",
      "RegionNew": "地区2",
      "AddressNew": "地址2",
      "OrganizationName": "企业名1",
      "LegalName": "张三",
      "Region": "地区1",
      "Address": "地址1"
    }
  }
}

七. 企业注销回调通知​

1. 回调触发时机​

企业注销

2. 回调消息类型​

CloseOrganization

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OrganizationIdString企业 ID，为32位字符串
OperatorNameString注销操作人姓名
OrganizationNameString企业名称
CloseTimeInteger注销的Unix时间戳

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "CloseOrganization",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "OperatorName": "张三",
    "OrganizationName": "典子谦示例企业",
    "CloseTime": 1683545268
  }
}

八. 集团子企业加入回调通知​

1. 回调触发时机​

集团子企业加入

2. 回调消息类型​

SubOrganizationJoinOrganizationGroup

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
MainOrganizationIdString主企业ID，为32位字符串
MainOrganizationNameString主企业名
SubOrganizationIdString子企业ID，为32位字符串
SubOrganizationNameString子企业名
OperatorIDString操作人的员工ID，为32位字符串
OperatorNameString操作人名称

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "UnbindOrganizationGroup",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "MainOrganizationId": "yDxbWUyKQDxxxxxO4zjEB8mxCcDjAyF",
    "MainOrganizationName": "集团主企业",
    "SubOrganizationId": "yDxbNUyKQDxxxxxO4zjEwvl3XYQmAcO",
    "SubOrganizationName": "子企业",
    "OperatorID": "yDRCLUUgygqxxxxxuO4zjEwg0vjoimj",
    "OperatorName": "张三"
  }
}

九. 集团子企业解除回调通知​

1. 回调触发时机​

集团子企业解除

2. 回调消息类型​

UnbindOrganizationGroup

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OperatorUserIdString操作人的员工ID，为32位字符串
OperatorOrganizationIdString操作人所属企业ID，为32位字符串
MainOrganizationIdString解绑的主企业ID，为32位字符串
SubOrganizationIdString解绑的子企业ID，为32位字符串

5. 示例​

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "UnbindOrganizationGroup",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OperatorUserId": "yDRCLUUgygqxxxxxuO4zjEwg0vjoimj",
    "OperatorOrganizationId": "yDxbWUyKQDxxxxx4zjEB8mxCcDjAyF",
    "MainOrganizationId": "yDxbWUyKQDxxxxxO4zjEB8mxCcDjAyF",
    "SubOrganizationId": "yDxbNUyKQDxxxxxO4zjEwvl3XYQmAcO"
  }
}

十. 企业拓展服务操作回调​

1. 回调触发时机​

开通/关闭某项企业拓展服务

2. 回调消息类型​

OperateExtendedService

3. 其他说明​

ServiceType 枚举值

拓展服务枚举值
企业自动签署OPEN_SERVER_SIGN
企业与港澳台居民签署合同OVERSEA_SIGN
拓宽签署方年龄限制AGE_LIMIT_EXPANSION
个人签署方仅校验手机号MOBILE_CHECK_APPROVER
隐藏合同经办人姓名HIDE_OPERATOR_DISPLAY
骑缝章PAGING_SEAL
短信通知签署方ORGANIZATION_FLOW_NOTIFY_TYPE
正楷临摹签名失败后更换其他签名类型ORGANIZATION_OCR_FALLBACK
个人签署方手动签字HIDE_ONE_KEY_SIGN
签署密码开通引导ORGANIZATION_FLOW_PASSWD_NOTIFY

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
OrganizationIdString企业 ID，为32位字符串
OperatorUserIdString操作人的员工ID，为32位字符串
IsMainOrganizationControlBool集团企业场景下，表示此拓展服务是否是由主企业管控 （主企业开-子企业开 主企业关-子企业关）子企业无操作权限
ServiceTypeString拓展服务类型，枚举值见 3.其他说明
ServiceStatusString拓展服务状态 DISABLE-服务关闭 ENABLE-服务开通
OperateTimeInteger操作时间戳,格式为Unix标准时间戳（秒）

5. 示例​

{
  "MsgId": "yDSLFUUckptn3yt1UuePjuk1oh49ed2Y",
  "MsgType": "OperateExtendedService",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "OperatorUserId": "yDxbTUyKQWPt6FucO4zjEuyFAyOX2v7C",
    "ServiceType": "ORGANIZATION_FLOW_NOTIFY_TYPE",
    "ServiceStatus": "ENABLE",
    "OperateTime": 1701138838,
    "IsMainOrganizationControl": true
  }
}