企业与员工相关回调
一. 平台企业授权电子签通知
1. 回调触发时机
企业通过生成子客登录链接进入激活流程后，点击"确认授权"按钮后触发此回调
2. 回调消息类型
OrgAuth
3. 其他说明
此时企业还未注册成功
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 点击按钮的第三方平台子客企业员工的唯一标识 |
| AuthSuccess | Boolean | 是否点击授权 |
5. 示例
{
"MsgId": "yDRIGUUgygs8oey1UuO4zjEC8S6bOcm8",
"MsgType": "OrgAuth",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId": "n9527",
"AuthSuccess": true
}
}
二. 认证流创建/失效回调
1. 回调触发时机
认证流创建回调场景： 企业认证时进入到【补充企业信息】，点击【下一步】时进行回调；
认证流失效回调场景：
（1）用户主动放弃企业认证；
（2）客户更换了超管openid，但是未更换企业openid时，先前的认证流失效的场景；
（3）客户找腾讯电子签运营人员在运营控制台上清理认证流程时，导致的认证流失效；
（4）客户主动调用接口DeleteOrganizationAuthorizations 批量清除未认证的企业认证流，导致的认证流失效；
2. 回调消息类型
OrganizationAuthorization
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 操作人的openid |
| AuthorizationId | String | 企业认证流的Id，为 32位字符串 |
| Operate | String | 操作类型：Create, Invalid |
| OperateTime | Integer | 失效的时间Unix时间戳 |
5. 示例
{
"MsgId": "yDRIGUUgygs8oey1UuO4zjEC8S6bOcm8",
"MsgType": "OrganizationAuthorization",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId": "n9527",
"AuthorizationId": "yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY",
"Operate": "Create",
"OperateTime": 1723541110
}
}
三. 授权书上传回调
1. 回调触发时机
企业通过上传授权书方式认证，在上传授权书之后进行回调
2. 回调消息类型
OrgAuthorizationFileSubmit
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| SubmittedTime | Integer | 授权书上传unix时间戳 |
5. 示例
{
"MsgId": "yDRIGUUgygs8oey1UuO4zjEC8S6bOcm8",
"MsgType": "OrgAuthorizationFileSubmit",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"SubmittedTime": 1726818178
}
}
四. 授权书审核结果回调
1. 回调触发时机
企业通过上传授权书方式认证，电子签平台审核人员对授权书进行审核后触发
2. 回调消息类型
OrgCertify
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| OperateSuccess | Boolean | 是否审核通过，true通过，false未通过 |
| CertifyReason | String | 如果审核不通过, 此字段表示不通过的原因 |
| OperateTime | String | 审核的时间 |
5. 示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "OrgCertify",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"OperateSuccess": true,
"CertifyReason": "",
"OperateTime": "2022-07-04 19:05:09"
}
}
五. 授权书失效回调
1. 回调触发时机
企业通过上传授权书方式认证，且因为如下场景： （1）在认证流程中，提交了授权书，待审核状态时，客户主动切换选择更换其他认证方式时，进行失效；
（2）客户更换了超管openid，但是未更换企业openid时，先前的认证流失效的场景；
（3）客户找腾讯电子签运营人员在运营控制台上清理认证流程时，导致的授权书失效；
（4）客户主动调用接口DeleteOrganizationAuthorizations 批量清除未认证的企业认证流，导致的授权书失效；
2. 回调消息类型
OrgAuthorizationFileInvalid
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 超管的openid |
| AuthorizationId | String | 企业认证流的Id，为 32位字符串 |
| OperateTime | Integer | 失效的时间Unix时间戳 |
5. 示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "OrgAuthorizationFileInvalid",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId": "n9527",
"AuthorizationId": "yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY",
"OperateTime": 1723541110
}
}
六. 企业开通电子签服务
1. 回调触发时机
企业完成认证激活，并开通电子签后发送次通知
2. 回调消息类型
OrgOpenTsignBiz
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 开通服务的第三方平台子客企业员工的唯一标识 |
| ProxyAppId | String | 子企业的ProxyAppId, 现在还没有地方使用此ProxyAppId, 可忽略 |
| OpenSuccess | Boolean | 是否开通, true表示开通, false表示未开通 |
| OrganizationName | String | 子企业的企业名字 |
| USCC | String | 子企业的企业社会统一信用代码 |
| LegalName | String | 子企业的法人的姓名 |
| LegalOpenId | String | 子企业的法人的OpenId |
| AdminName | String | 子企业超管的姓名 |
| AdminMobile | String | 子企业超管的手机号（打码） |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "OrgOpenTsignBiz",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian ",
"ProxyOperatorOpenId": " n9527",
"ProxyAppId": "yDRS4UUgygqdcj56UuO4zjExBQcOiB68",
"OpenSuccess": true,
"OrganizationName": "典子谦示例企业",
"USCC": "01440106MA59B1269X",
"LegalName": "典子谦",
"LegalOpenId": "legalPersonOpenId_obLsS5XxxxxxxxxxxLHN6gNuaKWQ_1700478725",
"AdminName": "张三",
"AdminMobile": "188****1234"
}
}
七. 员工加入企业通知
1. 回调触发时机
员工加入子企业的时候发送此通知
2. 回调消息类型
VerifyStaffInfo
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 加入企业的第三方平台子客企业员工的唯一标识 |
| EmployeeName | String | 员工姓名 |
| EmployeeMobile | String | 员工手机号（打码） |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "VerifyStaffInfo",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId": "n9527",
"EmployeeName": "张三",
"EmployeeMobile": "188****1234"
}
}
八. 员工加入企业失败通知
1. 回调触发时机
员工加入子企业失败时候发送此通知。 当前仅支持场景：该身份证号已完成实名认证并加入渠道企业
2. 回调消息类型
VerifyStaffFail
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 加入企业的第三方平台子客企业员工的唯一标识 |
| VerifiedOpenId | String | 已经实名的子客企业员工的唯一标识 |
| VerifiedName | String | 已经实名的子客企业员工的姓名（打码） |
| VerifiedMobile | String | 已经实名的子客企业员工的手机号（打码） |
| From | String | 失败场景：SyncProxyOrganizationOperators（同步企业员工），CreateChannelEmployee（员工实名），RemindEmployeeActive(提醒员工实名) |
| FailReason | String | 失败code：StaffAlreadyVerify |
| FailMessage | String | 失败原因 |
| OperateTime | Integer | 时间Unix时间戳 |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "VerifyStaffFail",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId": "n9527",
"VerifiedOpenId": "n1357",
"VerifiedName": "张*",
"VerifiedMobile": "188****8888",
"From": "SyncProxyOrganizationOperators",
"FailReason": "StaffAlreadyVerify",
"FailMessage": "该身份证号已完成实名认证并加入渠道企业",
"OperateTime": 1723541110
}
}
九. 经办人授权通知
1. 回调触发时机
企业在控制台，首次给经办人授予角色的时候(经办人需要实名)发送此通知
2. 回调消息类型
OperatorAuth
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 授权的第三方平台子客企业员工的唯一标识 |
| FirstAuth | Boolean | 是否首次授权, true是首次授权, false非首次授权 |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "VerifyStaffInfo",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId": "n9527",
"FirstAuth": true
}
}
十. 超管变更通知
1. 回调触发时机
企业在控制台或者小程序，完成变更超级管理员时发送此通知
2. 回调消息类型
SuperAdminChange
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ChangeToUserOpenId | String | 新的超管的企业的第三方平台子客企业员工的唯一标识 |
| ChangeToUserName | String | 新的超管的名字 |
| ChangeToUserMobile | String | 新的超管的手机号 |
| OldAdminOpenId | String | 老的超管的企业的第三方平台子客企业员工的唯一标识 |
| OldAdminName | String | 老的超管的名字 |
| OldAdminMobile | String | 老的超管的手机号 |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "SuperAdminChange",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian ",
"ChangeToUserOpenId": " n1357",
"ChangeToUserName": "张三",
"ChangeToUserMobile": "18888888888",
"OldAdminOpenId": "n9527",
"OldAdminName": "典子谦",
"OldAdminMobile": "13200000000"
}
}
十一. 员工变更角色通知
1. 回调触发时机
企业在控制台或者API接口，变更经办人角色时发送此通知
2. 回调消息类型
RolesChange
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 被变动角色的员工的第三方平台子客企业员工的唯一标识 |
| BeforeRoleNames | Array of String | 老的角色的名字列表 |
| AfterRoleNames | Array of String | 新的角色的名字列表 |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "RolesChange",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperatorOpenId": "n1357",
"BeforeRoleNames": [
"普通经办员",
"业务管理员"
],
"AfterRoleNames": [
"普通经办员"
]
}
}
十二. 企业基础信息修改通知
1. 回调触发时机
企业在控制台或者小程序修改企业基础信息后发送此通知
2. 回调消息类型
ModifyOrganizationBaseInfo
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| OrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| OrganizationName | String | 第三方平台子客企业原来的名字 |
| LegalName | String | 第三方平台子客企业原来的法人姓名 |
| Region | String | 第三方平台子客企业原来的企业原地区 |
| Address | String | 第三方平台子客企业原来的企业原详细地区 |
| Operator | String | 进行变动的企业员工的名字 |
| OperateTime | Integer | 进行变动的Unix时间戳 |
| OrganizationChangeBaseInfo | OrganizationChangeBaseInfoDetail | 新的企业信息 |
OrganizationChangeBaseInfoDetail结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| OrganizationNameNew | String | 第三方平台子客企业新的名字 |
| LegalNameNew | String | 第三方平台子客企业新的法人姓名 |
| RegionNew | String | 第三方平台子客企业原来的企业新的地区 |
| AddressNew | String | 第三方平台子客企业原来的企业新的详细地区 |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "ModifyOrganizationBaseInfo",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"OrganizationOpenId": "org_dianziqian",
"OrganizationName": "典子谦示例企业",
"LegalName": "典子谦",
"Region": "深圳市南山区",
"Address": "深圳市南山区1000号腾讯大厦",
"Operator": "典子谦",
"OperateTime": 1683545268,
"OrganizationChangeBaseInfo": {
"OrganizationNameNew": "张三示例企业",
"LegalNameNew": "张三",
"RegionNew": "深圳市宝安区",
"AddressNew": "深圳市宝安区1234号呱呱大厦"
}
}
}
十三. 企业注销通知
1. 回调触发时机
企业注销后产生此事件
2. 回调消息类型
CloseOrganization
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| OrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| OrganizationName | String | 第三方平台子客企业原的名字 |
| OperatorName | String | 进行注销的企业员工的名字 |
| CloseTime | Integer | 注销的时间的Unix时间戳 |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "CloseOrganization",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"OrganizationOpenId": "org_dianziqian",
"OrganizationName": "典子谦示例企业",
"OperatorName": "典子谦",
"CloseTime": 1683545268
}
}
十四. 企业收录申请审核结果回调
1. 回调触发时机
企业提交收录申请，电子签对企业信息进行审核后触发
2. 回调消息类型
OrgAuthAudit
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| OrgName | String | 企业的名字 |
| OpenId | String | 第三方平台子客企业员工的唯一标识 |
| AuditSuccess | Boolean | 是否审核通过, true审核通过, false审核不通过 |
| FailReason | String | 如果审核不通过, 此字段为不通过的原因 |
| OperateTime | Integer | 进行审核时间的Unix时间戳 |
| OperatorUserId | String | 操作人在电子签的userId |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "OrgAuthAudit",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"OrgName": "典子谦示例企业",
"OpenId": "n1357",
"AuditSuccess": false,
"FailReason": "名字存在敏感词语",
"OperateTime": 1689927892,
"OperatorUserId": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"
}
}
十五. 企业拓展服务操作回调
1. 回调触发时机
开通/关闭某项企业拓展服务
2. 回调消息类型
OperateExtendedService
3. 其他说明
ServiceType 枚举值
| 拓展服务 | 枚举值 |
|---|---|
| 企业自动签署 | AUTO_SIGN |
| 企业与港澳台居民签署合同 | OVERSEA_SIGN |
| 拓宽签署方年龄限制 | AGE_LIMIT_EXPANSION |
| 个人签署方仅校验手机号 | MOBILE_CHECK_APPROVER |
| 隐藏合同经办人姓名 | HIDE_OPERATOR_DISPLAY |
| 骑缝章 | PAGING_SEAL |
| 下载企业合同/文件授权 | AUTH_PROXY_ORGANIZATION_DOWNLOAD_FLOW |
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 第三方平台子客企业员工的唯一标识 |
| ServiceType | String | 拓展服务类型，枚举值见 3.其他说明 |
| ServiceStatus | String | 拓展服务状态 DISABLE-服务关闭 ENABLE-服务开通 |
| OperateTime | Integer | 操作时间戳,格式为Unix标准时间戳（秒） |
5. 示例
{
"MsgId":"yDSLfUUckptgrpzaUuePjuk55nWvPBu0",
"MsgType":"OperateExtendedService",
"MsgVersion":"ThirdPartyApp",
"MsgData":{
"ApplicationId":"51edb27f2ee412f5ff673ac0185ebb0a",
"ProxyOrganizationOpenId":"org-dianziqian",
"ProxyOperatorOpenId":"org-dianziqian-admin",
"ServiceType":"AUTO_SIGN",
"ServiceStatus":"ENABLE",
"OperateTime":1701074374
}
}
十六. 法人加入变更通知
1. 回调触发时机
企业在控制台或者小程序，法人首次完成加入变更时发送此通知
2. 回调消息类型
LegalPersonChangeOpenId
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| AppId | String | 第三方应用的应用编号 |
| OrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| LegalPersonName | String | 法人姓名 |
| OldOpenId | String | 法人老的第三方平台子客企业员工的唯一标识 |
| NewOpenId | String | 法人新的第三方平台子客企业员工的唯一标识 |
5.示例
{
"MsgId": "yDRBJUUgygqwl721UuO4zjECcJHV2RAi",
"MsgType": "LegalPersonChangeOpenId",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"AppId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
"OrganizationOpenId": "org_dianziqian",
"LegalPersonName": "典子谦",
"OldOpenId": "legalPersonOpenId_obLsS5XxxxxxxxxxxLHN6gNuaKWQ_1700478725",
"NewOpenId": "dianziqian"
}
}
