格式转换[文件另存为]

适用版本>=v7.0.2510.20251023

接口说明：格式转换[文件另存为]

请求说明

请求地址	配置域名+/openapi+/v7/appfiles/drives/{drive_id}/files/{file_id}/convert
请求方法	POST
签名方式	KSO-1（配置域名+/openapi不参与签名）
权限要求	应用身份管理文档（应用授权） kso.appfiles.cps.readwrite

请求头（Header）

Header	参数类型	是否必填	说明
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

路径参数（Path）

名称	类型	是否必填	说明
drive_id	string	是	驱动盘id
file_id	string	是	文件id

查询参数（Query）

字段名	类型	必填	说明
_w_third_user_id	string	否	操作者id

请求体（Body）

字段名	类型	必填	说明
ap_convert_param	object	否	ap转其他格式参数
∟ file_link_enable	boolean	否	本地文件是否转换为链接
dst_drive_id	string	否	指定结果文件存储的drive盘，不传时默认与原文档存同一个盘内
dst_parent_id	string	否	指定结果文件存储的父文件id，不传时默认为根目录
et_page_zoom	object	否	EtPageZoom
∟ fit_pagetall	integer	否	表示是否适配所有列，0表示正常分页打印，1表示不分页，所有列在一页上；当fit_pagetall与fit_pagewide都为1时，表示将所有内容打印到一页上
∟ fit_pagewide	integer	否	表示是否适配所有行，0表示正常分页打印，1表示不分页，所有行在一页上
∟ keep_pagezoom	boolean	否	表示是否保持当前客户端的缩放比，true表示保持当前缩放比打印，false表示以100%的缩放比打印，当fit_pagetall或fit_pagewide中有一个为1，或都为1时，该参数不生效
file_name	string	否	另存后新文件的名称，不填则使用源文件名称
format	string	是	转换后文件格式
password	string	否	文档密码，不为空时，会参与转换PDF的过程，加密方式：先进行AES/ECB/PKCS5Padding加密，在进行base64加密，示例：q0rxZGJ************
pdf_convertor	object	否	pdf转换参数，仅在pdf转docx时生效
∟ range	array[object]	是	转换页数范围，不填则是转换全部页数
∟∟ end	integer	否	转换结束页
∟∟ start	integer	否	转换开始页
∟ repair	boolean	否	是否需要进行乱码修复，不需要则不填
po_convert_param	object	否	po转其他格式参数
∟ from_page	integer	否	-
∟ to_page	integer	否	-
to_img	object	否	转img参数，仅在转img时生效
∟ dpi	integer	否	pdf转图片，设置图片dpi，默认值96
to_pdf	object	否	转pdf参数，仅在转pdf时生效
∟ auto_rotate_paper	boolean	否	当使用paper_size指定页面大小时根据图片尺寸，自动使用横向或纵向的纸张，默认true
∟ center_horizontally	boolean	否	et转pdf,表格部分是水平居中的，默认true
∟ center_vertically	boolean	否	et转pdf,表格部分是垂直居中的，默认true
∟ from_page	integer	否	仅在文字、演示、PDF格式转pdf时生效,转换起始页，从 1 开始计数
∟ jpeg_quality	integer	否	word转pdf指定生成的pdf中图片质量，取值范围[10,100]，默认75
∟ orientation	integer	否	表格转PDF 纸张方向选项: 2 -> 纸张横放; 1 -> 纸张竖放; 默认纸张竖放
∟ paper_size	integer	否	图片转PDF 指定页面大小：0: A4, 1: A5 默认-1，不指定页面大小
∟ scale_small_image	boolean	否	当使用paper_size指定页面大小时:true: 小图片放大到页面，保持纵横比；false: 小图片居中
∟ sheet_index	integer	否	严格按你提供的 JSON：用于表格 Excel 转换时指定需要转换哪一个 Sheet，从 1 开始计数
∟ to_page	integer	否	仅在文字、演示、PDF格式转pdf时生效,转换结束页，to_page 需要大于 from_page，to_page也可以指定为 -1，导出到最后一页（全部转换）
to_png	object	否	转png参数，仅在转png时生效
∟ from_page	integer	否	仅在文字、演示、PDF格式转png时生效,转换起始页，从 1 开始计数
∟ long_pic	boolean	否	是否转换为长图
∟ sheet_index	integer	否	仅在表格转pdf时生效，用于表格 Excel 转换时指定需要转换哪一个 Sheet，从 1 开始计数
∟ to_page	integer	否	仅在文字、演示、PDF格式转png时生效,转换结束页，to_page 需要大于 from_page，to_page也可以指定为 -1，导出到最后一页（全部转换）
web_encoding	string	否	转html设置的字符集 默认和V5最开始版本一致，gb2312

请求体示例

{
  "ap_convert_param": {
    "file_link_enable": true
  },
  "dst_drive_id": "string",
  "dst_parent_id": "string",
  "et_page_zoom": {
    "fit_pagetall": 0,
    "fit_pagewide": 0,
    "keep_pagezoom": true
  },
  "file_name": "string",
  "format": "string",
  "password": "string",
  "pdf_convertor": {
    "range": [
      {
        "end": 0,
        "start": 0
      }
    ],
    "repair": true
  },
  "po_convert_param": {
    "from_page": 0,
    "to_page": 0
  },
  "to_img": {
    "dpi": 0
  },
  "to_pdf": {
    "auto_rotate_paper": true,
    "center_horizontally": true,
    "center_vertically": true,
    "from_page": 0,
    "jpeg_quality": 0,
    "orientation": 0,
    "paper_size": 0,
    "scale_small_image": true,
    "sheet_index": 0,
    "to_page": 0
  },
  "to_png": {
    "from_page": 0,
    "long_pic": true,
    "sheet_index": 0,
    "to_page": 0
  },
  "web_encoding": "string"
}

响应体（Response）

名称	类型	说明
data	object	返回的数据对象
∟ id	string	文件 ID
∟ name	string	文件名称
∟ type	string	文件类型，Enum: "folder" "file"
∟ parent_id	string	父目录 ID（示例："0"）
∟ size	integer	文件大小（字节）
∟ version	integer	文件版本号
∟ drive_id	string	驱动盘 ID
∟ ctime	integer	创建时间（Unix 时间戳）
∟ mtime	integer	修改时间（Unix 时间戳）
∟ shared	boolean	是否开启分享（应用文档为 false）
∟ link_id	string	链接 ID（应用文档为空字符串）
∟ link_url	string	链接 URL（应用文档为空字符串）
∟ created_by	object	创建者信息
∟∟ id	string	身份 ID
∟∟ type	string	Enum: "sp"
∟ modified_by	object	修改者信息
∟∟ id	string	身份 ID
∟∟ type	string	Enum: "sp"
code	int	错误码
msg	string	状态信息
detail	string	详细信息

响应体示例

{
    "data": {
        "id": "350745587089408",
        "drive_id": "349087249465344",
        "parent_id": "0",
        "created_by": {
            "id": "userId",
            "type": "sp"
        },
        "modified_by": {
            "id": "userId",
            "type": "sp"
        },
        "size": 14498,
        "version": 1,
        "type": "file",
        "name": "文件导入.pom",
        "ctime": 1764928529,
        "mtime": 1764928529,
        "shared": false,
        "link_url": "",
        "link_id": ""
    },
    "code": 0,
    "detail": "",
    "msg": "ok"
}