跳到主要内容

合同发起及签署相关回调

合同状态通知 - FlowStatusChange

触发时机:在合同的发起,个人签署,企业签署等各个状态变化时;

注意: 合同相关回调地址的优先级: flowInfo.callbackurl > 应用号里面配置的回调地址

合同状态包括:

合同状态对应FlowStatus
合同创建INIT
合同签署中PART
合同签署完成ALL
合同拒签REJECT
合同撤回CANCEL
合同即将过期WILLEXPIRE
合同流签(合同过期)DEADLINE
解除协议(已解除)RELIEVED
合同异常EXCEPTION

签署人状态包括:

签署人状态对应ApproveStatus
待签署PENDING
已签署ACCEPT
拒绝REJECT
过期没人处理DEADLINE
流程已撤回CANCEL
流程已终止STOP
待领取WAITPICKUP
待填写FILLPENDING
填写完成FILLACCEPT
已转他人处理FORWARD
解除协议(已解除)RELIEVED
拒绝填写FILLREJECT
异常EXCEPTION

{

"MsgId":"12345",

"MsgType":"FlowStatusChange",

"MsgVersion": "ThirdPartyApp",

"MsgData":{

"ApplicationId":"123124123123123123",//APPID

"ProxyOrganizationOpenId":"openorg1234",//子客企业ID

"CustomerData":"data",//业务信息

"FlowId":"111111295e544f68973bafdfd317633f", //合同Id

"FlowName":"合同名称", //合同名称

"FlowType":"劳务合同", //合同类型

"FlowStatus":"REJECT", // 合同状态,见合同状态列表

"FlowMessage":"用户A拒绝",//

"CreateOn":1563968167,//发起时间

"Deadline":1563968167,//截止时间

"CcInfo": [], // 抄送人

"FlowApproverInfo":[ //参与人信息

{

"ProxyOperatorOpenId":"operator",//子客经办人Id

"PhoneNumber":"13112345678",//手机号码

"ProxyOrganizationName":"企业A",//子客企业名称

"ProxyOrganizationOpenId": "zk_open_org", // 子客企业Openid

"SignOrder":1, //签署顺序

"recipientId": "ids", // 电子签定义的参与人ID

"ApproveName":"name1",//参与者姓名

"ApproveStatus":"ACCEPT",// 签署人状态,见签署人状态列表

"ApproveMessage":"已签署", //签署相关信息

"ApproveTime":1563968167, //签署时间戳

"CaSign": "", // 特定签署场景返回的证书信息

},

{

"ProxyOperatorOpenId":"",//子客经办人Id, 个人用户为空

"PhoneNumber":"13112345678", // 签署人手机号

"ProxyOrganizationName":"", //子客企业名,个人用户为空

"ProxyOrganizationOpenId": "", // 子客企业Openid,个人用户为空

"SignOrder":2, //签署顺序

"recipientId": "ids", // 电子签定义的参与人ID

"ApproveName":"name2", //签署人姓名

"ApproveStatus":"PENDING", //签署状态,见签署人状态列表

"ApproveMessage":"待签署", //签署相关信息

"ApproveTime":1563968167, //签署时间戳

"CaSign": "", // 特定签署场景返回的证书信息

}

],

"FlowGroupMessage": { // 合同组信息

"FlowGroupId": "111111295e544f68973xxxx317633f", // 合同组id

"FlowGroupName": "合同名称", // 合同组名称

"FlowsInfo": [ // 子合同信息,数组

{

"FlowId": "111111295e544f68973qqqq317633f" // 子合同Id

}

],

"CreateOn": 1563968167329 // 合同组创建时间

},

"FlowSignSeal": { // 签署印章列表结构

"CurrentIndex": 0, // 签署顺序

"SignSealInfo": { // 签署印章结构

"ApproverName": "name1", // 签署人姓名

"ApproverType": 1, // 签署人类型

"SealComponent": { // 印章控件结构

"ComponentInfos": [ // 控件信息结构
{
"ComponentIds": [ // 控件id列表

"ComponentId_19" // 控件id
],
"DocumentId": "doc id" // 文档id
}
],
"SealContent": "base64 of pic", // 具体印章图文,base64
"SealId": "seal id" // 印章id
}
},
"TotalCount": 2 // 签署印章总数
},

"OccurTime":1563968167 //回调发起时间

}

}

经办人转交签署任务 - ForwardFLow

触发场景:合同经办人将合同转交给同企业其他经办人时触发;


{

"MsgId":"yDRIGUUgygs8aey1UuO4zjEuM18ffkaK",

"MsgType":"ForwardFLow",

"MsgVersion": "ThirdPartyApp",

"MsgData":{

"ApplicationId":"abcd", //应用Id

"ProxyOrganizationOpenId":"open_org", //子客企业OpenId

"ProxyOperatorOpenId":"employee_open_id", //子客经办人OpenId

"FlowId":"abcccccccccccccc", //合同Id

"ForwardedOpenId":"test3" //转交给对应经办人的OpenId

}

}

合同发起扣费通知 - FLowCost

触发场景:合同发起成功时触发;


{

"MsgId":"yDRspUUgyg17u3j8Ux9XTPkBnnXZyvdT",

"MsgType":"FlowCost",

"MsgVersion": "ThirdPartyApp",

"MsgData":{

"ApplicationId": "应用Id", // 应用Id

"ProxyOrganizationOpenId": "子客企业Id", // 子客企业Id

"ProxyOperatorOpenId": "子客企业经办人Id", // 子客企业经办人Id

"Cost":1, //消耗份数,

"CostChannel":"企业版", // 对应计费版本

"FlowId":"yDRspUUgyg17u3jwUx9XTPkysXSTG8jO", // 合同Id

"IsResell":false //是否分销,一般为false

}

}

合同撤销扣费返还通知 - FLowCost

触发场景:合同撤销时触发;


{

"MsgId":"yDRspUUgyg17u3j8Ux9XTPkBnnXZyvdT",

"MsgType":"FlowCost",

"MsgVersion": "ThirdPartyApp",

"MsgData":{

"ApplicationId": "应用Id", // 应用Id

"ProxyOrganizationOpenId": "子客企业Id", // 子客企业Id

"Cost":-1, // 返还份数,是负数

"CostChannel":"企业版", // 计费版本

"FlowId":"yDRspUUgyg17u3jwUx9XTPkysXSTG8jO", // 合同Id

"IsResell":false //是否分销,一般为false

}

}

合同审核通知 - CreateFlowReview

触发场景:对需要审核的合同进行审核操作;

其中Operate包括

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

{

"MsgId":"yDwFhUUckps95bm2UElNO1L1rQ8x9p0Q",

"MsgType":"CreateFlowReview",

"MsgVersion": "ThirdPartyApp",

"MsgData":{

"ApplicationId": "应用Id", // 应用Id

"ProxyOrganizationOpenId": "子客企业Id", // 子客企业Id

"ProxyOperatorOpenId":"经办人的OpenId", // 经办人的OpenId

"DocumentId": "文档Id", // 文档Id

// 操作类型:CreateFlowReviewStart:提交发起审核, CreateFlowReviewPass:发起审核通过, CreateFlowReviewReject:发起审核拒绝
"Operate":"CreateFlowReviewStart",

"FlowId":"合同Id", // 合同Id

"FlowName":"合同名称" // 合同名称

}

}