备案控制台
文档
产品文档
输入文档关键字查找
首页 智能对话分析 开发参考 API参考 API目录 新版本（V4）弃用 其他 ListHotWordsTasks - 获取热词分析任务列表

ListHotWordsTasks - 获取热词分析任务列表

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

调用ListHotWordsTasks获取热词分析任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JsonStrstring是

完整 JSON 字符串信息，具体内容参见以下详细信息。

{"pageNumber":1,"pageSize":10}
BaseMeAgentIdlong否

业务空间 Id

请求参数 JSON 字符串信息

属性值类型是否必须说明
pageNumberInteger否要求返回的第几页的数据，默认 1。
pageSizeInteger否每页返回的数据数，要求大于 0，小于 100，默认 10。
nameString否任务名称

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

3CEA0495-341B-4482-9AD9-8191EF4****
Successboolean

请求是否成功，调用方可根据此字段来判断请求是否成功：true 表示成功；false/null 表示失败。

true
Codestring

结果代码，200 表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。

200
Messagestring

出错时表示出错详情，成功时为 successful。

successful
PageNumberinteger

当前页。

1
PageSizeinteger

每页条数。

10
Countinteger

总数。

1
Dataobject []

查询结果。

EndTimestring

任务最后一次执行时间，不填表示一直执行

2020-11-30T21:16Z
Typeinteger

0：周期任务；1：一次性任务，默认：0

1
Statusinteger

0：禁用；1：启用；默认：1

1
TimeIntervalinteger

type=0 时表示周期间隔，比如 24，结合 timeUnit 可确定具体时间间隔；默认：1

1
StartTimestring

首次执行时间，格式：'yyyy-MM-dd HH:mm:ss'；为空表示立即执行

2020-11-30T21:16Z
TaskConfigIdlong

任务 ID

221
Messagestring

只有状态 status=3 时，才有失败原因

xxxx
InstanceStatusinteger

执行状态，0：新建；1：执行中；2：完成；3：失败

1
LastExecutionTimestring

任务最近一次执行时间

2020-11-30T21:16Z
Namestring

任务名称

test
TimeUnitinteger

时间单位，13：秒；12：分钟；11：小时；5：天，4：星期；2：月；默认：天

5
DialogueParamobject

对话数据参数

EndTimestring

待分析录音的结束时间，不填表示本周期的开始时间

2020-11-06T00:00Z
DialogueIdlong

内部字段，请忽略。

111
EndIndexinteger

对话范围结束位置，-1 表示最后一句

-1
StartTimestring

待分析录音的开始时间，不填表示本周期的开始时间

2020-11-05T00:00Z
SourceTypeinteger

对话来源，0：呼叫中心；3：数据集，默认：0

3
StartIndexinteger

对话范围开始位置，0 表示第一句

1
Roleinteger

角色，0：客服；1：客户；2：所有；3：系统，默认：2

2
DataSetIdsstring

数据集 ID

154,136,155,156,
WordsParamobject

关注词、禁用词信息

Excludesstring

禁用词，不关注的关键词，逗号分隔

你好
Includesstring

额外关注的关键词，逗号分隔

投诉
ExtraConfigIdlong

词 ID

1

示例

正常返回示例

JSON格式

{
  "RequestId": "3CEA0495-341B-4482-9AD9-8191EF4****",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "Count": 1,
  "Data": {
    "HotWordsTaskPo": [
      {
        "EndTime": "2020-11-30T21:16Z",
        "Type": 1,
        "Status": 1,
        "TimeInterval": 1,
        "StartTime": "2020-11-30T21:16Z",
        "TaskConfigId": 221,
        "Message": "xxxx",
        "InstanceStatus": 1,
        "LastExecutionTime": "2020-11-30T21:16Z",
        "Name": "test",
        "TimeUnit": 5,
        "DialogueParam": {
          "EndTime": "2020-11-06T00:00Z",
          "DialogueId": 111,
          "EndIndex": -1,
          "StartTime": "2020-11-05T00:00Z",
          "SourceType": 3,
          "StartIndex": 1,
          "Role": 2,
          "DataSetIds": "154,136,155,156,"
        },
        "WordsParam": {
          "Excludes": "你好",
          "Includes": "投诉",
          "ExtraConfigId": 1
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
2023-08-01API 内部配置变更，不影响调用看变更集
变更项变更内容
API 内部配置变更，不影响调用。
  • 本页导读 （0）
文档反馈