企业与员工相关回调
一. 员工认证成功回调通知
1. 回调触发时机
员工认证成功
2. 回调消息类型
VerifyStaffInfo
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业 ID,为32位字符串 |
UserId | String | 员工ID,为32位字符串 |
Name | String | 员工姓名 |
5. 示例
{
"MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
"MsgType": "VerifyStaffInfo",
"MsgVersion": "CustomApp",
"MsgData": {
"OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
"Name": "张三"
}
}
二. 员工变更角色回调通知
1. 回调触发时机
员工变更角色
2. 回调消息类型
RolesChange
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业 ID,为32位字符串 |
UserId | String | 员工ID,为32位字符串 |
Name | String | 员工姓名 |
BeforeRoleNames | string 数组 | 变更前角色名数组 |
AfterRoleNames | string 数组 | 变更后角色名数组 |
5. 示例
{
"MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
"MsgType": "RolesChange",
"MsgVersion": "CustomApp",
"MsgData": {
"OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
"Name": "张三",
"BeforeRoleNames": [],
"AfterRoleNames": []
}
}
三. 审批员工加入成功回调通知
1. 回调触发时机
审批员工加入成功
2. 回调消息类型
ApproveEmployeeJoin
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业 ID,为32位字符串 |
UserId | String | 员工ID,为32位字符串 |
Name | String | 员工姓名 |
5. 示例
{
"MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
"MsgType": "ApproveEmployeeJoin",
"MsgVersion": "CustomApp",
"MsgData": {
"OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
"Name": "张三"
}
}
四. 员工离职回调通知
1. 回调触发时机
员工离职
2. 回调消息类型
QuiteJob
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
UserId | String | 员工ID,为32位字符串 |
UserName | String | 员工姓名 |
UserMobile | String | 员工的手机号 |
5. 示例
{
"MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
"MsgType": "QuiteJob",
"MsgVersion": "CustomApp",
"MsgData": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
"UserName": "张三",
"UserMobile": "188****1234"
}
}
五. 企业超管变更回调通知
1. 回调触发时机
企业超管变更
2. 回调消息类型
SuperAdminChange
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业 ID,为32位字符串 |
OldAdminUserId | String | 旧超管的员工ID,为32位字符串 |
OldAdminName | String | 旧超管的姓名 |
OldAdminMobile | String | 旧超管的手机号 |
NewAdminUserId | String | 新超管的员工ID,为32位字符串 |
NewAdminName | String | 新超管的姓名 |
NewAdminMobile | String | 新超管的手机号 |
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结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业 ID,为32位字符串 |
OrganizationChangeBaseInfo | OrganizationChangeBaseInfo | 变更基础信息 |
Operator | String | 操作人姓名 |
OperateTime | Integer | 操作的Unix时间戳 |
OrganizationChangeBaseInfo结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationNameNew | String | 修改后的企业名 |
LegalNameNew | String | 修改后的法人姓名 |
RegionNew | String | 修改后的企业地区 |
AddressNew | String | 修改后的企业地址 |
OrganizationName | String | 修改前的企业名 |
LegalName | String | 修改前的法人姓名 |
Region | String | 修改前的企业地区 |
Address | String | 修改前的企业地址 |
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结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业 ID,为32位字符串 |
OperatorName | String | 注销操作人姓名 |
OrganizationName | String | 企业名称 |
CloseTime | Integer | 注销的Unix时间戳 |
5. 示例
{
"MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
"MsgType": "CloseOrganization",
"MsgVersion": "CustomApp",
"MsgData": {
"OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"OperatorName": "张三",
"OrganizationName": "典子谦示例企业",
"CloseTime": 1683545268
}
}
八. 集团子企业加入回调通知
1. 回调触发时机
集团子企业加入
2. 回调消息类型
SubOrganizationJoinOrganizationGroup
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
MainOrganizationId | String | 主企业ID,为32位字符串 |
MainOrganizationName | String | 主企业名 |
SubOrganizationId | String | 子企业ID,为32位字符串 |
SubOrganizationName | String | 子企业名 |
OperatorID | String | 操作人的员工ID,为32位字符串 |
OperatorName | String | 操作人名称 |
5. 示例
{
"MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
"MsgType": "UnbindOrganizationGroup",
"MsgVersion": "CustomApp",
"MsgData": {
"MainOrganizationId": "yDxbWUyKQDxxxxxO4zjEB8mxCcDjAyF",
"MainOrganizationName": "集团主企业",
"SubOrganizationId": "yDxbNUyKQDxxxxxO4zjEwvl3XYQmAcO",
"SubOrganizationName": "子企业",
"OperatorID": "yDRCLUUgygqxxxxxuO4zjEwg0vjoimj",
"OperatorName": "张三"
}
}
九. 集团子企业解除回调通知
1. 回调触发时机
集团子企业解除
2. 回调消息类型
UnbindOrganizationGroup
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OperatorUserId | String | 操作人的员工ID,为32位字符串 |
OperatorOrganizationId | String | 操作人所属企业ID,为32位字符串 |
MainOrganizationId | String | 解绑的主企业ID,为32位字符串 |
SubOrganizationId | String | 解绑的子企业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结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业 ID,为32位字符串 |
OperatorUserId | String | 操作人的员工ID,为32位字符串 |
IsMainOrganizationControl | Bool | 集团企业场景下,表示此拓展服务是否是由主企业管控 (主企业开-子企业开 主企业关-子企业关)子企业无操作权限 |
ServiceType | String | 拓展服务类型,枚举值见 3.其他说明 |
ServiceStatus | String | 拓展服务状态 DISABLE-服务关闭 ENABLE-服务开通 |
OperateTime | Integer | 操作时间戳,格式为Unix标准时间戳(秒) |
5. 示例
{
"MsgId": "yDSLFUUckptn3yt1UuePjuk1oh49ed2Y",
"MsgType": "OperateExtendedService",
"MsgVersion": "CustomApp",
"MsgData": {
"OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"OperatorUserId": "yDxbTUyKQWPt6FucO4zjEuyFAyOX2v7C",
"ServiceType": "ORGANIZATION_FLOW_NOTIFY_TYPE",
"ServiceStatus": "ENABLE",
"OperateTime": 1701138838,
"IsMainOrganizationControl": true
}
}
十一. 企业引导企业实名认证后回调
1. 回调触发时机
当企业调用创建企业认证链接生成企业认证链接,用户通过链接认证企业之后,会触发回调。
2. 回调消息类型
CreateOrganization
3. 其他说明
仅通过链接认证的企业会触发回调。
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业在电子签的ID,为32位字符串 |
OrganizationName | String | 企业用户认证时的企业名称 |
UniformSocialCreditCode | Bool | 企业社会统一信用代码 |
LegalName | String | 企业的法人姓名,仅法人授权或者法人认证的方式会返回 |
AdminName | String | 企业的超管姓名,进行认证的操作人的姓名 |
AdminMobile | String | 企业的超管姓名,进行认证的操作人的手机号 |
AdminUserId | String | 企业的超管在电子签的 userId,为32位字符串 |
CreateTime | Integer | 企业认证时的时间 |
5. 示例
{
"MsgId": "yDCZmUUn6x696nUEgx6BkysNQT07EM8R",
"MsgType": "CreateOrganization",
"MsgVersion": "CustomApp",
"MsgData": {
"OrganizationId": "yDCZoUUnii8ymsXXXXXXXXXXXqukE1vN",
"OrganizationName": "典子谦示例企",
"UniformSocialCreditCode": "91XXXXXXXXXXXXXX5E",
"LegalName": "典子谦",
"AdminName": "电子签",
"AdminMobile": "13200000000",
"AdminUserId": "yDCZmUUn6xc6w5UXXXXXXXXXXsSTXubA",
"CreateTime": 1715347180
}
}
十二. 企业引导个人实名认证后回调
1. 回调触发时机
当企业调用获取c端用户实名链接生成认证链接,用户通过链接认证后,会触发回调。
2. 回调消息类型
UserAccountVerify
3. 其他说明
仅通过链接认证的用户会触发回调。
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
UserId | String | 用户在电子签的ID,为32位字符串 |
Name | String | 个人用户实名时使用的姓名 |
IdCardNumber | Bool | 个人用户实名时使用的身份证号,脱敏展示 |
VerifyTime | Integer | 个人用户实名时的时间 |
Mobile | String | 个人用户实名时使用的手机号,脱敏展示 |
UserData | String | 企业调用获取c端用户实名链接的时,传入的参数UserData将被返回,以便业务方进行相应的对应处理。 |
5. 示例
{
"MsgId": "yDCZoUUckpysujqlUusiyOcSeyIsvT4x",
"MsgType": "UserAccountVerify",
"MsgVersion": "CustomApp",
"MsgData": {
"UserId": "yDCZoUUckpysx67fUy718KVyFRkxSEij",
"Name": "典子谦",
"IdCardNumber": "1****************0",
"VerifyTime": 1715244216,
"Mobile": "151****2929",
"UserData": "MTIzNDU2Nzg5"
}
}
十三. 个人/员工手机号修改后回调
1. 回调触发时机
- 企业员工正常手机号换绑的时候会进行回调
- 当个人用户是通过调用获取c端用户实名链接生成认证链接,用户通过链接认证后实名的, 再通过生成修改用户手机号链接的链接进入进行手机号换绑时会进行回调。
2. 回调消息类型
UserMobileChange
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
UserId | String | 用户在电子签的ID,为32位字符串 |
Name | String | 实名用户的姓名 |
OldMobile | Bool | 实名用户换绑之前的手机号,脱敏展示 |
Mobile | String | 实名用户换绑之后的手机号,脱敏展示 |
UserData | String | 企业调用生成修改用户手机号链接的时,传入的参数UserData将被返回,以便业务方进行相应的对应处理。 |
5. 示例
{
"MsgId": "yDCZiUUckpyxrqlrUuXcv2BXj8dwz0ix",
"MsgType": "UserMobileChange",
"MsgVersion": "CustomApp",
"MsgData": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
"Name": "电子签",
"OldMobile": "133****0531",
"NewMobile": "133****0532",
"UserData": ""
}
}
十四. 授权书认证审核结果回调
1. 回调触发时机
- 超管授权书审核之后会进行回调,审核通过和审核拒绝都会回调。
- 当用户是通过调用创建企业认证链接-单链接生成企业认证链接,用户通过链接进行企业实名, 若使用的认证方式是超管授权书认证,在电子签平台审核之后会将结果返回给用户。
2. 回调消息类型
OrganizationAuthorizationFileReview
3. 其他说明
仅通过通过调用创建企业认证链接-单链接生成企业认证链接,并且授权方式为超管授权书认证的才会进行授权书的结果回调。
4. 回调结构体
MsgData结构体定义
参数名称 | 参数类型 | 参数描述 |
---|---|---|
OrganizationId | String | 企业在电子签的ID,为32位字符串 |
OrganizationName | String | 企业用户认证时的企业名称 |
AuthorizationId | String | 企业认证流的Id,为 32位字符串 |
ReviewResult | String | 审核结果(审核通过/审核拒绝) |
ReviewRemark | String | 审核失败原因 |
ReviewTime | Integer | 审核时间 |
5. 示例
{
"MsgId": "yDCHHUUckpbdjiseUEA6RDf87KjAfMKl",
"MsgType": "OrganizationAuthorizationFileReview",
"MsgVersion": "CustomApp",
"MsgData": {
"OrganizationId": "yDCHHUUckpbdaiq4UxJVsHW19eRkE1hy",
"OrganizationName": "典子谦的批量测试企业1",
"AuthorizationId": "yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY",
"ReviewResult": "审核拒绝",
"ReviewRemark": "错误",
"ReviewTime": 1723541110
}
}