Textin DocFlow API文档
  1. REST API 列表
Textin DocFlow API文档
  • REST API 开发者文档概述
  • DocFlow业务处理流程
  • 接口认证
  • 状态码列表
  • 应用场景
    • 文档解析
    • 文档分类
    • 信息抽取
    • 智能审核
  • REST API 列表
    • 智能审核
      • 审核接口使用教程说明
      • 审核接口字段依赖
      • 文件批次列表
      • 文件任务类别列表
      • 审核规则列表
      • 文件任务列表
      • 模型字段列表
      • 创建审核规则
      • 更新审核规则
      • 删除审核规则
      • 试运行审核规则
      • 提交审核任务
      • 审核规则任务列表
    • 上传文件
      POST
    • 获取文件处理结果列表
      GET
    • 更新文件处理结果
      POST
  1. REST API 列表

获取文件处理结果列表

GET
/api/app-api/sip/platform/v2/file/fetch
获取文件处理结果列表
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://docflow.textin.com/api/app-api/sip/platform/v2/file/fetch?workspace_id'
响应示例响应示例
{
    "code": 200,
    "message": "string",
    "result": {
        "total": 100,
        "page": 1,
        "page_size": 20,
        "files": [
            {
                "id": 202412190001,
                "task_id": 202412190001,
                "task_type": 1,
                "batch_number": 202412190001,
                "name": "invoice.pdf",
                "format": "string",
                "recognition_status": 0,
                "verification_status": 0,
                "category": "invoice",
                "pages": [
                    {
                        "angle": 0,
                        "width": 1024,
                        "height": 1024,
                        "dpi": 144
                    }
                ],
                "data": {
                    "fields": [
                        {
                            "key": "发票代码",
                            "value": "3100231130",
                            "position": [
                                {
                                    "page": 0,
                                    "vertices": [
                                        0,
                                        0,
                                        100,
                                        0,
                                        100,
                                        100,
                                        0,
                                        100
                                    ]
                                }
                            ]
                        },
                        {
                            "key": "发票号码",
                            "value": "28737000",
                            "position": [
                                {
                                    "page": 0,
                                    "vertices": [
                                        0,
                                        0,
                                        100,
                                        0,
                                        100,
                                        100,
                                        0,
                                        100
                                    ]
                                }
                            ]
                        }
                    ],
                    "items": [
                        [
                            {
                                "key": "货物劳务名称",
                                "value": "*电子计算机*微型计算机主机",
                                "position": [
                                    {
                                        "page": 0,
                                        "vertices": [
                                            0,
                                            0,
                                            100,
                                            0,
                                            100,
                                            100,
                                            0,
                                            100
                                        ]
                                    }
                                ]
                            },
                            {
                                "key": "规格型号",
                                "value": "DMS-SC68",
                                "position": [
                                    {
                                        "page": 0,
                                        "vertices": [
                                            0,
                                            0,
                                            100,
                                            0,
                                            100,
                                            100,
                                            0,
                                            100
                                        ]
                                    }
                                ]
                            }
                        ],
                        [
                            {
                                "key": "货物劳务名称",
                                "value": "*机械计算机*巨型计算机主机",
                                "position": [
                                    {
                                        "page": 0,
                                        "vertices": [
                                            0,
                                            0,
                                            100,
                                            0,
                                            100,
                                            100,
                                            0,
                                            100
                                        ]
                                    }
                                ]
                            },
                            {
                                "key": "规格型号",
                                "value": "AN/FSQ-7",
                                "position": [
                                    {
                                        "page": 0,
                                        "vertices": [
                                            0,
                                            0,
                                            100,
                                            0,
                                            100,
                                            100,
                                            0,
                                            100
                                        ]
                                    }
                                ]
                            }
                        ]
                    ],
                    "tables": [
                        {
                            "table_name": "table1",
                            "table_type": 0,
                            "items": [
                                [
                                    {
                                        "key": "货物劳务名称",
                                        "value": "*电子计算机*微型计算机主机",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    },
                                    {
                                        "key": "规格型号",
                                        "value": "DMS-SC68",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    }
                                ],
                                [
                                    {
                                        "key": "货物劳务名称",
                                        "value": "*机械计算机*巨型计算机主机",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    },
                                    {
                                        "key": "规格型号",
                                        "value": "AN/FSQ-7",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    }
                                ]
                            ]
                        }
                    ],
                    "stamps": [
                        {
                            "angel": 0,
                            "page": 0,
                            "text": "全国统一发票监制章",
                            "type": "其他",
                            "color": "红色",
                            "shape": "椭圆章",
                            "position": [
                                {
                                    "page": 0,
                                    "vertices": [
                                        0,
                                        0,
                                        100,
                                        0,
                                        100,
                                        100,
                                        0,
                                        100
                                    ]
                                }
                            ]
                        },
                        {
                            "angel": 0,
                            "page": 0,
                            "text": "税务局章",
                            "type": "其他",
                            "color": "红色",
                            "shape": "椭圆章",
                            "position": [
                                {
                                    "page": 0,
                                    "vertices": [
                                        0,
                                        0,
                                        100,
                                        0,
                                        100,
                                        100,
                                        0,
                                        100
                                    ]
                                }
                            ]
                        }
                    ],
                    "handwritings": [
                        {
                            "angel": 0,
                            "page": 0,
                            "text": "3月1日",
                            "position": [
                                {
                                    "page": 0,
                                    "vertices": [
                                        0,
                                        0,
                                        100,
                                        0,
                                        100,
                                        100,
                                        0,
                                        100
                                    ]
                                }
                            ]
                        },
                        {
                            "angel": 0,
                            "page": 0,
                            "text": "张三",
                            "position": [
                                {
                                    "page": 0,
                                    "vertices": [
                                        0,
                                        0,
                                        100,
                                        0,
                                        100,
                                        100,
                                        0,
                                        100
                                    ]
                                }
                            ]
                        }
                    ],
                    "invoice_verify_result": {
                        "invoice_verify_status": 0,
                        "invoice_verify_error_code": 0,
                        "invoice_verify_can_retry": 0,
                        "invoice_verify_fail_msg": "超过当天次数上限"
                    }
                },
                "document": {
                    "pages": [
                        {
                            "angle": 0,
                            "width": 0,
                            "height": 0,
                            "lines": [
                                {
                                    "text": "string",
                                    "position": [
                                        0
                                    ],
                                    "char_positions": [
                                        [
                                            0
                                        ]
                                    ]
                                }
                            ]
                        }
                    ]
                },
                "child_files": [
                    {
                        "id": 202412190001,
                        "task_id": 202412190001,
                        "task_type": 1,
                        "parent_task_id": 202412190001,
                        "batch_number": 202412190001,
                        "name": "invoice.pdf",
                        "format": "string",
                        "recognition_status": 0,
                        "verification_status": 0,
                        "category": "invoice",
                        "pages": [
                            {
                                "angle": 0,
                                "width": 1024,
                                "height": 1024,
                                "dpi": 144
                            }
                        ],
                        "data": {
                            "fields": [
                                {
                                    "key": "发票代码",
                                    "value": "3100231130",
                                    "position": [
                                        {
                                            "page": 0,
                                            "vertices": [
                                                0,
                                                0,
                                                100,
                                                0,
                                                100,
                                                100,
                                                0,
                                                100
                                            ]
                                        }
                                    ]
                                },
                                {
                                    "key": "发票号码",
                                    "value": "28737000",
                                    "position": [
                                        {
                                            "page": 0,
                                            "vertices": [
                                                0,
                                                0,
                                                100,
                                                0,
                                                100,
                                                100,
                                                0,
                                                100
                                            ]
                                        }
                                    ]
                                }
                            ],
                            "items": [
                                [
                                    {
                                        "key": "货物劳务名称",
                                        "value": "*电子计算机*微型计算机主机",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    },
                                    {
                                        "key": "规格型号",
                                        "value": "DMS-SC68",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    }
                                ],
                                [
                                    {
                                        "key": "货物劳务名称",
                                        "value": "*机械计算机*巨型计算机主机",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    },
                                    {
                                        "key": "规格型号",
                                        "value": "AN/FSQ-7",
                                        "position": [
                                            {
                                                "page": 0,
                                                "vertices": [
                                                    0,
                                                    0,
                                                    100,
                                                    0,
                                                    100,
                                                    100,
                                                    0,
                                                    100
                                                ]
                                            }
                                        ]
                                    }
                                ]
                            ],
                            "tables": [
                                {
                                    "table_name": "table1",
                                    "table_type": 0,
                                    "items": [
                                        [
                                            {
                                                "key": "货物劳务名称",
                                                "value": "*电子计算机*微型计算机主机",
                                                "position": [
                                                    {
                                                        "page": 0,
                                                        "vertices": [
                                                            0,
                                                            0,
                                                            100,
                                                            0,
                                                            100,
                                                            100,
                                                            0,
                                                            100
                                                        ]
                                                    }
                                                ]
                                            },
                                            {
                                                "key": "规格型号",
                                                "value": "DMS-SC68",
                                                "position": [
                                                    {
                                                        "page": 0,
                                                        "vertices": [
                                                            0,
                                                            0,
                                                            100,
                                                            0,
                                                            100,
                                                            100,
                                                            0,
                                                            100
                                                        ]
                                                    }
                                                ]
                                            }
                                        ],
                                        [
                                            {
                                                "key": "货物劳务名称",
                                                "value": "*机械计算机*巨型计算机主机",
                                                "position": [
                                                    {
                                                        "page": 0,
                                                        "vertices": [
                                                            0,
                                                            0,
                                                            100,
                                                            0,
                                                            100,
                                                            100,
                                                            0,
                                                            100
                                                        ]
                                                    }
                                                ]
                                            },
                                            {
                                                "key": "规格型号",
                                                "value": "AN/FSQ-7",
                                                "position": [
                                                    {
                                                        "page": 0,
                                                        "vertices": [
                                                            0,
                                                            0,
                                                            100,
                                                            0,
                                                            100,
                                                            100,
                                                            0,
                                                            100
                                                        ]
                                                    }
                                                ]
                                            }
                                        ]
                                    ]
                                }
                            ],
                            "stamps": [
                                {
                                    "angel": 0,
                                    "page": 0,
                                    "text": "全国统一发票监制章",
                                    "type": "其他",
                                    "color": "红色",
                                    "shape": "椭圆章",
                                    "position": [
                                        {
                                            "page": 0,
                                            "vertices": [
                                                0,
                                                0,
                                                100,
                                                0,
                                                100,
                                                100,
                                                0,
                                                100
                                            ]
                                        }
                                    ]
                                },
                                {
                                    "angel": 0,
                                    "page": 0,
                                    "text": "税务局章",
                                    "type": "其他",
                                    "color": "红色",
                                    "shape": "椭圆章",
                                    "position": [
                                        {
                                            "page": 0,
                                            "vertices": [
                                                0,
                                                0,
                                                100,
                                                0,
                                                100,
                                                100,
                                                0,
                                                100
                                            ]
                                        }
                                    ]
                                }
                            ],
                            "handwritings": [
                                {
                                    "angel": 0,
                                    "page": 0,
                                    "text": "3月1日",
                                    "position": [
                                        {
                                            "page": 0,
                                            "vertices": [
                                                0,
                                                0,
                                                100,
                                                0,
                                                100,
                                                100,
                                                0,
                                                100
                                            ]
                                        }
                                    ]
                                },
                                {
                                    "angel": 0,
                                    "page": 0,
                                    "text": "张三",
                                    "position": [
                                        {
                                            "page": 0,
                                            "vertices": [
                                                0,
                                                0,
                                                100,
                                                0,
                                                100,
                                                100,
                                                0,
                                                100
                                            ]
                                        }
                                    ]
                                }
                            ],
                            "invoice_verify_result": {
                                "invoice_verify_status": 0,
                                "invoice_verify_error_code": 0,
                                "invoice_verify_can_retry": 0,
                                "invoice_verify_fail_msg": "超过当天次数上限"
                            }
                        },
                        "document": {
                            "pages": [
                                {
                                    "angle": 0,
                                    "width": 0,
                                    "height": 0,
                                    "lines": [
                                        {
                                            "text": "string",
                                            "position": [
                                                0
                                            ],
                                            "char_positions": [
                                                [
                                                    0
                                                ]
                                            ]
                                        }
                                    ]
                                }
                            ]
                        },
                        "from_parent_position_list": [
                            1
                        ]
                    }
                ]
            }
        ]
    }
}

请求参数

Query 参数
page
integer 
页码,默认1
可选
默认值:
1
page_size
integer 
可选
每页数量,默认1000
默认值:
1000
workspace_id
string 
空间ID
必需
batch_number
string 
批次编号
可选
file_id
string 
文件ID
可选
category
string 
文件类别
可选
recognition_status
enum<integer> 
可选
文件识别状态 0: 待识别 1: 识别成功 2: 识别失败
枚举值:
0123456710
verification_status
enum<integer> 
可选
文件核对状态 0: 待核对 2: 已确认 3: 已拒绝 4: 已删除 5: 推迟处理
枚举值:
02345
start_time
string <date-time>
可选
以更新时间搜索的开始时间, RFC3339格式(YYYY-MM-DDTHH:MM:SSZ)
示例值:
2024-01-01T00:00:00.000Z
end_time
string <date-time>
可选
以更新时间搜索的结束时间, RFC3339格式(YYYY-MM-DDTHH:MM:SSZ)
示例值:
2024-01-01T10:00:00.000Z
with_document
boolean 
可选
是否返回文档的全部文字识别结果
默认值:
false

返回响应

🟢200成功
application/json
成功获取文件列表
Body
code
integer 
状态码
必需
示例值:
200
message
string 
状态描述
必需
result
object 
可选
total
integer 
文件总数
可选
示例值:
100
page
integer 
当前页码
可选
示例值:
1
page_size
integer 
每页数量
可选
示例值:
20
files
array [object {13}] 
可选
上一页
上传文件
下一页
更新文件处理结果
Built with