服务端 API 文档

文档捉虫大赛火热进行中,好礼多多> HOT

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

本接口支持集装箱箱门信息识别,识别字段包括集装箱箱号、类型、总重量、有效承重、容量、自身重量,具备集装箱箱号、类型不完整或者不清晰的告警功能。

默认接口请求频率限制:5次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RecognizeContainerOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。
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 速度和稳定性可能受一定影响。

3. 输出参数

参数名称 类型 描述
ContainerId String 集装箱箱号
ContainerType String 集装箱类型
GrossKG String 集装箱总重量,单位:千克(KG)
GrossLB String 集装箱总重量,单位:磅(LB)
PayloadKG String 集装箱有效承重,单位:千克(KG)
PayloadLB String 集装箱有效承重,单位:磅(LB)
CapacityM3 String 集装箱容量,单位:立方米
CapacityFT3 String 集装箱容量,单位:立英尺
Warn Array of Integer 告警码
-9926 集装箱箱号不完整或者不清晰
-9927 集装箱类型不完整或者不清晰
TareKG String 集装箱自身重量,单位:千克(KG)
TareLB String 集装箱自身重量,单位:磅(LB)
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 集装箱识别示例代码

输入示例

https://ocr.tencentcloudapi.com/?Action=RecognizeContainerOCR
&ImageUrl=https://xx/a.jpg
&<公共请求参数>

输出示例

{
    "Response": {
        "ContainerId": "APHU7042391",
        "ContainerType": "45G1",
        "GrossKG": "32500KG",
        "GrossLB": "71650LB",
        "PayloadKG": "28630KG",
        "PayloadLB": "63120LB",
        "TareKG": "3870KG",
        "TareLB": "8530LB",
        "CapacityM3": "76.4CUM",
        "CapacityFT3": "2700CUFT",
        "Warn": [
            -9926,
            -9927
        ],
        "RequestId": "45afaba3-5fb8-480e-83f9-2681f1373783"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameter.EngineImageDecodeFailed 图片解码失败。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录