# 查询人脸核身任务状态
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:queryIcpVerifyTask
该接口用于查询人脸核身任务的状态和结果。流程可参考服务商代备案指引或服务商代认证及备案介绍。
使用过程中如遇到问题,可在开放平台服务商专区发帖交流
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/icp/query_icp_verifytask?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:18、156
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| task_id | string | 是 | 人脸核身任务id,示例值:`"R5PqRPNb6GmG3i0rqd4pTg"` |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| is_finish | boolean | 人脸核身任务是否已完成 |
| face_status | number | 任务状态枚举:0. 未开始;1. 等待中;2. 失败;3. 成功。返回的 `is_finish` 字段为 `true` 时,`face_status` 才是最终状态。 |
| along_with_auth_result | number | 发起时 `along_with_auth` 填 `true` 时有效:9. 认证短信核验通过。 |
# 4. 注意事项
- 应先判断
is_finish字段,如果为true,表明人脸核身任务已完成,face_status已到达最终状态,不会再变化。
# 5. 代码示例
请求示例
{
"task_id": "R5PqRPNb6GmG3i0rqd4pTg"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"is_finish": true,
"face_status": 3
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 0 | ok | ok |
| 1 | code过期或不存在 | |
| 86328 | 无法找到资源 | 无法找到资源 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。