合同发起以及签署相关回调
下面只介绍MsgType以及对应MsgData数据
合同发起以及签署回调通知参数
注意,回调V1、V2版本此类型的回调相差较大
回调V2版本,是标准结构,解密后为
{
"MsgId":"xxx",
"MsgType":"FlowStatusChange",
"MsgVersion":"CustomApp",
"MsgData":{
"FlowId":"xxxx",
...
}
}
回调V1版本,此类型的回调消息体是此MsgData结构,解密后为
{
"FlowId":"xxxx",
...
}
回调数据对象 MsgData 结构
参数名称 | 参数类型 | 参数描述 |
---|---|---|
FlowId | string | 流程编号。 |
DocumentId | string | 使用的文档 ID。 |
CallbackType | string | 回调的类型: sign:签署回调 review:审核回调 fill:填写回调 |
FlowName | string | 流程名称。 |
FlowType | string | 流程的类型。 |
FlowDescription | string | 流程的描述。 |
Unordered | bool | 流程类型顺序: true:为无序 false:为有序 |
CreateOn | int | 流程的创建时间戳。 |
UpdatedOn | int | 流程的修改时间戳。 |
DeadLine | int | 流程的过期时间0为永远不过期。 |
FlowCallbackStatus | int | 流程现在的状态: 1:待签署 2:部分签署 3:已拒签 4:已签署 5:已过期 6:已撤销 8:等待填写 21:已解除 |
UserId | string | 本环节需要操作人 UserId。 |
RecipientId | string | 签署区 ID。 |
Operate | string | 动作: start:发起 sign:签署 reject:拒签 cancel:取消 finish:结束 deadline:过期 fill:填写 |
UserData | string | 创建的时候设置的透传字段。 |
Approvers | Approver 数组 | 流程签约方列表。 |
合同消息内部Approver 结构
参数名称 | 参数类型 | 参数描述 |
---|---|---|
UserId | string | 本环节需要操作人的 UserId。 |
RecipientId | string | 签署区 ID。 |
ApproverType | int | 参与者类型: 0:企业 1:个人 3:企业静默签署 |
OrganizationName | string | 企业名称。 |
Required | bool | 是否需要签名。 |
ApproverName | string | 本环节需要操作人的名字。 |
ApproverMobile | string | 本环节需要操作人的手机号。 |
ApproverIdCardType | string | 签署人证件类型: ID_CARD:身份证。 HONGKONG_AND_MACAO:港澳居民来往内地通行证。 HONGKONG_MACAO_AND_TAIWAN:港澳台居民居住证(格式同居民身份证)。 |
ApproverIdCardTypeDesc | string | 签署人证件类型描述: 居民身份证,港澳居民来往内地通行证,港澳台居民居住证 等。 如果为自定义证件类型,则为用户传的自定义证件类型值。 |
ApproverIdCardNumber | string | 签署人证件号码。 |
ApproveCallbackStatus | int | 签署状态: 2:待签署 3:已签署 4:已拒绝 5:已过期 6:已撤销 8:待填写 9:因为各种原因而终止 10:填写 15:已解除 19:已转他人处理 |
ApproveMessage | string | 拒签的原因。 |
VerifyChannel | string | 签署意愿方式,WEIXINAPP:人脸识别。 |
ApproveTime | int | 签约的时间。 |
扣费回调通知参数
此回调类型MsgType为 FlowCost 合同扣费
回调数据对象 MsgData 结构
参数名称 | 参数类型 | 参数描述 |
---|---|---|
Cost | int | 扣除份额,如果为负值则为份额退还。 |
CostChannel | string | 扣费渠道。 |
FlowId | string | 合同 ID。 |
OrganizationId | string | 企业 ID。 |
IsResell | bool | 分销订单标识。 |