查询人物信息
1. 请求
1.1 请求地址
区域 | 请求地址 |
---|---|
国内 | https://api.open.tuputech.com/v3/management/person/overview/<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 | 否 | 图片名称,模糊搜索 |
page | Int | 否 | 第几页, 从 1 开始, 默认为 1 |
limit | Int | 否 | 返回条目数限制, 默认为 10 , 最大为 99 |
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 | 否 | 时间戳 |
hasNext | Boolean | 否 | 是否存在下一页 |
total | Int | 否 | 人物总数 |
person | Array<Person> | 否 | 人物信息,详见 Person 参数说明 |
Person 参数说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
name | String | 否 | 人物名称 |
personId | String | 否 | 人物 id |
operator | time | 否 | 操作账户 |
createTime | time | 否 | 创建时间 |
updateTime | time | 否 | 更新时间 |
2.3 响应示例
{
"code": 0,
"hasNext": false,
"message": "success",
"nonce": 0.9631394012024704,
"person": [
{
"personId": "xxx",
"name": "xxx",
"operator": "1@xx.com",
"createTime": "2023-07-19T10:48:30.770Z",
"updateTime": "2023-07-19T10:48:30.770Z"
}
],
"timestamp": 1691720759,
"total": 1
}