功能描述
提交一个卡证识别任务。
授权说明
同时,还需要授予
cam:PassRole
权限用于传递角色,便于异步处理接口能够通过 CAM 的“角色”进行 COS 的资源读写操作。服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用限制
费用说明
请求
请求示例
POST /jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
请求头
请求体
该请求操作的实现需要有如下请求体。
<Request><Tag>ImageLicenseRec</Tag><Input><Object>input/test.doc</Object></Input><Operation><ImageLicenseRec><CardType>IDCard</CardType></ImageLicenseRec><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
具体的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:ImageLicenseRec | String | 是 |
Input | Request | 待操作的对象信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件路径 | String | 是 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
ImageLicenseRec | Request.Operation | 卡证识别配置 | Container | 是 |
UserData | Request.Operation | 透传用户信息,可打印的 ASCII 码,长度不超过1024 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0 | String | 否 |
Container 类型 ImageLicenseRec 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
CardType | Request.Operation.ImageLicenseRec | 卡证识别类型,取值为: IDCard 表示身份证识别 DriverLicense 表示驾驶证 | string | 是 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><JobsDetail><Code>Success</Code><Message/><JobId>ac7c990a00bf211ed946af9e0691f2b7a</JobId><State>Submitted</State><CreationTime>2022-06-27T14:44:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId><Tag>ImageLicenseRec</Tag><Input><BucketId>test-123456789</BucketId><Object>input/test.jpg</Object><Region>ap-chongqing</Region></Input><Operation><ImageLicenseRec><CardType>IDCard</CardType></ImageLicenseRec><ImageLicenseRecResult><Code>Success</Code><State>Success</State><InputObjectName>input/test.jpg</InputObjectName><InputObjectUrl>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/test.jpg</InputObjectUrl><Status>1</Status><IdInfo><Name>姓名</Name><DetectedText>xxx</DetectedText><Score>99</Score><Location><Point>553,439</Point><Point>553,576</Point><Point>989,576</Point><Point>989,439</Point></Location></IdInfo><IdInfo><Name>性别</Name><DetectedText>男</DetectedText><Score>98</Score><Location><Point>541,597</Point><Point>541,723</Point><Point>798,723</Point><Point>798,597</Point></Location></IdInfo><IdInfo><Name>民族</Name><DetectedText>汉</DetectedText><Score>98</Score><Location><Point>1032,599</Point><Point>1032,725</Point><Point>1265,725</Point><Point>1265,599</Point></Location></IdInfo><IdInfo><Name>出生(日期)</Name><DetectedText>1974年12月1日</DetectedText><Score>99</Score><Location><Point>532,748</Point><Point>532,906</Point><Point>1346,906</Point><Point>1346,748</Point></Location></IdInfo><IdInfo><Name>住(地)址</Name><DetectedText>湖南省xxxxx</DetectedText><Score>99</Score><Location><Point>534,931</Point><Point>534,1253</Point><Point>1587,1253</Point><Point>1587,931</Point></Location></IdInfo><IdInfo><Name>公民身份证号(证号)</Name><DetectedText>43xxxx</DetectedText><Score>99</Score><Location><Point>842,1372</Point><Point>842,1615</Point><Point>2284,1615</Point><Point>2284,1372</Point></Location></IdInfo><ImageLicenseRecResult><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
JobsDetail | Response | 任务的详细信息 | Container |
Container 节点 JobsDetail 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Code | Response.JobsDetail | 错误码,当 State 为 Failed 时错误码生效 | String |
Message | Response.JobsDetail | 错误描述,当 State 为 Failed 时错误描述生效 | String |
JobId | Response.JobsDetail | 新创建任务的 ID | String |
Tag | Response.JobsDetail | 新创建任务的 Tag:ImageOCR | String |
State | Response.JobsDetail | 任务的状态,为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个 | String |
CreationTime | Response.JobsDetail | 任务的创建时间 | String |
StartTime | Response.JobsDetail | 任务的开始时间 | String |
EndTime | Response.JobsDetail | 任务的结束时间 | String |
QueueId | Response.JobsDetail | 任务所属的队列 ID | String |
Input | Response.JobsDetail | 同请求中的 Request.Input 节点 | Container |
Operation | Response.JobsDetail | 该任务的规则 | Container |
Container 节点 Operation 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
ImageLicenseRec | Response.JobsDetail.Operation | 同请求中的 Request.Operation.ImageLicenseRec | Container |
ImageLicenseRecResult | Response.JobsDetail.Operation | 卡证识别结果 | Container |
UserData | Response.JobsDetail.Operation | 透传用户信息 | String |
JobLevel | Response.JobsDetail.Operation | 任务优先级 | String |
Container 节点 ImageLicenseRecResult 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
State | Response.JobsDetail.Operation.ImageLicenseRecResult | 当前节点的任务状态,为 Success、Failed 其中一个 | Container |
Code | Response.JobsDetail.Operation.ImageLicenseRecResult | 错误码,当 State 为 Failed 时错误码生效 | Container |
Message | Response.JobsDetail.Operation.ImageLicenseRecResult | 错误描述,当 State 为 Failed 时错误描述生效 | Container |
InputObjectName | Response.JobsDetail.Operation.ImageLicenseRecResult | 当前节点的输入对象名 | String |
InputObjectUrl | Response.JobsDetail.Operation.ImageLicenseRecResult | 当前节点的输入对象 Url | String |
Status | Response.JobsDetail.Operation.ImageLicenseRecResult | 卡证识别结果 1:识别到结果 0:未识别到结果 | String |
IdInfo | Response.JobsDetail.Operation.ImageLicenseRecResult | 卡证识别信息 | Container |
Container 节点 IdInfo 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Name | Response.JobsDetail.Operation.ImageLicenseRecResult.IdInfo | 字段的名称 | String |
Score | Response.JobsDetail.Operation.ImageLicenseRecResult.IdInfo | 字段的置信度,取值范围为[0-100],值越高概率越大 | Interger |
Location | Response.JobsDetail.Operation.ImageLicenseRecResult.IdInfo | 字段的坐标 | Container |
DetectedText | Response.JobsDetail.Operation.ImageLicenseRecResult.IdInfo | 字段内容 | String |
Container 节点 Location 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Point | Response.JobsDetail.Operation.ImageLicenseRecResult.IdInfo.Location | 坐标点(X 坐标,Y 坐标) | String |
错误码
实际案例
请求
POST /jobs HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host: test-1234567890.ci.ap-beijing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>ImageLicenseRec</Tag><Input><Object>input/test.jpg</Object></Input><Operation><ImageLicenseRec><CardType>IDCard</CardType></ImageLicenseRec><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message/><JobId>ac7c990a00bf211ed946af9e0691f2b7a</JobId><State>Submitted</State><CreationTime>2022-06-27T14:44:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId><Tag>ImageLicenseRec</Tag><Input><BucketId>test-123456789</BucketId><Object>input/test.jpg</Object><Region>ap-chongqing</Region></Input><Operation><ImageLicenseRec><CardType>IDCard</CardType></ImageLicenseRec><ImageLicenseRecResult><Code>Success</Code><State>Success</State><InputObjectName>input/test.jpg</InputObjectName><InputObjectUrl>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/test.jpg</InputObjectUrl><Status>1</Status><IdInfo><Name>姓名</Name><DetectedText>xxx</DetectedText><Score>99</Score><Location><Point>553,439</Point><Point>553,576</Point><Point>989,576</Point><Point>989,439</Point></Location></IdInfo><IdInfo><Name>性别</Name><DetectedText>男</DetectedText><Score>98</Score><Location><Point>541,597</Point><Point>541,723</Point><Point>798,723</Point><Point>798,597</Point></Location></IdInfo><IdInfo><Name>民族</Name><DetectedText>汉</DetectedText><Score>98</Score><Location><Point>1032,599</Point><Point>1032,725</Point><Point>1265,725</Point><Point>1265,599</Point></Location></IdInfo><IdInfo><Name>出生(日期)</Name><DetectedText>1974年12月1日</DetectedText><Score>99</Score><Location><Point>532,748</Point><Point>532,906</Point><Point>1346,906</Point><Point>1346,748</Point></Location></IdInfo><IdInfo><Name>住(地)址</Name><DetectedText>湖南省xxxxx</DetectedText><Score>99</Score><Location><Point>534,931</Point><Point>534,1253</Point><Point>1587,1253</Point><Point>1587,931</Point></Location></IdInfo><IdInfo><Name>公民身份证号(证号)</Name><DetectedText>43xxxx</DetectedText><Score>99</Score><Location><Point>842,1372</Point><Point>842,1615</Point><Point>2284,1615</Point><Point>2284,1372</Point></Location></IdInfo><ImageLicenseRecResult><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>