跳到主要内容

更新指定人物名单

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是随机数，建议是 [0-1] 之间的小数，如：0.1527317095951506。
signatureString是

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

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
personLibraryIdString是图片名单 ID
nameString否人物名单库名称, 当请求中没有该字段时，不修改名单库状态
priorityNumber否人物名单优先级， 取值在 1-10， 值越大优先级越低; 当请求中没有该字段时，不修改名单库
secretIdsArray<String>否1. 当请求中没有该字段时，不修改名单库绑定的应用（SID）;
2. 不支持解绑当前 secretId，即传入一个空的数组时，不修改名单库绑定的应用（SID） ;
3. 当传入一个不包含当前 secretId 的数组时，自动填充当前应用（SID）；
4. 不支持绑定未开启的应用（SID）;
5. 不支持绑定文本/语音类型的应用（SID）；

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
}