应用关联的人物名单信息查询
1. 请求
1.1 请求地址
区域 | 请求地址 |
---|---|
国内 | https://api.open.tuputech.com/v3/management/person-library/search/<secretId> |
提示
<secretId>
需替换为您的应用 SID
,请联系客户经理为您开通及配置。关于 SID
详见 常见问题(FAQ)。
1.2 请求方法
POST
1.3 请求头
Content-Type: application/json
1.4 请求参数
参数名称 | 类型 | 是否必需 | 说明 |
---|---|---|---|
timestamp | Int | 是 | 当前的服务器的 Unix 时间戳,可以是毫秒或秒级。 |
nonce | Float | 是 | 随机数(建议使用 Unix 时间戳或若干位随机整数) |
signature | String | 是 |
|
name | String | 否 | 人物名单名称,模糊搜索 |
1.5 请求示例
{
"name": "<name>",
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>"
}
2. 响应
2.1 响应内容
参数名称 | 类型 | 说明 |
---|---|---|
json | String | 响应内容 JSON 转义后的字符串 |
signature | String | 响应内容签名 |
2.2 响应参数
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
code | Int | 否 | 状态码 |
nonce | Float | 否 | 随机数(建议使用 Unix 时间戳或若干位随机整数) |
message | String | 否 | 相关信息 |
timestamp | Int | 否 | 时间戳 |
personLibrary | Array<PersonLibary> | 否 | 名单信息,详见 PersonLibary 说明 |
PersonLibary 说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
id | String | 否 | 人物名单 id |
name | String | 否 | 人物名单名称 |
priority | Int | 否 | 优先级 |
secretIds | Array<String> | 否 | 关联的 secretId |
features | Int | 否 | 关联的特征数 |
2.3 响应示例
{
"code": 0,
"message": "success",
"nonce": 0.24965500730361836,
"personLibrary": [
{
"id": "xxxx",
"name": "测试人物库",
"priority": 1,
"secretIds": ["xxxx", "yyyy"],
"features": 10,
}
],
"timestamp": 1691719001
}