1. 接口说明

名片识别,通过全球领先的OCR(光学字符识别 Optical Character Recognition)技术,对纸质名片进行识别,返回名片上的姓名、手机、电话、公司、部门、职位、传真、邮箱、网站、地址等关键信息,可以省去用户手动录入的过程,自动完成名片信息的结构化和数据的采集,可以很方便对接客户的后台数据系统,给用户带来极大的便利。该名片识别接口支持中文(简体和繁体)名片、英文名片,接口可以自动识别名片语种。

2. 接口地址

  1. POST http[s]://webapi.xfyun.cn/v1/service/v1/ocr/business_card HTTP/1.1
  2. Content-Type:application/x-www-form-urlencoded; charset=utf-8

3. 请求参数

在 Http Request Header 中配置授权认证参数,见【接口描述-授权认证】。其中 X-Param 为各配置参数组成的JSON串经BASE64编码之后的字符串,原始JSON串各字段说明如下:

参数类型必须说明示例
engine_typestring引擎类型,固定为business_cardbusiness_card
pic_requiredstring是否返回切边增强图像。当为”1“时返回,当省略或为其他值时不返回。返回的json结果中切边增强图片数据格式详见返回值说明。1
imeistring手机序列号12345678
osidstring操作系统版本Android
uastring厂商|全称|机型信息|操作系统版本|分辨率vivo|vivoY67L|PD1612|ANDROID6.0|720*1280

X-Param生成示例:

  1. 原始JSON串:
  2. {
  3. "engine_type": "business_card"
  4. }
  5. BASE64编码(即X-Param):
  6. eyJlbmdpbmVfdHlwZSI6ICJidXNpbmVzc19jYXJkIn0=

在 Http Request Body 中配置以下参数:

参数类型必须说明示例
imagestring图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,仅支持jpg格式,推荐 jpg 文件设置为:尺寸 1024×768,图像质量 75 以上,位深度 24。exSI6ICJlbiIsCgkgICAgInBvc2l0aW9uIjogImZhbHNlIgoJf…

_注:_base64编码后大小会增加约1/3

4. 返回值

返回值为json串,各字段如下:

参数类型说明
codestring结果码(具体见错误码)
datajson详见data说明
descstring描述
sidstring会话ID
biz_card_picstring名片切边增强图像,jpg/jpeg格式,二进制数据Base64编码(使用前注意解码)

其中sid字段主要用于追查问题,如果出现问题,可以提供sid给讯飞技术人员帮助确认问题。

data各字段说明如下:

参数说明
formatted_name显示完整姓名
name一个结构化的表示形式,表示人的姓氏,名字或其他信息
address一个结构化的标示形式,表示物理地址
label个人或对象的物理邮件投递或交付地址
telephone电话号码,电话通信的规范数字字符串
email电子邮件通讯地址
title代表个人在公司或组织内的职位,职能或其他相关属性
role包含了个人在组织内的职业,业务或部门类别的信息
organization单位或组织的可选名称
comment在 JSON 格式中包含的其他注释或补充信息
url包含一个URL的值
sns社交帐户,例如微信
im及时聊天帐户,例如 QQ

每一个参数的赋值都是一个 JSON 的数组,数组包含了与这个键值相关的对象或字符串的值。对象含有两个键值:item 和 position。Item 的值是一个 JSON 对象或字符串。Position的值是一个字符串,表示这个属性在名片上的矩形位置。

示例如下:

失败:

  1. {
  2. "code": "10106",
  3. "desc": "invalid parameter|invalid X-Appid",
  4. "data": "",
  5. "sid": "wcr0000bb3f@ch3d5c059d83b3477200"
  6. }

成功

  1. {
  2. "biz_card_pic":"...the Base64 encoded pic data, too long to show....",
  3. "code": "0",
  4. "data": {
  5. "address": [{
  6. "item": {
  7. "country": "中国",
  8. "locality": "合肥",
  9. "street": "望江西路666号",
  10. "type": ["work"]
  11. },
  12. "position": "923,884,2373,884,2373,978,923,978"
  13. }],
  14. "email": [{
  15. "item": "lisi@iflytek.com",
  16. "position": "925,754,1809,754,1809,845,925,845"
  17. }],
  18. "formatted_name": [{
  19. "item": "李四",
  20. "position": "1687,1527,2074,1527,2074,1651,1687,1651"
  21. }],
  22. "label": [{
  23. "item": {
  24. "address": "安徽省合肥市高新区望江西路666号讯飞大厦",
  25. "type": ["work"]
  26. },
  27. "position": "923,884,2373,884,2373,978,923,978"
  28. }],
  29. "name": [{
  30. "item": {
  31. "family_name": "李",
  32. "given_name": "四"
  33. },
  34. "position": "0,0,0,0,0,0,0,0"
  35. }],
  36. "organization": [{
  37. "item": {
  38. "name": "科大讯飞股份有限公司"
  39. },
  40. "position": "686,1004,1809,1004,1809,1092,686,1092"
  41. }],
  42. "rotation_angle": "0",
  43. "telephone": [{
  44. "item": {
  45. "number": "18888888888",
  46. "type": ["cellular", "voice"]
  47. },
  48. "position": "3146,773,3757,773,3757,858,3146,858"
  49. }, {
  50. "item": {
  51. "number": "02155663009p8021",
  52. "type": ["work", "voice"]
  53. },
  54. "position": "2917,895,3746,895,3746,981,2917,981"
  55. }, {
  56. "item": {
  57. "number": "4006083063",
  58. "type": ["work", "voice"]
  59. },
  60. "position": "3114,648,3762,648,3762,736,3114,736"
  61. }],
  62. "title": [{
  63. "item": "技术支持经理",
  64. "position": "2129,1527,2607,1527,2607,1651,2129,1651"
  65. }],
  66. "url": [{
  67. "item": "www.iflytek.com",
  68. "position": "917,637,1586,637,1586,721,917,721"
  69. }]
  70. },
  71. "desc": "success",
  72. "sid": "wcr00000004@dx11730e797d37000100"
  73. }

5. 调用示例

名片识别demo go语言

名片识别demo php语言

名片识别demo python3语言

名片识别demo java语言

名片识别demo c#语言

Copyright © iflytek.com 2018 all right reserved,powered by Gitbook该文件修订时间:2019-05-07 07:12:51