列举指定业务空间下的热词列表信息。
接口说明
请确保在使用该接口前,已充分了解通义晓蜜 CCAI-对话分析 AIO 产品的收费方式和价格。
前提条件
- 已开通通义晓蜜 CCAI-对话分析 AIO 服务。
 - 已创建应用:应用中心完成通义晓蜜 CCAI-对话分析 AIO 应用创建,并获取到 APP-ID 和 WORKSPACE-ID:获取 APP-ID 和 WORKSPACE-ID。
 
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /vocab/listVocab HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| body | object | 否 | 请求 Body  | |
| workspaceId | string | 是 | 业务空间 ID  | llm-jhfr****8v | 
请求代码示例
import com.alibaba.fastjson.JSONObject;
import com.aliyun.contactcenterai20240603.Client;
import com.aliyun.contactcenterai20240603.models.*;
import com.aliyun.teaopenapi.models.Config;
import java.util.ArrayList;
import java.util.List;
public class Vocab {
    private static String accessKeyId = "YOUR_ACCESS_KEY_ID";
    private static String accessKeySecret = "YOUR_ACCESS_KEY_SECRET";
    private static String workspaceId = "YOUR_WORKSPACE_ID";
    private static Config config = new Config();
    static {
        config.setAccessKeyId(accessKeyId).setAccessKeySecret(accessKeySecret).setEndpoint("contactcenterai.cn-shanghai.aliyuncs.com")
                .setReadTimeout(30000).setConnectTimeout(300000).setRegionId("cn-shanghai").setProtocol("HTTPS");
    }
    public static void main(String[] args) throws Exception {
        Client client = new Client(config);
        ListVocabRequest request = new ListVocabRequest();
        request.setWorkspaceId(workspaceId);
        ListVocabResponse response = client.listVocab(request);
        System.out.println(JSONObject.toJSONString(response));
    }
}
返回参数
示例
正常返回示例
JSON格式
{
  "requestId": "968A8634-FA2C-5381-9B3E-*******F",
  "success": true,
  "data": [
    {
      "vocabularyId": "dv*****erverve",
      "name": "热词1",
      "description": "销售热词",
      "audioModelCode": "nls",
      "wordWeightList": [
        {
          "word": "儿童",
          "weight": 3
        }
      ]
    }
  ]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 | 
|---|---|---|---|
| 400 | CCAI.InvalidParam.NotExist | The specified parameter %s is not valid. | 请求API的参数不存在 | 
| 400 | CCAI.ParamInvalid.IllegalParamValue | The parameter value of the request API is illegal %s. | 请求API的参数不合法 | 
| 400 | CCAI.Throttling.Qpm | Trigger QPM flow restriction. Please purchase higher QPM for paid API. If free API has special requirements, please contact us through DingTalk group (62730018475). | 触发QPM限流,付费API请购买更高QPM,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。 | 
| 400 | CCAI.Throttling.Qps | Trigger current QPS limit, pay API please buy higher QPS, the free API if you have special requirements, please contact us through the DingTalk group (62730018475). | 触发限流,付费API请购买更高QPS,免费API如有特殊需求,请通过钉钉群(62730018475)联系我们。 | 
| 403 | CCAI.IllegalPermission.NoAuth | User not authorized to operate on the specified resource. | 该用户未被授权可操作指定资源 | 
| 403 | CCAI.ParamNotfound.MissParam | Parameter verification failed, The specified parameter %s is missing. | 参数校验失败,指定参数缺失。 | 
| 403 | CCAI.TenantPermission.NoAuth | The current account does not have the permission to specify the business space. Please authorize the business space permission. | 当前账号没有指定业务空间的权限,请进行业务空间权限授权。 | 
| 500 | CCAI.InternalError | The request processing has failed due to some unknown error, exception or failure. | 系统内部错误,请稍后重试 | 
访问错误中心查看更多错误码。
