1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
本接口支持火车票全字段的识别,包括编号、出发站、到达站、出发时间、车次、座位号、姓名、票价、席别、身份证号、发票消费类型、序列号、加收票价、手续费、大写金额、售票站、原票价、发票类型、收据号码、是否仅供报销使用等字段的识别。
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:TrainTicketOCR。 |
Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。 |
ImageBase64 | 否 | String | 图片的 Base64 值。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 |
ImageUrl | 否 | String | 图片的 Url 地址。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:https://xx/a.jpg |
IsPdf | 否 | Boolean | 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。 示例值:false |
PdfPageNumber | 否 | Integer | 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TicketNum | String | 编号 示例值:17C060124 |
StartStation | String | 出发站 示例值:南京南 |
DestinationStation | String | 到达站 示例值:上海虹桥 |
Date | String | 出发时间 示例值:2017年12月23日10:33 |
TrainNum | String | 车次 示例值:G5 |
Seat | String | 座位号 示例值:15车18A号 |
Name | String | 姓名 示例值:周周 |
Price | String | 票价 示例值:134.50 |
SeatCategory | String | 席别 示例值:二等座 |
ID | String | 身份证号 示例值:3210231993****6499 |
InvoiceType | String | 发票消费类型:交通 示例值:交通 |
SerialNumber | String | 序列号 示例值:16804000071224C060124 |
AdditionalCost | String | 加收票价 示例值:2.00 |
HandlingFee | String | 手续费 示例值:5.00 |
LegalAmount | String | 大写金额(票面有大写金额该字段才有值) 示例值:贰元 |
TicketStation | String | 售票站 示例值:成都客运段 |
OriginalPrice | String | 原票价(一般有手续费的才有原始票价字段) 示例值:83.50 |
InvoiceStyle | String | 发票类型:火车票、火车票补票、火车票退票凭证 示例值:火车票补票 |
ReceiptNumber | String | 收据号码 |
IsReceipt | String | 仅供报销使用:1为是,0为否 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 火车票识别示例代码
火车票识别
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TrainTicketOCR
<公共请求参数>
{
"ImageUrl": "https://xx/a.jpg"
}
输出示例
{
"Response": {
"TicketNum": "17C060124",
"StartStation": "南京南",
"DestinationStation": "上海虹桥",
"Date": "2017年12月23日10:33",
"TrainNum": "G5",
"Seat": "15车18A号",
"Name": "周周",
"Price": "134.50",
"SeatCategory": "二等座",
"ID": "3210231993****6499",
"InvoiceType": "交通",
"SerialNumber": "16804000071224C060124",
"AdditionalCost": "2.00",
"HandlingFee": "5.00",
"LegalAmount": "贰元",
"TicketStation": "成都客运段",
"OriginalPrice": "83.50",
"InvoiceStyle": "火车票补票",
"ReceiptNumber": "",
"IsReceipt": "0",
"RequestId": "9084dec6-dae4-455f-976c-8e3609e86920"
}
}
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.DownLoadError | 文件下载失败。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.OcrFailed | OCR识别失败。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |