接入文档
人脸搜索(海外版)
API接入
获取人脸库中人脸列表
获取人脸库中人脸列表
# 描述
此接口提供查询所有存在的人脸名称列表功能。
调用URL:
https://api-sgp.yljz.com/finauth/seach/group/list
# 请求参数
| 是否必选 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 必选 | sign | String | 调用此API客户的签名,具体的签名产生方式请查阅”鉴权说明“文档 |
| 必选 | sign_version | String | 签名算法版本,请传递:hmac_sha1 |
| 必选 | group_id | String | 用户自定义的人脸库标识 |
| 可选 |
start |
Int | 一个数字 n,表示开始返回的 face_token 在本 FaceSet 中的序号, n 是 [1,1000] 间的一个整数。 通过传入数字 n,可以控制本 API 从第 n 个 face_token 开始返回。返回的 face_token 按照创建时间排序,每次返回 100 个 face_token。 默认值为 1。 您可以输入上一次请求本 API 返回的 next 值,用以获得接下来的 100 个 face_token。 |
| 可选 | limit | Int | 限制个数最大上限 默认值为 100。 最大 1000。 |
# 返回值说明
API返回的为一个JSON字符串。
| 字段 | 类型 | 说明 |
|---|---|---|
| face_tokens |
Array | face_token的数组 注:如果该人脸库下没有 face_token,则返回空数组。 |
| face_token | string | 人脸唯一token |
| user_id | string | 用户id |
| user_data | string | 用户信息 |
| add_time | string | 添加时间,毫秒时间戳 |
| time_used | Int | 整个请求所花费的时间,单位为毫秒。 |
| request_id | String | 用于区分每一次请求的唯一的字符串。 |
| error | String | 当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在。 |
返回值示例
正确请求返回示例
{
"request_id": "1769742249,b0513d34-fcf4-490b-b9c7-634db3cbc590",
"time_used": 74,
"face_tokens": [
{
"face_token": "9eab9fe14a402295fb78409a81abfc3c",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1769739690208
},
{
"face_token": "dfe27a204b48e06e8f1ae712d39515d6",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1769741642666
},
{
"face_token": "ced18ec4ff9c37a7d159cda466224047",
"user_id": "user_01",
"user_data": "测试用户",
"add_time": 1769741643344
}
]
}
错误返回示例
{
"request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
"time_used": 15,
"error": "INVALID_GROUP_ID"
}