功能介绍

识别名片图片上的文字信息，并以json格式返回识别的结构化结果。支持对多种不同版式名片进行结构化信息提取。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。

图1 名片识别示例图

调试

您可以在API Explorer中调试该接口。

前提条件

在使用名片识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见申请服务和认证鉴权章节。

URI

POST https://{endpoint}/v2/{project_id}/ocr/business-card

请求参数

响应参数

根据识别的结果，可能有不同的HTTP响应状态码（status code），状态码和响应参数说明如下。

状态码： 200

状态码： 400

请求示例

• “endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。

  例如，名片识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/business-card”，“project_id”为项目ID，获取方法请参见获取项目ID

• 如何获取Token具体操作请参见构造请求。

• 请求样例（方式一：使用图片的base64编码）

  POST https://{endpoint}/v2/{project_id}/ocr/business-card
   
  Request Header:   
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
  {
      "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
  }

• 请求样例（方式二：使用图片URL）

  POST https://{endpoint}/v2/{project_id}/ocr/business-card
   
  Request Header:   
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
  {
      "url":"https://BucketName.obs.xxxx.com/ObjectName"
  }

• Python3语言请求代码示例（其他语言参照下列示例编写或使用OCR SDK）

  # encoding:utf-8
  
  import requests
  import base64
  
  url = "https://{endpoint}/v2/{project_id}/ocr/business-card"
  token = "用户获取得到的实际token值"
  headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
  
  imagepath = r'./data/business-card-demo.png'
  with open(imagepath, "rb") as bin_data:
      image_data = bin_data.read()
  image_base64 = base64.b64encode(image_data).decode("utf-8")  # 使用图片的base64编码
  payload = {"image": image_base64} # url与image参数二选一
  response = requests.post(url, headers=headers, json=payload)
  print(response.text)

响应示例

状态码：200

成功响应示例

{
    "result": {
        "name": ["XX"],
        "title": ["销售总监"],
        "company": ["XX有限公司"],
        "department": ["XX产品部"],
        "phone": ["+XX XXX XXXX XXXX","XXXX XXXXXXXXX"],
        "address": ["XXXX"],
        "email": ["XX"],
        "fax": ["XXXX XXXXXXXX"],
        "postcode": [],
        "website": ["XX"],
        "extra_info_list": [
            {
                "item": "bank",
                "value": "XXXXXXXXXXXXXXX",
                "note": ["张三","XX"]
            }
        ]
    }
}

状态码：400

失败响应示例

{
    "error_code": "AIS.0103", 
    "error_msg": "The image size does not meet the requirements."
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。