请求方式:POST (HTTPS)
请求地址:
https://open.welink.huaweicloud.com/api/aiservice/v1/ocr/business-card
认证方式: access_token,请参考获取access_token
请求头部:
Content-Type: application/json
x-wlk-Authorization: access_token
请求参数
{
"image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
}
请求参数说明
参数 | 必填 | 参数类型 | 说明 |
---|---|---|---|
image | 是 | String | 图像数据,base64编码,要求base64编码后大小不超过10M。图片最小边不小于15像素,最长边不超过8000像素。支持JPG/PNG/BMP/TIFF格式。 |
detectDirection | 否 | Boolean | 为Boolean类型,若不传该字段,默认不检测图像倾斜角度文字方向,为True时,会检测倾斜角度并矫正识别。 |
returnAdjustedImage | 否 | Boolean | 返回矫正后的名片图像的BASE64编码的开关,可选值包括: true:返回BASE64编码; false:不返回BASE64编码。 未传入该参数时默认为false,即不返回BASE64编码。 |
请求示例
curl -X POST \
'https://open.welink.huaweicloud.com/api/aiservice/v1/ocr/business-card' \
-H 'Accept-Charset: UTF-8' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{"image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."}'
响应格式说明
返回结果 正常返回结果
{
"code": "0",
"data": {
"name": [
"张三"
],
"title": [
"销售总监"
],
"company": [
"华为技术有限公司"
],
"department": [
"华为云EI服务产品部"
],
"phone": [
"+86 189 2221 5230",
"0755 545353232"
],
"address": [
"深圳市坂田华为基地"
],
"email": [
"zhangsan@huawei.com"
],
"fax": [
"0755 66542642"
],
"postcode": [],
"website": [
"www.huaweicloud.com"
],
"extra_info_list": [
{
"item": "qq",
"value": "24242523",
"note": []
},
{
"item": "qq",
"value": "54363654",
"note": []
},
{
"item": "wechat",
"value": "13425642564",
"note": []
},
{
"item": "alipay",
"value": "54454@qq.com",
"note": [
"张三"
]
},
{
"item": "bank",
"value": "6217866200004973114",
"note": [
"张三",
"农行"
]
},
{
"item": "bank",
"value": "6217866200004973114",
"note": [
"张三",
"工行"
]
}
]
},
"error": "",
"message": "ok"
}
异常返回结果
OCR识别失败响应示例
{ "code": "58105", "data": null, "error": "Recognize Failed", "message": "OCR service call exception" }
Token验证失败响应示例
{ "code": "58401", "data": null, "error": "Failed to verify the token.", "message": "Login authentication failed." }
返回参数说明
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
code | 是 | String | 错误码 |
message | 是 | String | 调用成功时为"ok"。调用失败时的错误信息。 |
data | 是 | Object | 调用成功时表示调用结果,详见data数据结构。调用失败时为null。 |
error | 是 | String | 错误信息。 |
- data 数据结构
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
name | 是 | Array [String] | 为姓名列表 |
title | 是 | Array [String] | 职位头衔列表 |
company | 是 | Array [String] | 公司列表 |
department | 是 | Array [String] | 部门列表 |
phone | 是 | Array [String] | 联系方式列表 |
address | 是 | Array [String] | 地址列表 |
是 | Array [String] | 邮箱列表 | |
fax | 是 | Array [String] | 传真列表 |
postcode | 是 | Array [String] | 邮编列表 |
website | 是 | Array [String] | 公司网址列表 |
extra_info_list | 是 | Array [extra_info] | 其余信息列表,详见extra_info数据结构 |
adjusted_image | 否 | String | 返回矫正后的名片图像的BASE64编码 |
- extra_info 数据结构
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
item | 是 | String | 表示key值,可能是qq, wechat, alipay及bank等 |
value | 是 | String | 表示value值,对应qq, wechat, alipay及bank等的账号 |
note | 是 | Array [String] | 对应item关联的额外信息,为bank时第一个默认为户名,第二个为开户行,为alipay时第一个默认为账号名 |
错误码说明
错误码 | 说明 |
---|---|
0 | 成功。 |
58401 | 无权限。 |
58402 | 非法参数异常。 |
58500 | 服务异常。 |
58001 | OCR服务异常。 |