产品文档

名片识别

名片

描述

名片

请求方式

POST

请求地址

apl
https://aiapi.jdcloud.com/jdai/ai_businessCardRecognition

请求参数

header请求参数

名称 类型 是否必需 示例值 描述
Content-Type String application/json json格式

body请求参数

名称 类型 是否必需 示例值 描述
serialNo String 请求流水号, 不传接口自动生成
imageItem Object {"imgType": "DL","encryptionType": "NON","imgBase64": "xxxx"} 图片信息
+imgType enum DL 图片的类型 SFF("采集照"),FF("全景采集照"),NIR("双目采集的近红外照片"),DEEP("深度采集的照片"),IDP("身份证正面"),IDN("身份证反面"),MP("网纹照"),AP("动作照"),VL("行驶证"),DL("驾驶证"),BC("银行卡"),BL("营业执照"),LP("车牌"),COM("通用图片
+imgBase64 String DL /9j/4AAQSkZJRgABAQAAAQABAA...
+filename String 图片的存储名, 指定了则不读base64
+imgUrl String 图片的Url地址(外网地址可能会有socket连接超时问题,建议传base64)
+imgArr byte[ ] 图片的二进制
+encryptionType enum NON 加密方式 AKS,LICENSE,NON AKS解密方式:com.wangyin.key.server.DeviceCryptoService#decryptEnvelop 版本号1.5.3
extMap map 附加信息, 特殊需求处理

返回实体

公共返回参数

名称 类型 示例值 描述
code string 1000 参见下方错误码-系统级错误码
charge boolean false 或 true false:不扣费, true:扣费
remainTimes long 1305 剩余调用次数;免费api:每天剩余调用次数;收费api:剩余次数;无限制时为-1
remainSeconds long 1223456 剩余调用时间(s);免费api:-1;收费api:剩余调用时间;无限制时为-1
msg String 查询成功 参见下方错误码-系统级错误码
result object {...} 业务返回参数

业务返回参数

参数名称 参数类型 是否必填 参数说明
code int Y 返回code码0:成功
msg String N msg
serialNo String N 交互的流水号
businessCardInfo Object N 名片识别结果
+name String N 姓名
+email String N 邮箱
+mobile String N 手机号 可能会有多个,以;作为分割符号
+title String N 职位
+company String N 公司名称 可能会有多个,以;作为分割符号
+address String N 公司地址
+tel String N 电话号码 可能会有多个,以;作为分割符号
+department String N 部门
+url String N 公司网址
+postalCode String N 邮编
+nameEn String N 英文姓名
+companyEn String N 英文公司
+addressEn String N 英文地址
+departmentEn String N 英文部门
+generalResults List N 未结构化的结果

请求参数示例

{
	"imageItem": {
		"imgType": "COM",
		"imgBase64":"",
		"encryptionType": "NON"
	}
}

返回样例

{
    "code":"",
    "charge":"",
    "msg":"",
    "result":{
        "code":0,
        "msg":"成功",
        "serialNo":"12092873283-2313",
        "businessCardInfo":{
            "name":"丁xx",
            "email":"dingxxxl@163.com",
            "mobile":"+86-xxxxx",
            "title":"总经理",
            "company":"xxxxxx",
            "address":"xxxxxx",
            "tel":"'0510-xxxxxxx",
            "department":"xxxx",
            "url":"xxxx",
            "postalCode":"xxxxxx",
            "nameEn":"xxxx",
            "companyEn":"xxxx",
            "addressEn":"xxxxx",
            "departmentEn":"xxxxxx",
            "generalResults":[
                "加期明",
                "xxx",
                "xxx"
            ]
        },
        "timestamp":1618381882201
    }
}


更新时间:2022-03-18 20:07:46
feedback