文档中心 > API类目 > 欢行开发平台API

alibaba.tae.common.file.upload (文件上传地址获取)

创建文件记录并获取文件直传地址和预览地址

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tp_request FileUploadUrlOpenRequestDto 可选 文件上传地址获取请求
  • └ biz_scene
  • String
  • 必须
  • receipt
  • 文件业务场景,如报销单附件或电子发票
  • └ file_name
  • String
  • 必须
  • invoice.pdf
  • 文件名,需包含文件扩展名
  • └ file_size
  • Number
  • 可选
  • 102400
  • 文件大小,单位为字节
  • └ file_mime_type
  • String
  • 可选
  • application/pdf
  • 文件MIME类型
  • └ ip
  • String
  • 可选
  • xxxxx
  • 客户端IP,用于选择海外加速链路
  • └ tenant_key
  • String
  • 必须
  • ant
  • 租户身份标识;开放API调用必填,Agent调用由上下文识别
  • └ app_key
  • String
  • 必须
  • ant_group
  • 调用方应用身份;开放API调用必填,Agent调用由上下文识别
  • └ employee_no
  • String
  • 必须
  • 553568
  • 企业员工工号;开放API调用必填,Agent调用由登录态注入
  • └ file_content
  • byte[] []
  • 可选
  • XXXX
  • 文件的字节数组

响应参数

名称 类型 示例值 描述
platform_result_dto PlatformResultDto platformResultDTO
  • └ result_code
  • String
  • 0
  • 结果编码,0表示成功
  • └ result_message
  • String
  • success
  • 结果消息
  • file_upload_url_open_response_dto
  • FileUploadUrlOpenResponseDto
  • 结果内容
  • └ file_id
  • Number
  • 1320678117288
  • 文件中心唯一ID,上传完成后用于关联业务数据
  • └ file_upload_url
  • String
  • xxxxx
  • 文件直传地址,调用方使用该地址上传文件内容
  • └ file_preview_url
  • String
  • xxxxx
  • 文件预览地址
  • └ is_success
  • Boolean
  • true
  • 是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTaeCommonFileUploadRequest req = new AlibabaTaeCommonFileUploadRequest();
AlibabaTaeCommonFileUploadRequest.FileUploadUrlOpenRequestDto obj1 = new AlibabaTaeCommonFileUploadRequest.FileUploadUrlOpenRequestDto();
obj1.setBizScene("receipt");
obj1.setFileName("invoice.pdf");
obj1.setFileSize(102400L);
obj1.setFileMimeType("application/pdf");
obj1.setIp("xxxxx");
obj1.setTenantKey("ant");
obj1.setAppKey("ant_group");
obj1.setEmployeeNo("553568");
req.setTpRequest(obj1);
AlibabaTaeCommonFileUploadResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_tae_common_file_upload_response>
    <platform_result_dto>
        <result_code>0</result_code>
        <result_message>success</result_message>
        <file_upload_url_open_response_dto>
            <file_id>1320678117288</file_id>
            <file_upload_url>xxxxx</file_upload_url>
            <file_preview_url>xxxxx</file_preview_url>
        </file_upload_url_open_response_dto>
        <is_success>true</is_success>
    </platform_result_dto>
</alibaba_tae_common_file_upload_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部