获取文件详情

GET

http://127.0.0.1/v1.0/esign/files/{fileId}

生态伙伴API/e签宝/e签宝1.0/文件

最后修改时间：2022-08-30 09:19:24

责任人：未设置

说明

调用本接口查询文件详情，包括文件名称、大小、下载地址等。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	暂不支持	E签宝数据管理权限	暂不支持
第三方企业应用	支持	E签宝数据管理权限	API Explorer
第三方个人应用	暂不支持	E签宝数据管理权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidRequest.invalidAguemnts	invalid arguments	参数错误

请求参数

Path 参数

fileId

string

可选

调用获取文件上传地址返回的fileId。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'http://127.0.0.1/v1.0/esign/files/{fileId}' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

data

object

返回的业务信息。

可选

fileId

string

可选

文件上传时返回的fileId。

name

string

文件名称。

可选

downloadUrl

string

下载地址。

可选

size

integer

可选

文件大小，单位byte。

status

integer

文件状态，取值：

可选

pdfTotalPages

integer

可选

pdf文件总页数，仅当文件类型为pdf时有值。

code

integer

返回码。

可选

message

string

返回码描述。

可选

示例

{
  "data": {
    "fileId": "string",
    "name": "string",
    "downloadUrl": "string",
    "size": 0,
    "status": 0,
    "pdfTotalPages": 0
  },
  "code": 0,
  "message": "string"
}

修改于 2022-08-30 09:19:24

获取文件上传地址

获取发起签署任务地址

获取文件详情

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码