跳到主要内容

更新指定文本名单的属性

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/thesaurus/update/<secretId>
提示

<secretId> 需替换为您的应用 SID，请联系客户经理为您开通及配置。关于 SID 详见 常见问题（FAQ）。

1.2 请求方法​

POST

1.3 请求头​

请求头名称取值是否必需示例说明
Content-Typeapplication/json是Content-Type: application/json请求数据类型为 JSON
X-API-Key<API Key>是X-API-Key: <API Key>API Key 用于接口鉴权。请访问控制台 - 数字证书 获取 API Key

1.4 请求参数​

参数名称类型是否必需说明
thesaurusIdString是文本名单 ID
nameString否文本名单库名称
labelString否文本名单一级标签，详见 label 说明
subLabelString否文本名单一级标签，英文
statusString否状态，其中开启为 0，关闭为 1，默认为开启
secretIdsArray<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]
timestampInt否当前服务器的 Unix 时间戳。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
nonceFloat否随机数（建议使用 Unix 时间戳或若干位随机整数）。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
signatureString否

RSA-SHA256 算法签名。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权。

签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例

1.5 请求示例​

{
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>",
  "thesaurusId": "<thesaurusId>",
  "label": "ADs"
}

2. 响应​

2.1 响应内容​

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

2.2 响应参数​

参数名称类型是否可能为空说明
codeInt否状态码
nonceFloat否随机数（建议使用 Unix 时间戳或若干位随机整数）
messageString否相关信息
timestampInt否时间戳
thesaurusObject<Thesaurus>否名单信息，详见 Thesaurus 结果说明

Thesaurus 结果说明​

参数名称类型是否可能为空说明
codeInt否状态码，标识该文本名单库是否成功更新，详见公共服务状态码
errorString否错误原因
nameString否文本名单库名称
nameString否文本名单名称
labelString否文本名单一级标签
subLabelString否文本名单二级标签
statusString否状态
secretIdsArray<String>否绑定的应用（SID）

2.3 响应示例​

{
  "json": "{\"code\":0,\"message\":\"success\",\"nonce\":0.15634935255278337,\"thesaurus\":{\"name\":\"xxx\",\"label\":\"ADs\",\"subLabel\":\"xxxx\",\"secretIds\":[\"xxxx\"]},\"timestamp\":1672132071}",
  "signature": "Im1agAngnCEvXv+aOaoRKs+TTv55Y/e7nIa6sC/0FXaliYIBJreX5q2a3V0NidanNf7ZLS+IvMAnT3pfkKAxMDYr98Ue1YUNIQh8msOyKfio8dmDWEnNNuLFzwGfmNUXWOsvN9sn7ks57Z6kc+6nUa1QIyLHY17DXQZl5AhGTHg="
}

3. 更新日志​

日期说明
2025-06-17新增 API Key 接口鉴权方式，简化接口鉴权。废弃签名鉴权方式，仅保持兼容（采用签名鉴权方式的调用不受影响）
2024-10-16更新请求中的 secretIds 字段描述