新增图片名单
1. 请求
1.1 请求地址
区域 | 请求地址 |
---|---|
国内 | https://api.open.tuputech.com/v3/management/image-library/create/<secretId> |
提示
<secretId>
需替换为您的应用 SID
,请联系客户经理为您开通及配置。关于 SID
详见 常见问题(FAQ)。
1.2 请求方法
POST
1.3 请求头
Content-Type: application/json
1.4 请求参数
参数名称 | 类型 | 是否必需 | 说明 |
---|---|---|---|
timestamp | Number | 是 | 当前服务器的 Unix 时间戳,可以是毫秒或秒级。 |
nonce | Number | 是 | 随机数 |
signature | String | 是 |
|
name | String | 是 | 图片名单库名称 |
type | Number | 否 | 图片名单类型(黑、白名单) , 其中黑名单为 0 , 白名单为 1 , 默认为黑名单 |
status | Number | 否 | 状态, 其中开启为 0 , 关闭为 1 , 默认为开启 |
threshold | Number | 否 | 阈值, 范围 (0,1] , 默认为 0.95 |
secretIds | Array<String> | 否 | 名单库绑定的应用(SID)数组。 1. 当该字段不存在(或值为 null/nil )时,默认绑定当前应用;2. 当该字段不包含当前应用(或值为空数组 [ ] )时,自动填充当前应用; 3. 当该字段包含未启用状态的应用时,接口返回参数错误; 4. 该字段中的文本/语音类型应用会被忽略; (当前应用指您在接口 URL 中填写的 SID) |
1.5 请求示例
{
"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 | 否 | 时间戳 |
imageLibrary | Object<ImageLibrary> | 否 | 名单信息,详见 imageLibrary 说明 |
ImageLibrary 说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
id | String | 否 | 图片名单库 id |
name | String | 否 | 图片名单名称 |
type | String | 否 | 图片名单类型 |
threshold | String | 否 | 阈值 |
status | String | 否 | 状态 |
images | String | 否 | 图片数量 |
2.3 响应示例
{
"json": "{\"code\":0,\"imageLibrary\":{\"id\":\"xxxxxxx\",\"name\":\"xxxxxx\",\"type\":1,\"threshold\":0.95,\"status\":0,\"images\":0},\"message\":\"success\",\"nonce\":0.7289184339313061,\"timestamp\":1669602214}",
"signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}