跳到主要内容

更新指定人物名单

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 请求参数

参数名称类型是否必需说明
timestampNumber当前的服务器的 Unix 时间戳,可以是毫秒或秒级。
nonceNumber随机数
signatureString

RSA-SHA256 算法签名。签名步骤:

  1. 将参与签名的参数(secretIdtimestampnonce)用英文半角逗号 , 拼接,得到 SignString
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名,然后进行 Base64 编码,得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsapkcs8 两种格式,通常 Golang,Python 使用 rsa 格式私钥,Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
personLibraryIdString图片名单 ID
nameString人物名单库名称, 当请求中没有该字段时,不修改名单库状态
priorityNumber人物名单优先级, 取值在 1-10, 值越大优先级越低; 当请求中没有该字段时,不修改名单库
secretIdsArray<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 响应内容

参数名称类型说明
jsonString响应内容 JSON 转义后的字符串
signatureString响应内容签名

2.2 响应参数

参数名称类型是否可能为空说明
codeNumber状态码
nonceNumber随机数
messageString相关信息
timestampNumber时间戳
personLibraryObject<PersonLibrary>名单信息,详见 PersonLibrary 说明

PersonLibrary 说明

参数名称类型是否可能为空说明
codeNumber状态码,标识该图片名单库是否更新成功,详见公共服务状态码
errorString错误原因
nameString人物名单库名称
priorityNumber人物名单优先级
secretIdsArray<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 字段描述