文件资源相关回调
一. 合作企业授权下载合同通知
1. 回调触发时机
合作企业授权下载合同开通完成
2. 回调消息类型
DownloadOpenAuth
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 如果第三方子企业员工签署, 此字段为第三方子企业员工的唯一标识 |
| AuthSuccess | bool | 认证结果，开通完成固定为true |
5. 示例
{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "DownloadOpenAuth",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
"ProxyOrganizationOpenId": "00498cc8500be9cxxxxxxx3aff766cac",
"ProxyOperatorOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
"AuthSuccess": true
}
}
二. 合作企业取消授权下载合同通知
1. 回调触发时机
合作企业取消授权下载合同完成
2. 回调消息类型
DownloadCloseAuth
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| ProxyOperatorOpenId | String | 如果第三方子企业员工签署, 此字段为第三方子企业员工的唯一标识 |
| AuthSuccess | bool | 处理结果，取消完成固定为false |
5. 示例
{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "DownloadCloseAuth",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
"ProxyOrganizationOpenId": "00498cc8500be9cxxxxxxx3aff766cac",
"ProxyOperatorOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
"AuthSuccess": false
}
}
三. 文档合成完成后回调通知
1. 回调触发时机
当发起的合同中存在高耗时合成任务时，合成完成后进行回调
如：含有动态表格的文档合成
2. 回调消息类型
DocumentFill
3. 其他说明
无
4. 回调结构体
MsgData结构体定义
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| ApplicationId | String | 第三方应用的应用编号 |
| ProxyOrganizationOpenId | String | 第三方平台子客企业的唯一标识，定义Agent中的ProxyOrganizationOpenId一样, 可以参考Agent结构体 |
| TaskId | String | 合成任务Id, 可以使用 TaskId 通过 ChannelGetTaskResultApi 接口获取文档任务状态 |
| DocumentFileStatus | bool | 处理状态，一般是成功-SUCCESS |
| ResourceUrl | String | PDF文档资源链接 |
5. 示例
{
"MsgId": "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz",
"MsgType": "DocumentFill",
"MsgVersion": "ThirdPartyApp",
"MsgData": {
"ApplicationId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
"ProxyOrganizationOpenId": "00498cc8500be9cxxxxxxx3aff766cac",
"TaskId": "yDwFdUUckxxxxxxxxxxxN43W6Kca",
"DocumentFileStatus": "SUCCESS",
"ResourceUrl": "https://xxx.com/files/DOCUMENT/xxx"
}
}