接入文档
人脸搜索(海外版)
API接入
查询人脸列表
查询人脸列表
# 描述
此接口提供查询所有存在的人脸名称列表功能。
# 调用URL:
https://api-sgp.yljz.com/finauth/search/group/list_cursor
注意:在生产环境中,请使用HTTPS的通信方式。HTTP方式的通信属于不安全链路,存在安全风险,请勿在生产环境中使用。在生产环境中使用HTTP方式的,将无法得到服务可靠性保障。
# 调用方法
POST 注意:用form-data格式请求
# 请求参数
| 是否必选 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 必选 | sign | String | 签名生成规则参考鉴权说明 |
| 必选 | sign_version | String | 签名算法版本,请传递:hmac_sha1 |
| 必选 | group_id | String | 用户自定义的人脸库标识 |
| 可选 | cursor | String | 开始时的游标,传入后从当前游标向下进行查询N条,如果不传入,系统将会默认从该人脸库的第一条开始查询 |
| 可选 | limit | Int | 限制个数最大上限 默认值为 100。 最大 1000。 |
# 返回值说明
API返回的为一个JSON字符串。
| 字段 | 类型 | 说明 |
|---|---|---|
| request_id | String | 用于区分每一次请求的唯一的字符串。 |
| time_used | Int | 整个请求所花费的时间,单位为毫秒。 |
| face_tokens |
Array | face_token的数组 注:如果该人脸库下没有 face_token,则返回空数组。 |
| -- face_token | string | 人脸唯一token |
| -- user_id | string | 用户id |
| -- user_data | string | 用户信息 |
| -- add_time | string | 添加时间,毫秒时间戳 |
| next_cursor | string | 游标 |
| has_more | string | 如果返回为false,代表已经查完,不需要再进行查询了 |
| error | String | 当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在。 |
返回值示例
正确请求返回示例
"request_id": "1783655190,12493042-a443-482d-adaf-1bc12ef1450e",
"time_used": 178,
"face_tokens": [
{
"face_token": "75932a4a4b090b7c0a87b9452de2e0ff",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1783653968086
},
{
"face_token": "6e1f617325fef1c5ca1e538beba3c59a",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1783654676716
},
{
"face_token": "bfff09553f3700a1aadeea91d1d92ac5",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1783654692663
},
{
"face_token": "d424506e339748c7f23b15d75cfe3de1",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1783654696705
},
{
"face_token": "1e172d662d97cfb2672ec186cd213b66",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1783654715062
}
],
"next_cursor": "",
"has_more": false
}
错误返回示例
{
"request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
"time_used": 15,
"error": "INVALID_GROUP_ID"
}