1. 接口描述
接口请求域名: tmt.tencentcloudapi.com 。
提交文档原文内容,输出任务ID, 支持原文为单一语种文档(如出现多语言文档,仅支持以选定的源语言相关内容翻译),文件格式有pdf、docx、pptx、xlsx,支持的文本格式有txt、xml、html、markdown、properties。任务翻译数据可保存7天,7天后不再返回任务数据。请注意保存。
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:FileTranslate。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-21。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Source | 是 | String | 源语言,支持 zh:简体中文 zh-HK:繁体中文 zh-TW:繁体中文 zh-TR:繁体中文 en:英语 ar:阿拉伯语 de:德语 es:西班牙语 fr:法语 it:意大利语 ja:日语 pt:葡萄牙语 ru:俄语 ko:韩语 th:泰语 示例值:zh |
Target | 是 | String | 目标语言,各源语言的目标语言支持列表如下 zh(简体中文):en(英语)、ar(阿拉伯语)、de(德语)、es(西班牙语)、fr(法语)、it(意大利语)、ja(日语)、pt(葡萄牙语)、ru(俄语)、ko(韩语)、tr(土耳其语)、vi(越南语)、th(泰语) zh-HK(繁体中文):en(英语)、ar(阿拉伯语)、de(德语)、es(西班牙语)、fr(法语)、it(意大利语)、ja(日语)、pt(葡萄牙语)、ru(俄语)、ko(韩语)、tr(土耳其语)、vi(越南语)、th(泰语) zh-TW(繁体中文):en(英语)、ar(阿拉伯语)、de(德语)、es(西班牙语)、fr(法语)、it(意大利语)、ja(日语)、pt(葡萄牙语)、ru(俄语)、ko(韩语)、tr(土耳其语)、vi(越南语)、th(泰语) zh-TR(繁体中文):en(英语)、ar(阿拉伯语)、de(德语)、es(西班牙语)、fr(法语)、it(意大利语)、ja(日语)、pt(葡萄牙语)、ru(俄语)、ko(韩语)、tr(土耳其语)、vi(越南语)、th(泰语) en(英语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、ar(阿拉伯语)、de(德语)、es(西班牙语)、fr(法语)、it(意大利语)、ja(日语)、pt(葡萄牙语)、ru(俄语)、ko(韩语)、tr(土耳其语)、vi(越南语)、th(泰语) ar(阿拉伯语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) de(德语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) es(西班牙语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语)、fr(法语) fr(法语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语)、es(西班牙语) it(意大利语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) ja(日语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) pt(葡萄牙语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) ru(俄语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) ko(韩语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) tr(土耳其语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) vi(越南语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) th(泰语):zh(简体中文)、zh-HK(繁体中文)、zh-TW(繁体中文)、zh-TR(繁体中文)、en(英语) 示例值:en |
DocumentType | 是 | String | 文档类型:可支持以下几种(pdf,docx,pptx,xlsx,txt,xml,html,markdown,properties) 示例值:pdf |
SourceType | 否 | Integer | 数据来源,0:url,1:直接传文件编码后数据 示例值:1 |
Url | 否 | String | 需要翻译文件url,URL长度不能超过1000字符。文件限制如下:docx/xIsx/html/markdown文件不超过800万字符,doc/pdf/pptx文件不超过300页,txt/po文件不超过10MB,pdf/docx/pptx/xlsx不超过40MB 示例值:http://test.com |
BasicDocumentType | 否 | String | 原始文档类型。该参数为高级参数,请留空,如需使用,请与工作人员确认后再使用。 示例值:docx |
CallbackUrl | 否 | String | 回调url,URL长度不能超过256字符。文件大于10MB或字符较多时,建议采用回调方式;回调时,所有内容会放入 Body 中,具体请参见文件翻译回调说明。 示例值:http://test.com |
Data | 否 | String | 文件数据,当SourceType 值为1时必须填写,为0可不写。要base64编码(采用python语言时注意读取文件应该为string而不是byte,以byte格式读取后要decode()。编码后的数据不可带有回车换行符)。数据要小于5MB。 示例值:eGNmYXNkZmFzZmFzZGZhc2RmCg== |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Task | 文件翻译的请求返回结果,包含结果查询需要的TaskId |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 文件翻译请求调用示例
通过文件数据来调用接口
输入示例
POST / HTTP/1.1
Host: tmt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: FileTranslate
<公共请求参数>
{
"SourceType": 1,
"Source": "zh",
"Target": "en",
"DocumentType": "txt",
"Data": "5L2g5aW944CC"
}
输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
"Data": {
"TaskId": "1396665"
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ErrorUserArea | 用户区域与请求服务区域不一致。 |
FailedOperation.InsertErr | 数据插入错误。 |
FailedOperation.RequestAiLabErr | 内部请求错误。 |
FailedOperation.ServiceIsolate | 账号因为欠费停止服务,请在腾讯云账户充值。 |
FailedOperation.StopUsing | 账号已停服。 |
FailedOperation.SubmissionLimitReached | 当日提交任务数达到上限 |
FailedOperation.TooManyWaitProcess | 过多未完成任务 |
FailedOperation.UserHasNoFreeAmount | 本月免费额度已用完,如需继续使用您可以在机器翻译控制台购买资源包或开通后付费使用。 |
FailedOperation.UserNotRegistered | 服务未开通,请在腾讯云官网机器翻译控制台开通服务。 |
UnauthorizedOperation.ActionNotFound | 请填写正确的Action字段名称。 |