跳到主要内容

合同对比相关回调

一. 合同对比完成回调通知​

1. 回调触发时机​

在合同对比任务完成之后进行回调

2. 回调消息类型​

ContractDiffTaskFinish

3. 其他说明​

会出现回调的对比任务完成状态类型

审查状态对应Status
成功SUCCEED
失败FAILED

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
TaskIdString合同对比任务ID，为32位字符串
StatusString合同对比任务状态
MessageString对比失败的具体原因描述，仅当状态为失败时返回此字段
OriginalFileResourceIdString原版文件ID，对比基准的旧版本文件唯一标识
DiffFileResourceIdString新版文件ID，与旧版进行对比的新版本文件唯一标识
TotalDiffCountInt合同对比差异点总数
AddDiffCountInt合同对比新增点数量
ChangeDiffCountInt合同对比修改点数量
DeleteDiffCountInt合同对比删除点数量
UserDataString调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度
CreateTimeInt合同对比任务创建时间
OperatorUserIdString合同对比任务提交人ID

5. 示例​

示例一: 合同对比任务执行成功

{
    "MsgId": "yDtTfUUckp9ztw73UudRpd6weejFLaPt",
    "MsgType": "ContractDiffTaskFinish",
    "MsgVersion": "CustomApp",
    "MsgData": {
        "TaskId": "yDtTfUUckp9ztw7yUudRpd6B0uQGwz7S",
        "Status": "SUCCEED",
        "Message": "",
        "OriginalFileResourceId": "yDtTfUUckp9zoxbfUx7d9SlSHo6TArhV",
        "DiffFileResourceId": "yDtTfUUckp9zoxb9Ux7d9SlxJxpq5iuu",
        "TotalDiffCount": 3,
        "AddDiffCount": 1,
        "ChangeDiffCount": 1,
        "DeleteDiffCount": 1,
        "UserData": "",
        "CreateTime": 1760343247,
        "OperatorUserId": "yDt49UUckp936q0sUx2QXTeCzkDPurYe"
    }
}

示例二: 合同对比任务执行失败

{
    "MsgId": "yDtT6UUckp9mdi4xUEkjZ37wyYuEY6IC",
    "MsgType": "ContractDiffTaskFinish",
    "MsgVersion": "CustomApp",
    "MsgData": {
        "TaskId": "yDtT6UUckp9mdi4mUEkjZ37uF4VeGoqj",
        "Status": "FAILED",
        "Message": "对比失败。",
        "OriginalFileResourceId": "yDtT6UUckp9mdn65UE5rKNiyXuXlKDJp",
        "DiffFileResourceId": "yDtT6UUckp9mdn60UE5rKNiCCRWLGoDg",
        "TotalDiffCount": 0,
        "AddDiffCount": 0,
        "ChangeDiffCount": 0,
        "DeleteDiffCount": 0,
        "UserData": "",
        "CreateTime": 1760085626,
        "OperatorUserId": "yDt49UUckp936q0sUx2QXTeCzkDPurYe"
    }
}

二. 合同对比创建回调通知​

1. 回调触发时机​

在合同对比任务创建成功进行回调

2. 回调消息类型​

ContractDiffTaskCreate

3. 其他说明​

无

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
TaskIdString合同对比任务ID，为32位字符串
ResourceNameString合同对比新版文件名称
UserDataString调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度
CreateTimeInt合同对比任务创建时间
OperatorUserIdString合同对比任务提交人ID

5. 示例​

示例一: 合同对比任务创建成功

{
    "MsgId": "yDtTfUUckp9ztw7vUudRpd6urPfl5q3e",
    "MsgType": "ContractDiffTaskCreate",
    "MsgVersion": "CustomApp",
    "MsgData": {
        "TaskId": "yDtTfUUckp9ztw7yUudRpd6B0uQGwz7S",
        "ResourceName": "保证合同-新.pdf",
        "UserData": "",
        "CreateTime": 1760343247,
        "OperatorUserId": "yDt49UUckp936q0sUx2QXTeCzkDPurYe"
    }
}