有道智云AI开放平台

外观

PDF格式转换高级版 API 简介 ​

说明 ​

Hi，您好，欢迎使用有道智云PDF格式转换高级版 API接口服务。

本文档主要针对需要集成HTTP API的技术开发工程师，详细描述PDF格式转换能力相关的技术内容。

如果您有与我们商务合作的需求，可以通过以下方式联系我们：

商务邮箱： AIcloud_Business@corp.youdao.com

如果您对文档内容有任何疑问，可以通过以下几种方式联系我们：

客服QQ：1906538062

智云翻译技术交流QQ 1群: 652880659

智云翻译技术交流QQ 2群: 669384425

智云翻译技术交流QQ 3群: 807539209

智云翻译技术交流QQ 4群: 936752411

联系邮箱： zhiyun@corp.youdao.com

温馨提示：

  • 本文档主要针对开发人员，接入测试前需要获取应用ID和应用密钥；如果您还没有，请按照 新手指南 获取。
  • 平台向每个账户赠送50元的体验金，供用户集成前测试所用，具体资费 0.15 元/页。

注：

  1. 基础版和高级版接口完全独立，因此高级版上传的文件，转换进度只能通过高级版 API 查询（基础版同理）。
  2. 基础版和高级版 转换任务及结果均仅保留7天，转换成功后请及时获取并保存结果。

接口说明 ​

PDF 格式转换接口提供有道的 PDF 转换服务。您只需要通过调用 PDF 转换 API，传入文档的 Base64 编码，就可以将 PDF 文档格式进行转换。

请求流程：upload->query

BASEURL ​

https://openapi.youdao.com/file_convert/v2

协议须知 ​

规则描述
传输方式HTTPS
字符编码统一使用UTF-8 编码

公共响应参数 ​

所有接口都遵循统一的响应格式：

参数名类型描述
codeinteger响应码，200表示成功，其他表示失败
msgstring响应消息，成功时为"success"，失败时为错误描述
dataobject响应数据，具体结构见各接口说明

文件上传接口 ​

  • 接口地址

POST /upload

  • 请求参数 (multipart/form-data)
参数名类型必填描述
appKeystring是应用标识
saltstring是随机字符串
curtimestring是时间戳
signstring是签名
signTypestring是签名类型，仅支持v3
qstring是文档的Base64编码，编码后大小不能超过40M
fileNamestring是文件名（带后缀名），文件名长度不能超过100个字符
fileTypestring是源文件类型（大小写敏感），目前仅支持 pdf
targetFileTypestring是目标文件类型（大小写敏感），支持 docx、pptx、xlsx、jpeg、jpg、png

注：目标文件类型为图片类型（targetFileType = jpeg、jpg 或 png）时，结果是以zip文件的形式返回

签名生成方法如下：

sign = sha256(应用ID + input + salt + curtime + 应用密钥)

其中，input的计算方式为：

input = q 字符串（当q 长度小于等于20） 或 input = q 前10个字符前10个字符 + q 长度 + q 后十个字符（当q 长度大于20）

  • 响应参数 (data字段结构)
参数名类型描述
flownumberstring任务流水号
  • 响应示例
json
{
    "code": "0",
    "message": "success",
    "data": {
        "flownumber": "BAE670950ACE4C9E941A81B2959CXXXX"
    },
    "requestId": "1580715c-cf43-44d3-bb80-5dd28d1cXXXX",
    "successful": true
}

查询任务状态接口 ​

  • 接口地址

POST /query

  • 请求参数 (multipart/form-data)
参数名类型必填描述
appKeystring是应用标识
saltstring是随机字符串
curtimestring是时间戳
signstring是签名
signTypestring是签名类型，仅支持v3
flownumberstring是任务流水号

签名生成方法如下：

sign = sha256(应用ID + input + salt + curtime + 应用密钥)

其中，input的计算方式为：

input = flownumber字符串（当flownumber长度小于等于20）。 或 input = flownumber前10个字符前10个字符 + flownumber长度 + flownumber后十个字符（当flownumber长度大于20）

  • 响应参数 (data字段结构)
参数名类型描述
statusinteger任务状态码
statusStringstring任务状态描述
resultUrlstring结果文件下载地址，仅任务完成时存在
  • 状态码说明
状态码描述
1任务创建完成，初始化状态
2文件转换中
4转换完成
-2转换失败
  • 响应示例
json
{
    "code": "0",
    "message": "success",
    "data": {
        "status": 4,
        "statusString": "已完成",
        "resultUrl": "https://xxx.nos-jd.163yun.com/xxx"
    },
    "requestId": "d99436d1-7445-44d3-a8e5-e711774aXXXX",
    "successful": true
}

服务配置 ​

支持格式文件大小
pdf40M内（编码后）

错误代码列表 ​

错误码含义
101缺少必填的参数，首先确保必填参数齐全，然后，确认参数书写是否正确。
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108应用ID无效，注册账号，登录后台创建应用和实例并完成绑定，可获得应用ID和应用密钥等信息
109batchLog格式不正确
110无相关服务的有效实例，应用没有绑定服务实例，可以新建服务实例，绑定服务实例。注：某些服务的翻译结果发音需要tts实例，需要在控制台创建语音合成实例绑定应用后方能使用。
111开发者账号无效
112请求服务无效
113q不能为空
114不支持的图片传输方式
201解密失败，可能为DES,BASE64,URLDecode的错误
202签名检验失败，如果确认应用ID和应用密钥的正确性，仍返回202，一般是编码问题。请确保翻译文本 q 为UTF-8编码.
203访问IP地址不在可访问IP列表
205请求的接口与应用的平台类型不一致，确保接入方式（Android SDK、IOS SDK、API）与创建的应用平台类型一致。如有疑问请参考入门指南
206因为时间戳无效导致签名校验失败
207重放请求
301辞典查询失败
302翻译查询失败
303服务端的其它异常
304会话闲置太久超时
401账户已经欠费停
402offlinesdk不可用
411访问频率受限,请稍后访问
412长请求过于频繁，请稍后访问
1001无效的OCR类型
1002不支持的OCR image类型
1003不支持的OCR Language类型
1004识别图片过大
1201图片base64解密失败
1301OCR段落识别失败
1411访问频率受限
1412超过最大识别字节数
2003不支持的语言识别Language类型
2004合成字符过长
2005不支持的音频文件类型
2006不支持的发音类型
2201解密失败
2301服务的异常
2411访问频率受限,请稍后访问
2412超过最大请求字符数
3001不支持的语音格式
3002不支持的语音采样率
3003不支持的语音声道
3004不支持的语音上传类型
3005不支持的语言类型
3006不支持的识别类型
3007识别音频文件过大
3008识别音频时长过长
3009不支持的音频文件类型
3010不支持的发音类型
3201解密失败
3301语音识别失败
3302语音翻译失败
3303服务的异常
3411访问频率受限,请稍后访问
3412超过最大请求字符数
4001不支持的语音识别格式
4002不支持的语音识别采样率
4003不支持的语音识别声道
4004不支持的语音上传类型
4005不支持的语言类型
4006识别音频文件过大
4007识别音频时长过长
4201解密失败
4301语音识别失败
4303服务的异常
4411访问频率受限,请稍后访问
4412超过最大请求时长
5001无效的OCR类型
5002不支持的OCR image类型
5003不支持的语言类型
5004识别图片过大
5005不支持的图片类型
5006文件为空
5201解密错误，图片base64解密失败
5301OCR段落识别失败
5411访问频率受限
5412超过最大识别流量
9001不支持的语音格式
9002不支持的语音采样率
9003不支持的语音声道
9004不支持的语音上传类型
9005不支持的语音识别 Language类型
9301ASR识别失败
9303服务器内部错误
9411访问频率受限（超过最大调用次数）
9412超过最大处理语音长度
10001无效的OCR类型
10002不支持的OCR image类型
10004识别图片过大
10201图片base64解密失败
10301OCR段落识别失败
10411访问频率受限
10412超过最大识别流量
11001不支持的语音识别格式
11002不支持的语音识别采样率
11003不支持的语音识别声道
11004不支持的语音上传类型
11005不支持的语言类型
11006识别音频文件过大
11007识别音频时长过长，最大支持30s
11201解密失败
11301语音识别失败
11303服务的异常
11411访问频率受限,请稍后访问
11412超过最大请求时长
12001图片尺寸过大
12002图片base64解密失败
12003引擎服务器返回错误
12004图片为空
12005不支持的识别图片类型
12006图片无匹配结果
13001不支持的角度类型
13002不支持的文件类型
13003表格识别图片过大
13004文件为空
13301表格识别失败
15001需要图片
15002图片过大（1M）
15003服务调用失败
17001需要图片
17002图片过大（1M）
17003识别类型未找到
17004不支持的识别类型
17005服务调用失败
18001需要参数
18002需要流水号
18003需要文件名
18004需要文件类型
18005需要源语言
18006需要目标语言
18007需要翻译文件
18008上传文件失败
18009错误的流水号
18010未完成
18011转换失败
18012找不到文件
18013需要文件下载类型
18014不支持的语言
18015不支持的文件类型
18016不支持的下载类型
18017文件过大
340001PDF 文件格式错误
340002PDF 文件保存失败
340003流水号flownumber不存在或已过期
340004不支持的源文件类型

常用语言 Demo ​

Python 示例 ​

PDF格式转换 Python3 demo

Java 示例 ​

PDF格式转换 Java demo

Go 示例 ​

PDF格式转换 Go demo