文档转换成 txt

将文档格式转换成 txt

请求说明

请求地址/v7/developer/weboffice/office/convert/to/txt
请求方法POST
权限要求查询和管理格式转换 kso.format_conversion.readwrite

目前支持的文档类型

文档类型扩展名
演示.pptx .ppt
WPS 文字.docx .doc
WPS 表格.xlsx .xls
WPS PDF.pdf
参数必须类型说明
Content-Type是string目前固定为: application/json
Authorization是string授权凭证，格式为：Bearer {access_token}

Body 参数

参数必须类型说明
url是string文档下载地址
filename是string文档名称，包含扩展名，例如：说明文档.pdf
password否string文档打开密码(如果文档有加密，该项则必填)
long_txt否bool是否转换成长文本，设置为 true 时，可以将需要导出的页中的文字合并导出。默认值为 false，按页导出 txt
hold_line_feed否bool转换 txt 时是否保留文档中的换行符，设置为 true 时，导出内容包含换行符。默认值为 false，导出内容不包含换行。
ranges否string自定义需要转换的分页范围，例如："1,2-4,7"，则表示转换文档的 1、2、3、4、7 页面 (与 from_page和to_page 互斥)
from_page否int转换起始页，从 1 开始计数(与 ranges互斥)
to_page否int转换结束页，需要大于 from_page， (与 ranges互斥)

返回参数

参数必须类型说明
code是integer错误码
data是data {}响应数据
> task_id是string转换任务 id

示例

请求示例

httpsnippet

{"method":"POST","url":"https://openapi.wps.cn/v7/developer/weboffice/office/convert/to/txt","headers":{"Content-Type":"application/json","Authorization":"Bearer ejxxx"},"data":{"url": "https://***.com/***","filename":"说明文档.pdf","long_txt":true}}

返回示例

json
{
  "code": 0,
  "data": {
    "task_id": "open:zjsiwfuotpbqblrlfwtkfkioargjbla"
  },
  "result": "ok"
}

查询异步任务结果

携带 task_id查询结果

其中 result 对象说明

参数必须类型说明
txts否txts[]转换后的 txt 文件列表
> url是string转换后的 txt 文件下载地址(半小时有效)
> size是int转换后的 txt 文件大小(以字节为单位)

返回示例

json
{
  "code": 0,
  "data": {
    "status": "success",
    "progress": 100,
    "result": {
      "txts": [
        {
          "url": "https://***.com/***",
          "size": 70154
        },
        {
          "url": "https://***.com/***",
          "size": 112172
        },
        {
          "url": "https://***.com/***",
          "size": 954
        },
        {
          "url": "https://***.com/***",
          "size": 35327
        }
      ],
      "task":{"elapsed":7892,"resource_size":1070216}
    }
  }
}

错误码

请参考错误码说明