更新指定人物名单
1. 请求
1.1 请求地址
区域 | 请求地址 |
---|---|
国内 | https://api.open.tuputech.com/v3/management/person-library/update/<secretId> |
提示
<secretId>
需替换为您的应用 SID
,请联系客户经理为您开通及配置。关于 SID
详见 常见问题(FAQ)。
1.2 请求方法
POST
1.3 请求头
Content-Type: application/json
1.4 请求参数
参数名称 | 类型 | 是否必需 | 说明 |
---|---|---|---|
timestamp | Number | 是 | 当前的服务器的 Unix 时间戳,可以是毫秒或秒级。 |
nonce | Number | 是 | 随机数 |
signature | String | 是 |
|
personLibraryId | String | 是 | 图片名单 ID |
name | String | 否 | 人物名单库名称, 当请求中没有该字段时,不修改名单库状态 |
priority | Number | 否 | 人物名单优先级, 取值在 1-10, 值越大优先级越低; 当请求中没有该字段时,不修改名单库 |
secretIds | Array<String> | 否 | 名单绑定的应用(SID)数组。 说明: 1. 当请求中没有该字段(或值为 null/nil )时,不修改名单库绑定的应用(SID); 2. 当传入一个不包含当前应用(SID)的数组(或空数组 [ ] )时,自动填充当前应用(SID);3. 若包含未启用状态的应用(SID)会返回参数错误; 4. 若需要禁用当前应用(SID),请删除该名单; 5. 不支持绑定文本/语音类型的应用(SID); (当前应用(SID)指您在接口 URL 中填写的 SID) 示例:假设当前名单绑定了 [A, B, C] 三个应用(SID),其中 A 为当前应用(SID)。1. 指定 [A, B] :更新成功后解绑 C ,绑定的应用为 [A, B] ;2. 指定 [B] :更新成功后解绑 C ,绑定的应用为 [A, B] ;3. 指定 [ ] :更新成功后解绑 B, C ,绑定的应用为 [A] |
1.5 请求示例
{
"personLibraryId": "<personLibraryId>",
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>",
"name": "<name>"
}
2. 响应
2.1 响应内容
参数名称 | 类型 | 说明 |
---|---|---|
json | String | 响应内容 JSON 转义后的字符串 |
signature | String | 响应内容签名 |
2.2 响应参数
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
code | Number | 否 | 状态码 |
nonce | Number | 否 | 随机数 |
message | String | 否 | 相关信息 |
timestamp | Number | 否 | 时间戳 |
personLibrary | Object<PersonLibrary> | 否 | 名单信息,详见 PersonLibrary 说明 |
PersonLibrary 说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
code | Number | 否 | 状态码,标识该图片名单库是否更新成功,详见公共服务状态码 |
error | String | 否 | 错误原因 |
name | String | 是 | 人物名单库名称 |
priority | Number | 是 | 人物名单优先级 |
secretIds | Array<String> | 是 | 名单绑定的应用(SID)数组 |
2.3 响应示例
{
"code": 0,
"personLibrary": {
"code": 0,
"error": "",
"name": "xxx",
"status": 0,
"priority": 1,
"secretIds": [
"xxx"
]
},
"message": "success",
"nonce": 0.65333554465516,
"timestamp": 1669602627
}
3. 更新日志
日期 | 说明 |
---|---|
2024-10-16 | 更新请求中的 secretIds 字段描述 |