文档变更
2022年时,流程文档下载变为下载已签文件,以便开发者更容易理解,仅中文名称变更,其功能保持不变。
接口描述
流程完结后,查询签署完成的文件下载链接。
接口地址&请求方式
接口地址:/v1/signflows/{flowId}/documents
请求方式:GET
请求头格式
具体请求头格式结构,请点击查看公共参数说明。
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 (左右拖动查看完整描述) |
flowId | string | 是 | path | 流程ID |
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 (左右拖动查看完整描述) | ||
code | int | 是 | 业务码,0表示成功 | ||
message | string | 否 | 业务信息 | ||
data | object | 否 | 业务数据 | ||
docs | array | 否 | 文档列表数据 | ||
fileId | string | 否 | 文档id | ||
fileName | string | 否 | 文档名称,默认文件名称 | ||
fileUrl | string | 否 | 文档地址(有效期60分钟) 该链接建议只用于下载,不要直接预览 | ||
ctType | int | 否 | 合同类型(预留字段,开发者可忽略此字段) | ||
ctRescindStatus | int | 否 | (预留字段,开发者可忽略此字段) | ||
flowId | string | 否 | (预留字段,开发者可忽略此字段) | ||
ctRescindProcessId | string | 否 | (预留字段,开发者可忽略此字段) | ||
fileFlowRelationBeanList | string | 否 | (预留字段,开发者可忽略此字段) |
请求示例
GET https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/documents
响应示例
{ "code": 0, "message": "成功", "data": { "docs": [ { "fileId": "c8b8d909bdbf4de3b6f99edbfc52b6xx", "fileName": "xx劳动合同.pdf", "fileUrl": "https://esignoss.esign.cn/1111563786/c0cb34d5-1f9a-4dab-b3a7-c3b528229f1d/xx%E5%8A%B3%E5%8A%A8%E5%90%88%E5%90%8C.pdf?Expires=xx&OSSAccessKeyId=xx&Signature=xx%xx%3D", "ctType": null, "ctRescindStatus": null, "flowId": null, "ctRescindProcessId": null, "fileFlowRelationBeanList": null } ] } }