合同智能相关回调(新版)
一. 合同风险审查回调通知
1. 回调触发时机
在调用以下接口会发送回调事件:
- 批量创建合同审查任务
- 创建合同审查web页面当接口中
ResourceId不为空时才会发送回调事件
2. 回调消息类型
AIContractReview
3. 其他说明
合同审查任务状态类型
| 审查任务状态 | 状态描述 |
|---|---|
| 1 | 合同审查任务创建成功 |
| 2 | 合同审查任务排队中 |
| 3 | 合同审查任务执行中 |
| 4 | 合同审查任务执行成功 |
| 5 | 合同审查任务执行失败 |
注意: 调用「批量创建合同审查任务」接口时任务初始状态值为2
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| TaskId | String | 合同风险审查任务ID,为32位字符串 |
| Status | Integer | 合同风险审查任务状态 |
| ResourceId | String | 审查任务的PDF资源ID,为32位字符串 |
| RiskCount | Integer | 审查出合同的风险总数 |
| HighRiskCount | Integer | 审查出合同的高风险数量 |
| Creator | String | 合同审查任务提交人ID,为32位字符串 |
| CreateTime | Integer | 合同审查任务提交时间 |
| Comment | String | 合同审查任务备注信息 |
| UserData | String | 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度 |
5. 示例
示例一: 合同风险审查任务执行成功
{
"MsgId": "yDt4cUUhjryeknUx0czl4BHLeS95VDxy",
"MsgType": "AIContractReview",
"MsgVersion": "CustomApp",
"MsgData": {
"TaskId": "yDt4cUUh8iy4hzUyscPS4uASGeYeQX2c",
"ResourceId": "yDt4dUUhhknplnUEHDuK7C3DO8OK7VoG",
"Status": 4,
"RiskCount": 8,
"HighRiskCount": 3,
"Creator": "yDwJGUU689h0jUddiSN8diehztsrrmBe",
"CreateTime": 1756110841,
"Comment": "测试",
"UserData": "5rWL6K+V5pWw5o2u"
}
}
示例二: 合同风险审查任务执行失败
{
"MsgId": "yDt4cUUckp93l1d7UKDJSgx5AvBN9RdQ",
"MsgType": "AIContractReview",
"MsgVersion": "CustomApp",
"MsgData": {
"TaskId": "yDt4cUUckp93l1gzUKDJSgBZKAu2WnD3",
"ResourceId": "yDt4dUUckp91v7uiUujDmjIyJcBKFVxi",
"Status": 5,
"RiskCount": 0,
"HighRiskCount": 0,
"Creator": "yDwqbUUckp3o2rzmUxHsV0j1FlhYIKo7",
"CreateTime": 1756122099,
"Comment": "",
"UserData": ""
}
}
二. 合同智能提取回调通知
1. 回调触发时机
在创建信息提取任务时发送回调事件:
- 电子签控制台创建的合同提取任务
- 批量创建合同智能提取任务
- 创建合同智能提取web页面
2. 回调消息类型
AIInformationExtraction
3. 其他说明
合同智能提取任务状态类型
| 合同智能提取任务状态 | 状态描述 |
|---|---|
| 0 | 合同智能提取任务创建成功 |
| 1 | 合同智能提取任务排队中 |
| 2 | 合同智能提取任务执行中 |
| 3 | 合同智能提取任务执行成功 |
| 4 | 合同智能提取任务执行失败 |
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| TaskId | String | 合同智能提取任务ID,为32位字符串 |
| Status | Integer | 合同智能提取任务状态 |
| Url | String | 合同智能提取任务结果下载,文件格式为xlsx |
| Creator | String | 合同智能提取任务提交人ID,为32位字符串 |
| CreateTime | Integer | 合同智能提取任务提交时间 |
| FinishedOn | Integer | 合同智能提取任务完成时间 |
| UserData | String | 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1024长度 |
5. 示例
示例一: 合同智能提取任务执行成功
{
"MsgId": "yDtxxxxxxLY0",
"MsgType": "AIInformationExtraction",
"MsgVersion": "CustomApp",
"MsgData": {
"TaskId": "yDtxxxxxxYYY",
"ResourceInfo": [
{
"ResourceId": "xxxxxx",
"ResourceNames": "某企业办公设备采购协议.pdf"
}
],
"Status": 3,
"Url": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=xxxxx",
"CreateTime": 1760595572,
"FinishedOn": 1760595603,
"Creator": "xxxx",
"UserData": "5rWL6K+V5pWw5o2u"
}
}
示例二: 合同智能提取任务执行失败
{
"MsgId": "yDtxxxxxxLY0",
"MsgType": "AIInformationExtraction",
"MsgVersion": "CustomApp",
"MsgData": {
"TaskId": "yDtxxxxxxSYZ",
"ResourceInfo": [
{
"ResourceId": "yDtxxxxxxtdu",
"ResourceNames": "文档功能.pdf"
}
],
"Status": 4,
"Url": "",
"CreateTime": 1761097032,
"FinishedOn": 1761097047,
"Creator": "yDwxxxxxxxxxYIKo7",
"UserData": ""
}
}