合同相关回调

一. 合同状态变动通知

1. 回调触发时机

在合同的发起，个人签署，企业签署等各个状态变化时

2. 回调消息类型

FlowStatusChange

3. 其他说明

注意，回调 V1、V2 版本此类型的回调相差较大

回调 V2 版本，是标准结构，解密后为

{
  "MsgId": "xxx",
  "MsgType": "FlowStatusChange",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "xxxx",
    ...
  }
}

回调 V1 版本，此类型的回调消息体是此 MsgData 结构，解密后为

{
  "FlowId": "xxxx",
  ...
}

会出现回调的合同状态

合同状态	对应 FlowCallbackStatus	对应 FlowCallbackShowStatus	备注
合同创建	1	INIT	-
合同签署中	2	PART	-
合同拒签	3	REJECT	合同终态，某一个签署人拒签此合同
合同签署完成	4	ALL	合同终态
合同流签(合同过期)	5	DEADLINE	合同终态，到达合同的过期时时还没有签署完成
合同撤回	6	CANCEL	合同终态，发起方取消此合同
合同待填写	8	INIT	-
合同填写中	9	PART	-
已解除	21	RELIEVED	合同终态
合同已失效	16	INVALID	合同终态 ，签署期间有签署人改名等原因导致

签署人状态

签署人状态	对应 ApproveCallbackStatus	对应 ApproveCallbackShowStatus
只能查看合同	1：合同是顺序签署，但还没轮到他	PENDING
待签署	2：待签署	PENDING
只能查看合同	7：合同还没有发起（特殊情形会出现的状态）	PENDING
已签署	3	ACCEPT
拒绝	4	REJECT
过期没人处理	5	DEADLINE
流程已撤回	6	CANCEL
合同待填写	8	FILLPENDING
流程已终止	9	STOP
填写完成	10	FILLACCEPT
已解除	15	RELIEVED
已转他人处理	19	FORWARD

合同组状态

合同组状态	对应 FlowGroupStatus
待我处理	TOSIGN
待他人处理	WAITSIGN
部分合同已失效	PART
已完成	ALL
已失效	INVALID
合同处理中	PROCESSING
未定义	UNDEFINED

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	触发回调的合同流程 ID, 为 32 位字符串
DocumentId	String	触发回调的合同文档 ID，为 32 位字符串
CallbackType	String	回调的类型： sign：签署回调 review：审核回调 fill：填写回调
FlowName	String	触发回调的合同流程的名称
FlowDescription	String	触发回调的合同流程的描述
FlowType	String	触发回调的合同流程的类别分类
FlowCallbackStatus	Integer	合同状态代码(用数字表示), 具体含义可以参考上述其他说明中的 会出现回调的合同状态
FlowCallbackShowStatus	String	合同状态描述(用英文表示), 具体含义可以参考上述其他说明中的 会出现回调的合同状态
Unordered	bool	流程类型顺序： true：为无序 false：为有序
CreateOn	Integer	合同流程的创建时间戳, 格式为 Unix 标准时间戳（秒）
UpdatedOn	Integer	合同流程的更新时间戳, 格式为 Unix 标准时间戳（秒）
DeadLine	Integer	签署流程的签署截止时间, 格式为 Unix 标准时间戳（秒）
UserId	String	触发回调的合同创建用户 ID, 为 32 位字符串
OrganizationId	String	触发回调的合同创建企业 ID, 为 32 位字符串
RecipientId	String	签署等环节触发本次回调的参与角色 ID, 为 32 位字符串
Operate	String	具体动作： start：发起 sign：签署 reject：拒签 cancel：取消 finish：结束 deadline：过期 invalid：失效 fill：填写
UserData	String	用 PDF 文件创建签署流程和用模板创建签署流程创建签署流程时候传递的 UserData 参数
Approvers	Array of Approver	合同(流程)签署人信息列表, 结构体的定义可以参考下面的Approver
CcInfos	Array of CcInfo	合同(流程)关注方信息列表, 结构体定义可以查看开发者中的CcInfo
OccurTime	Integer	此回调触发的时间,格式为 Unix 标准时间戳（秒）
FlowGroupMessage	FlowGroupMessageDetail	如果合同归属合同组, 此结构体为合同组的信息, 结构体的定义可以参考下面的FlowGroupMessageDetail
ReleaseFlowId	String	合同解除后（FlowCallbackShowStatus=RELIEVED）返回此字段，表示合同对应的解除协议编号

Approver 结构体定义

参数名称	参数类型	参数描述
UserId	String	签署人的用户 ID, 为 32 位字符串
RecipientId	String	对应签署人的参与角色 ID
ApproverType	Integer	参与者类型, 0：企业 1：个人 3：企业授权签
OrganizationName	String	参与者企业名
Required	Bool	是否需要签名
ApproverName	String	对应签署人的名字
ApproverMobile	String	对应签署人的手机号
ApproverIdCardType	String	签署人证件类型： ID_CARD：中国大陆居民身份证 HONGKONG_AND_MACAO：中国港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN：中国港澳台居民居住证（格式同居民身份证）
ApproverIdCardNumber	String	签署人证件号码
ApproveCallbackStatus	Integer	对应签署人的状态, 具体含义可以参考上述其他说明中的 签署人状态
ApproveMessage	String	对应签署人状态的简单描述, 如: 已签署或者拒签的原因等
ApproveTime	Integer	对应签署人签署此合同的时间，格式为 Unix 标准时间戳（秒）
VerifyChannel	String	【已废弃】签署意愿方式，WEIXINAPP：人脸识别，当前回调中已不再返回此字段
CaSign	String	对应签署人签署此合同的证书信息, 此功能为白名单功能, 使用前请联系对接的客户经理沟通。
ApproverDeadline	Integer	对应签署人的签署截止时间，格式为 Unix 标准时间戳（秒）
ApproverSignType	String	签署人完成签署时使用的意愿认证方式编码，仅在签署人状态为已签署（ApproveCallbackStatus=3）时返回具体编码，其他状态返回空字符串。编码含义见下方"意愿认证方式编码说明"

ApproverSignType 意愿认证方式编码说明

ApproverSignType	签署认证方式
101	人脸认证
102	人脸视频认证
201	签署密码
301	运营商三要素认证
401	UKey 认证
501	设备指纹认证
502	设备面容认证
900	授权签署（包含企业授权签、个人授权签）

FlowGroupMessageDetail 结构体定义

参数名称	参数类型	参数描述
FlowGroupId	String	合同组的 ID，为 32 位字符串
FlowGroupName	String	合同组的名称
FlowGroupStatus	String	合同组状态，具体含义可以参考上述其他说明中的 合同组状态
UserFlowType	UserFlowType	用户合同组的自定义分类。具体含义可以参考上述其他说明中的 自定义分类UserFlowType

5. 示例

{
  "MsgId": "yDCVjUUckpw709mwUE2d86xxe48eZehT",
  "MsgType": "FlowStatusChange",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "Approvers": [
      {
        "ApproveCallbackShowStatus": "ACCEPT",
        "ApproveCallbackStatus": 3,
        "ApproveMessage": "",
        "ApproveTime": 1711625666,
        "ApproverDeadline": 1714319999,
        "ApproverIdCardNumber": "17072411000204263X",
        "ApproverIdCardType": "ID_CARD",
        "ApproverIdCardTypeDesc": "居民身份证",
        "ApproverMobile": "18500000000",
        "ApproverName": "刘波",
        "ApproverSource": "",
        "ApproverType": 0,
        "CaSign": "",
        "CustomApproverTag": "",
        "CustomUserId": "",
        "OrganizationName": "呱呱叫测试企业",
        "RecipientId": "yDCVjUUckpw7hdznUyigyC6El96dC2Yo",
        "Required": true,
        "UserId": "yDw6yUUgyg3c753gUx4GQptwsiPEXZNn"
      },
      {
        "ApproveCallbackShowStatus": "ACCEPT",
        "ApproveCallbackStatus": 3,
        "ApproveMessage": "",
        "ApproveTime": 1711625721,
        "ApproverDeadline": 1714319999,
        "ApproverIdCardNumber": "37072410000724000X",
        "ApproverIdCardType": "ID_CARD",
        "ApproverIdCardTypeDesc": "居民身份证",
        "ApproverMobile": "17300000000",
        "ApproverName": "猪猪侠",
        "ApproverSource": "",
        "ApproverType": 1,
        "CaSign": "",
        "CustomApproverTag": "",
        "CustomUserId": "",
        "OrganizationName": "",
        "RecipientId": "yDCVjUUckpw7hdzgUyigyC6u6gEPlMfy",
        "Required": true,
        "UserId": "yDSLgUUckpt0wwgwUEdI8nkSP9RzXc6y"
      },
      {
        "ApproveCallbackShowStatus": "PENDING",
        "ApproveCallbackStatus": 2,
        "ApproveMessage": "",
        "ApproveTime": 0,
        "ApproverDeadline": 1714319999,
        "ApproverIdCardNumber": "390724100002042638",
        "ApproverIdCardType": "ID_CARD",
        "ApproverIdCardTypeDesc": "居民身份证",
        "ApproverMobile": "18500000000",
        "ApproverName": "段誉",
        "ApproverSource": "",
        "ApproverType": 0,
        "CaSign": "",
        "CustomApproverTag": "",
        "CustomUserId": "",
        "OrganizationName": "段誉测试企业",
        "RecipientId": "yDCVjUUckpw7hdzdUyigyC6uW1KpB4CA",
        "Required": true,
        "UserId": "yDw6yUUgyg3caowzUx4GQptRKfMnJqX8"
      }
    ],
    "CallbackType": "sign",
    "CallbackUrl": "http://www.qq.com:8000/callback",
    "CcInfos": [],
    "CreateOn": 1711625257,
    "DeadLine": 1714319999,
    "DocumentId": "yDCVjUUckpw7hdm9UyigyC6zyvnLYgMv",
    "FlowCallbackShowStatus": "PART",
    "FlowCallbackStatus": 2,
    "FlowDescription": "20240328西红柿购买",
    "FlowId": "yDCVjUUckpw7hdmeUyigyC6ybpKSjQee",
    "FlowName": "蔬菜购买合同",
    "FlowType": "购买合同",
    "OccurTime": 1711625721,
    "FlowGroupMessage": {
      "FlowGroupId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
      "FlowGroupName": "合作组",
      "FlowGroupStatus": "WAITSIGN"
    },
    "Operate": "sign",
    "OrganizationId": "yDw6yUUgyg3c47e6Uyh4KQ5SPpKT0ch9",
    "RecipientId": "yDCVjUUckpw7hdzgUyigyC6u6gEPlMfy",
    "Unordered": true,
    "UpdatedOn": 1711625721,
    "UserData": "VXNlckRhdGFVc2VyRGF0YVVzZXJEYXRhVXNlckRhdGE=",
    "UserId": "yDw6yUUgyg3c753gUx4GQptwsiPEXZNn"
  }
}

二. 合同发起扣费通知（已废弃）

已废弃，请使用 费用相关回调。

1. 回调触发时机

合同发起成功并扣费成功后触发

2. 回调消息类型

FlowCost

3. 其他说明

无

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	转交的合同流程 ID，为 32 位字符串
Cost	Integer	此合同流程消耗的合同份额, 如果为负值则为份额退还
CostChannel	String	此合同流程消耗对应计费版本, 现在的计费版本有企业版,在线签约,战略签约,群闪签,单方签章等, 一般为企业版
OrganizationId	String	企业 ID，为 32 位字符串
IsResell	Boolean	此合同流程消耗是否是分销场景下的消费

5. 示例

{
  "MsgId": "yDRspUUgygxxxxxxxxxx9XTPkBnnXZyvdT",
  "MsgType": "FlowCost",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "yDRspUUgxxxxxxxxxxxsXSTG8jO",
    "Cost": 1,
    "CostChannel": "企业版",
    "OrganizationId": "yDxbWUyKQxxxxxxxxxxEB8mxCcDjAyF",
    "IsResell": false
  }
}

三. 合同转交通知

1. 回调触发时机

合同经办人将合同转交给同企业其他经办人时触发，包括主动转交和离职转交

2. 回调消息类型

ForwardFLow

3. 其他说明

无

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	转交的合同流程 ID, 为 32 位字符串，当单份转交时，填充该字段
FlowIds	Array of String	转交的合同流程 ID 数组, 当离职批量转交时，填充该字段
ForwardedUserId	String	接收此合同的自建企业员工的唯一标识, 为转发动作的目的方
OperatorUserId	String	发起转交操作的用户 ID, 为 32 位字符串
OrganizationId	String	发起转交操作的机构 ID, 为 32 位字符串

5. 示例

// 普通单份转交
{
  "MsgId": "yDRIGUUgygs8aey1UuO4zjEuM18ffkaK",
  "MsgType": "ForwardFLow",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "ForwardedUserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
    "OperatorUserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF"
  }
}

// 离职转交
{
  "MsgId": "yDRIGUUgygs8aey1UuO4zjEuM18ffkaK",
  "MsgType": "ForwardFLow",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "",
    "FlowIds": [
      "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
      "yDwFmUUckpstqfvzUE1h3jo1f3cqjkss"
    ]
    "ForwardedUserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
    "OperatorUserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF"
  }
}

四. 发起合同审核通知

1. 回调触发时机

• 在嵌入式页面场景下,若调用 创建发起流程web页面接口时设置了NeedCreateReview 参数进行发起操作的审批控制，则在审批发起、通过或者拒绝时会进行回调。
• 通过api调用 模板发起合同-创建签署流程， 用PDF文件创建签署流程，创建发起流程web页面接口时设置了WorkFlow=true，开启电子签发起审批流对发起操作进行审批控制，则在审批通过或者拒绝时会进行回调
• 通过api调用 通过多模板创建合同组签署流程，通过多文件创建合同组签署流程，获取发起合同组嵌入链接接口时设置了FlowGroupOptions.FlowGroupNeedWorkflow=true，开启电子签发起审批流对合同组发起操作进行审批控制，则在审批通过或者拒绝时会进行回调

2. 回调消息类型

CreateFlowReview

3. 其他说明

仅当开启电子签审批流（单份合同指定Workflow=true,合同组指定FlowGroupOptions.FlowGroupNeedWorkflow=true）时，回调中才会返回：ReviewInstanceId，ReviewUserId，ReviewTime，ReviewMessage

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	审核的合同流程ID，为32位字符串
DocumentId	String	审核的合同流程的PDF文档的编号ID，为32位字符串
FlowName	String	审核的合同流程的名称
Operate	String	审核动作, 具体的含义参考下面的Operate说明
ReviewInstanceId	String	电子签审批流id
ReviewUserId	String	审批人
ReviewTime	int	审批时间
ReviewMessage	String	审核意见

Operate 含义

• CreateFlowReviewStart：提交发起审核
• CreateFlowReviewPass：发起审核通过
• CreateFlowReviewReject：发起审核拒绝

5. 示例

示例1：指定NeedCreateReview=true的情况

{
  "MsgId": "yDSLfUUckptgxc0wUuePjuk99Pm6q9mj",
  "MsgType": "CreateFlowReview",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "DocumentId": "yDALfUUckptgirpiUu55s2CCd7Nmg9a2",
    "FlowId": "yDSLfUUckptgir50Uu16s3CCbicAoz4j",
    "FlowName": "对账申请单",
    "Operate": "CreateFlowReviewStart"
  }
}

示例2：单份合同指定Workflow=true,合同组指定FlowGroupOptions.FlowGroupNeedWorkflow=true的情况

{
  "MsgId": "yD3a8UUckpm3yf0wUxGYwQ6WdwbmFBgP",
  "MsgType": "CreateFlowReview",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "DocumentId": "",
    "FlowId": "yD3a8UUckpm3s6jjU1Uyn3PnOStiH8zK",
    "Operate": "CreateFlowReviewPass",
    "ReviewInstanceId": "2029468168996519936",
    "ReviewMessage": "审核通过",
    "ReviewTime": 1772697902,
    "ReviewUserId": "yDRt2UUgygqxuvl2UuO4zjECCccJEr6z"
  }
}

五. 或签候选人领取合同通知

1. 回调触发时机

在或签合同场景下,若调用了 补充签署流程签署人信息 接口补充了签署方候选人后，在候选人领取合同后会进行回调。

2. 回调消息类型

ReceiveFlow

3. 其他说明

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	合同流程 ID，为 32 位字符串
CallbackType	String	回调的类型： OrSign：领取或签合同回调
RecipientId	String	对应签署人的参与角色 ID, 为 32 位字符串
CustomUserId	String	领取人的企业微信 UserId
Name	String	领取人的姓名
Mobile	String	领取人的手机号码
IdCardType	String	领取人的证件类型
IdCardNumber	String	领取人的证件号码
ApproverTag	String	参与或签的人员标识，对应文件发起合同、模板发起合同中对应签署人指定的入参 CustomApproverTag

5. 示例

{
  "MsgId": "yDSLaUUc**********BKw54S3XA",
  "MsgType": "ReceiveFlow",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "yDSLaUUck**********bW1srERk275",
    "CallbackType": "OrSign",
    "RecipientId": "yDRIZUUg**********q35keHT6izZ",
    "CustomUserId": "amber",
    "Name": "张三",
    "Mobile": "1591***5678",
    "IdCardType": "ID_CARD",
    "IdCardNumber": "4****************1",
    "ApproverTag": "430000********3237498"
  }
}

六. 动态签署人领取合同通知

1. 回调触发时机

在合同含有动态签署人时，即通过接口 文件发起合同、 模板发起合同 发起合同指定了动态签署人 签署人设置 后，则可以通过接口 补充签署流程签署人信息 指定具体签署人或者 获取跳转至腾讯电子签小程序的签署链接生成动态签署人链接前往页面进行领取，领取完成后进行回调。

2. 回调消息类型

ReceiveFlow

3. 其他说明

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	合同流程 ID，为 32 位字符串
CallbackType	String	回调的类型： Dynamic：动态签署人领取合同回调
ApproverType	Integer	参与者类型, 0：企业 1：个人 3：企业授权签 7：个人授权签
RecipientId	String	对应签署人的参与角色 ID, 为 32 位字符串
OrganizationName	String	领取人的企业名称，签署人类型为企业时有值
Name	String	领取人的姓名
Mobile	String	领取人的手机号码
ReceiveTime	Integer	领取时间

5. 示例

{
  "MsgId": "yDSLFUUck**************k8DCus0DoH",
  "MsgType": "ReceiveFlow",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "yDSLYUUck**************egERaDZMWuO",
    "CallbackType": "Dynamic",
    "ApproverType": 0,
    "RecipientId": "yDSLYUUc**************yPeB0GwG5",
    "OrganizationName": "**科技有限公司",
    "Name": "张三",
    "Mobile": "1591***5678",
    "ReceiveTime": 1701160764
  }
}

七. 签署人签署截止时间过期通知

1. 回调触发时机

在通过接口 文件发起合同、 模板发起合同发起合同时指定了签署人的签署截止时间，若合同状态正常，且签署人在签署截止时间前未完成签署操作，会触发此回调。 若还需要签署人继续签署，可通过接口 管理签署流程截止时间延长签署人截止时间以便继续签署。

注：此消息会在签署人签署截止时间前 3 小时触发。

2. 回调消息类型

ApproverDeadlineExpired

3. 其他说明

无

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	合同流程 ID，为 32 位字符串
FlowName	String	合同名称
FlowStatus	string	合同状态 见上方合同状态变动通知中 FlowCallbackShowStatus 定义
FlowDeadline	int64	合同的签署截止时间
FlowUnordered	Boolean	合同是否有序
OrganizationId	String	发起方企业 ID
ApproverInfo	ApproverInfo	过期签署人的信息

ApproverInfo 结构体定义

参数名称	参数类型	参数描述
SignOrder	int64	当前签署人的顺序，如果是有序合同的话需要关注，有序从 0 开始
RecipientId	String	签署人编号
ApproverType	int64	参与者类型, 0：企业 1：个人 3：企业授权签 7：个人授权签
ApproverName	int64	签署人姓名
ApproverMobile	Boolean	签署人手机号
OrganizationName	String	签署人企业名称
ApproverDeadline	int64	对应签署人的签署截止时间，格式为 Unix 标准时间戳（秒）

5. 示例

{
  "MsgId": "yDCN4UUckpvj9737UuGjzgvRek5gfb8r",
  "MsgType": "ApproverDeadlineExpired",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "yDCNGUUckpvjp6xfUuj8rPu4Bnbumbbb",
    "FlowName": "示例合同",
    "FlowStatus": "INIT",
    "FlowDeadline": 1705998880,
    "FlowUnordered": false,
    "OrganizationId": "yDCN4UUckpvj6688UuGjzgvRek5gfb8r",
    "ApproverInfo": {
      "SignOrder": 2,
      "RecipientId": "yDCAGUUckpvjp6xzUuj8rPuxWhNlj5J7",
      "ApproverType": 0,
      "ApproverName": "典子谦",
      "ApproverMobile": "18700000000",
      "ApproverStatus": "PENDING",
      "OrganizationName": "电子签示例企业",
      "ApproverDeadline": 1705998720
    }
  }
}

八. 批量撤销结果回调

1. 回调触发时机

若在操作人通过接口 获取批量撤销合同流程的腾讯电子签小程序链接获取链接后进行了撤销操作，则会触发此回调。

2. 回调消息类型

CancelFlows

3. 其他说明

无

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
OrganizationId	String	发起方企业 ID
TaskId	String	批量撤销任务编号，为 32 位字符串
SuccessFlowIds	Array of String	撤销成功的合同流程 ID 列表
FailureFlows	Array of FailureFlow	撤销失败的合同流程列表

FailureFlow 结构体定义

参数名称	参数类型	参数描述
FlowId	String	签署流程编号，为 32 位字符串
Reason	String	撤销失败的原因

5. 示例

{
  "MsgId": "yDCVbUUckpwth9dqUxFDY7lEYHF5KVKv",
  "MsgType": "CancelFlows",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDCN4UUckpvj6688UuGjzgvRek5gfb6r",
    "TaskId": "yDCVWUUckpwkthb5UxWziEO8VvOWlC3m",
    "SuccessFlowIds": ["yDCVbUUckpwtpsmiU4zgYeEWdIlc78BS"],
    "FailureFlows": [
      {
        "FlowId": "yDCVOUUckpwqqsc8UVBFcywZjuX5PhNZ",
        "Reason": "合同当前状态不支持撤销"
      }
    ]
  }
}

九. 合同文档合成完成回调

1. 回调触发时机

当发起的合同中存在高耗时合成任务时(如发起方控件填写，动态表格合成)，文档合成完成后进行回调。

目前覆盖的场景:

1.通过模板发起合同-创建电子文档 时,若模板配置了发起方填写控件，则在文档合成完成后会进行回调。

2.通过模板发起合同-创建电子文档 进行预览操作时（外层参数 NeedPreview 设置为 true）,若使用的模板中存在动态表格控件时，完整预览链接可通过此回调获取， 可通过回调里面的 DocumentId 进行映射。

2. 回调消息类型

DocumentFill

3. 其他说明

无

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
OrganizationId	String	企业 ID，为 32 位字符串
ApplicationId	String	第三方应用的应用编号，为 32 位字符串, 一般为空
FlowId	String	合同 ID，为 32 位字符串。注意：如果是预览模式产生的回调，此FlowId为临时Flowld，无法用于发起和拉取信息
DocumentId	String	文档 ID，为 32 位字符串，跟 通过模板发起合同-创建电子文档 返回的文档 Id 一致
DocumentFileStatus	String	处理状态，一般是成功-SUCCESS
ResourceUrl	String	PDF 文档资源链接，如果在创建文档时设置PreviewType=0(文件流)，则返回PDF文件的下载链接，如果设置PreviewType=1(H5链接)，则返回H5预览链接
UserData	String	调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。 在文档合成完成回调信息场景中，该字段的信息将原封不动地透传给贵方

5. 示例

{
  "MsgId": "yDwi8UUxxxxxxxxxxxxxxxAjqoq3Yp",
  "MsgType": "DocumentFill",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF",
    "ApplicationId": "",
    "FlowId": "yDR1AUUgygj******uO4zjE8gTG7xvgH",
    "DocumentId": "yDtCWUUlf******xMsF0qvDcWLOhnekG",
    "DocumentFileStatus": "SUCCESS",
    "ResourceUrl": "https://xxx.com/files/DOCUMENT/xxx"
  }
}

十. 合同组状态变动回调

1. 回调触发时机

当合同组状态（参考上述其他说明中的 合同组状态 ）处于终态：部分合同已失效，已完成，已失效 时 ，则会触发此回调。

2. 回调消息类型

FlowGroupStatusChange

3. 其他说明

每个合同组仅会回调一次

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
OrganizationId	String	发起方企业 ID
OperatorUserId	String	发起方用户 ID, 为 32 位字符串
FlowGroupId	String	合同组的 ID，为 32 位字符串
FlowGroupName	String	合同组的名称
FlowGroupStatus	String	合同组状态，具体含义可以参考上述其他说明中的 合同组状态

5. 示例

{
  "MsgId": "yDCVbUUckpwth9dqUxFDY7lEYHF5KVKv",
  "MsgType": "FlowGroupStatusChange",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDCN4UUckpvj6688UuGjzgvRek5gfb6r",
    "OperatorUserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy",
    "FlowGroupId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
    "FlowGroupName": "合作组",
    "FlowGroupStatus": "ALL"
  }
}

十. 关注方合同已读回调通知

1. 回调触发时机

当关注方查看合同时，则会触发此回调。

2. 回调消息类型

ReviewerFlowRead

3. 其他说明

每个关注方只会回调一次

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
FlowId	String	合同 ID，为 32 位字符串
FlowName	String	合同名称
OrganizationName	String	关注方的企业名称，个人关注方为空
Name	String	关注方的姓名，若发起合同时未填写关注方姓名则为空
Mobile	String	关注方的手机号
Read	bool	是否已查看，true：已查看
ReadOn	int	查看时间，10 位时间戳

5. 示例

{
  "MsgId": "yDCVbUUckpwth9dqUxFDY7lEYHF5KVKv",
  "MsgType": "ReviewerFlowRead",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "FlowId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
    "FlowName": "关注方查看测试",
    "OrganizationName": "",
    "Name": "典子谦",
    "Mobile": "187****0000",
    "Read": true,
    "ReadOn": 1751352075
  }
}

十一. 全量撤销结果回调

1. 回调触发时机

若操作人通过接口全量撤销企业合同进行了全量撤销操作，则会触发此回调。

2. 回调消息类型

CancelOrganizationFlows

3. 其他说明

无

4. 回调结构体

MsgData 结构体定义

参数名称	参数类型	参数描述
OrganizationId	String	发起方企业 ID
TaskId	String	全量撤销任务编号，为 32 位字符串
SuccessFlowIds	Array of String	撤销成功的合同流程 ID 列表
FailureFlows	Array of FailureFlow	撤销失败的合同流程列表
RemainingSigningCount	Integer	剩余签署中合同数量

FailureFlow 结构体定义

参数名称	参数类型	参数描述
FlowId	String	签署流程编号，为 32 位字符串
Reason	String	撤销失败的原因

5. 示例

{
  "MsgId": "yDCVbUUckpwth9dqUxFDY7lEYHF5KVKv",
  "MsgType": "CancelOrganizationFlows",
  "MsgVersion": "CustomApp",
  "MsgData": {
    "OrganizationId": "yDCN4UUckpvj6688UuGjzgvRek5gfb6r",
    "TaskId": "yDCVWUUckpwkthb5UxWziEO8VvOWlC3m",
    "SuccessFlowIds": ["yDCVbUUckpwtpsmiU4zgYeEWdIlc78BS"],
    "FailureFlows": [
      {
        "FlowId": "yDCVOUUckpwqqsc8UVBFcywZjuX5PhNZ",
        "Reason": "合同当前状态不支持撤销"
      }
    ],
    "RemainingSigningCount": 0
  }
}