天翼云通信行程卡识别API文档
文档简介:
接口描述:
针对图片中的通信行程卡,进行OCR检测,返回检测到的行程卡颜色,电话号码,请求时间,到达城市,风险城市。
备注:接口只允许单张图片请求,不允许图片list。
接口描述
针对图片中的通信行程卡,进行OCR检测,返回检测到的行程卡颜色,电话号码,请求时间,到达城市,风险城市。
备注:接口只允许单张图片请求,不允许图片list。
请求方法
POST
接口要求
- 目前仅支持 base64 编码方式请求,暂不支持 url 方式请求。一次请求仅支持一条数据。
- 图片格式限制:目前仅支持 jpg、jpeg、png、bmp 等常见格式。
- 图片大小限制:图片大小不超过 7 MB。
- 图片尺寸限制:图片像素尺寸应不小于 32x32,不大于 5000x5000。
请求URL
/v1/aiop/api/2xfwz87g6s4c/travel-card/ocr/detect
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | string | json 格式 | "application/json" | |
appkey | 是 | string | 诸葛 AI 应用 appkey | "562b89493b1a40e1b97ea05e50dd8170" |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Action | 是 | string | 算法名称,只能为“RecognizeTravelCardOCR” | "RecognizeTravelCardOCR" | |
ImageData | 是 | string | 图片 Base64 编码数据,图片需要使用常规 safe base64 编码方式,不包含前缀 "data:img/jpg;base64," | "_9j_4AAQSkZJRgA..." |
请求代码示例
Curl -X POST
"https://ai-global.ctapi.ctyun.cn/v1/aiop/api/2xfwz87g6s4c/travel-card/ocr/detect"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "appkey:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:ai-global.ctapi.ctyun.cn"
--data '{"Action": "RecognizeTravelCardOCR","ImageData": "_9j_4AAQSkZJRgA..."}'复制
返回值说明
请求成功返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | int | 返回状态,返回 0 表示成功,返回错误代码参考下面的错误代码列表。 | 0 | |
message | 是 | string | 如果 code 为 0,返回 success;如果 code 非 0,则返回对应的可读错误信息。 | "success" | |
result | 是 | object | 返回的通信行程卡识别结果对象 | result |
表result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Color | 是 | string | 行程卡颜色 | "绿色" | |
Telephone | 是 | string | 电话号码 | "189****5828" | |
Time | 是 | string | 图片时间 | "2022.04.23 20:12:53" | |
ReachedCity | 是 | list | 到达城市,按照列表形式排列 | ["河北省廊坊市","重庆市"] | |
Notes | 是 | string | 备注 | "(注:*表示当前该城市存在中风险或高风险地区,并不表示用户实际到访过这些中高风险地区。)" | |
RiskAreas | 是 | list | 风险城市,按照列表形式排列 | ["重庆市"] |
请求失败返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | int | 错误码,放置API对应的错误码 | 400003 | |
message | 是 | string | 返回对应的错误信息 | "body内容为空" | |
details | 是 | string | 返回对应的错误描述 | "Body请求数据为空,没有包含内容" |
返回值示例
请求成功返回值示例
{
"code": 0,
"message": "success",
"result": {
"Color": "绿色",
"Telephone": "189****5828",
"Time": "2022.04.23 20:12:53",
"ReachedCity": ["河北省廊坊市", "重庆市"],
"Notes": "(注:*表示当前该城市存在中风险或高风险地区,并不表示用户实际到访过这些中高风险地区。)",
"RiskAreas": ["重庆市"]
}
}复制
请求失败返回值示例
{
"code": 400003,
"message": "body内容为空",
"details": "Body请求数据为空,没有包含内容"
}复制
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码说明
6 位错误码。4 开头为业务错误码,5 开头为服务错误码。
错误码 | 错误信息 | 错误描述 |
---|---|---|
400003 | body内容为空 | Body请求数据为空,没有包含内容 |
400004 | body请求体非json格式 | body内容需要符合json要求 |
400005 | 请求体类型错误 | 请求体需为字典,不能为其他类型 |
400006 | 必传的参数未传 | 必须的参数('Action'、'ImageData')未传 |
400007 | 传递非法参数 | body字典内有除('Action'、'ImageData')外的参数 |
400008 | 请求体的字段类型错误 | 请求体的字段('Action'、'ImageData')类型错误,类型只能为字符串,不能为其他类型 |
400009 | Action值设置错误 | Action值设置错误 |
400010 | 'ImageData'字段值为空字符 | 'ImageData'字段值为空字符 |
400011 | 'ImageData'字段base64数据处理异常 | 'ImageData'字段的base64字符串转换字节码异常 |
400012 | 请求文件格式不合法 | 仅支持 jpeg/png/jpg/bmp 格式 |
400013 | 图片文件大小不符合要求 | 该文件大小不符合要求,静态图片要求小于7M |
400014 | 图片解码错误 | 字节码解码为图片错误 |
400015 | 图片尺寸不符合要求 | 分辨率长宽尺寸应不高于5000不低于32 |
500001 | 服务接口异常,请联系管理员 | 需要联系管理员处理 |
base64 编码规则:使用常规的 safe base64 编码方式
- python 中推荐使用 base64.urlsafe_b64encode() 函数进行编码。
- java 中推荐使用 BASE64.getUrlEncoder().encodeToString() 函数进行编码。