更新指定图片名单的属性
1. 请求
1.1 请求地址
区域 | 请求地址 |
---|---|
国内 | https://api.open.tuputech.com/v3/management/image-library/update/<secretId> |
提示
<secretId>
需替换为您的应用 SID
,请联系客户经理为您开通及配置。关于 SID
详见 常见问题(FAQ)。
1.2 请求方法
POST
1.3 请求头
Content-Type: application/json
1.4 请求参数
参数名称 | 类型 | 是否必需 | 说明 |
---|---|---|---|
timestamp | Int | 是 | 当前服务器的 Unix 时间戳,可以是毫秒或秒级。 |
nonce | Float | 是 | 随机数(建议使用 Unix 时间戳或若干位随机整数) |
signature | String | 是 |
|
imageLibraryId | String | 是 | 图片名单 ID |
name | String | 否 | 图片名单库名称, 当请求中没有该字段时,不修改图片名单库状态 |
type | Int | 否 | 图片名单类型(黑、白名单),其中黑名单为 0 , 白名单为 1 ,当请求中没有该字段时,不修改图片名单库状态 |
status | Int | 否 | 状态, 其中开启为 0 ,关闭为 1 ,当请求中没有该字段时,不修改图片名单库状态 |
threshold | Int | 否 | 阈值, 范围 (0,1] ,当请求中没有该字段时,不修改图片名单库状态 |
secretIds | Array<String> | 否 | 名单绑定的应用(SID)数组。 说明: 1. 当该字段不存在(或值为 null/nil )时,不修改名单库绑定的应用; 2. 当该字段不包含当前应用(或值为空数组 [ ] )时,自动填充当前应用;3. 当该字段包含未启用状态的应用时,接口返回参数错误; 4. 该字段中的文本/语音类型应用会被忽略; 5. 若需要禁用当前应用,请关闭或删除该名单; (当前应用指您在接口 URL 中填写的 SID) 示例:假设名单已经绑定了 [A, B, C] 三个应用,其中 A 为当前应用。1. 指定 [A, B] :更新成功后解绑 C ,绑定的应用为 [A, B] ;2. 指定 [B] :更新成功后解绑 C ,绑定的应用为 [A, B] ;3. 指定 [ ] :实际生效的为 [A] ,更新成功后解绑 B, C ,绑定的应用为 [A] |
1.5 请求示例
{
"imageLibraryId": "<imageLibraryId>",
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>",
"name": "<name>"
}
2. 响应
2.1 响应内容
参数名称 | 类型 | 说明 |
---|---|---|
json | String | 响应内容 JSON 转义后的字符串 |
signature | String | 响应内容签名 |
2.2 响应参数
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
code | Int | 否 | 状态码 |
nonce | Float | 否 | 随机数(建议使用 Unix 时间戳或若干位随机整数) |
message | String | 否 | 相关信息 |
timestamp | Int | 否 | 时间戳 |
imageLibrary | Object<ImageLibrary> | 否 | 名单信息,详见 imageLibrary 说明 |
ImageLibrary 说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
code | Int | 否 | 状态码,标识该图片名单库是否更新成功,详见公共服务状态码 |
error | String | 否 | 错误原因 |
name | String | 否 | 图片名单库名称 |
threshold | Int | 否 | 阈值 |
secretIds | Array<String> | 否 | 名单绑定的应用(SID)数组 |
2.3 响应示例
{
"json": "{\"code\":0,\"imageLibrary\":{\"code\":0,\"error\":\"\",\"name\":\"xxx\",\"status\":0,\"threshold\":0.95,\"secretIds\":[\"xxx\"]},\"message\":\"success\",\"nonce\":0.65333554465516,\"timestamp\":1669602627}",
"signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}
3. 更新日志
日期 | 说明 |
---|---|
2024-10-16 | 更新请求中的 secretIds 字段描述 |