调用ListHotWordsTasks获取热词分析任务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListHotWordsTasks |
系统规定参数。取值：ListHotWordsTasks。 |
| JsonStr | String | 是 | {"pageNumber":1,"pageSize":10} |
完整Json字符串信息，具体内容参见以下详细信息。 |
请求参数Json字符串信息
|
属性 |
值类型 |
是否必须 |
说明 |
|---|---|---|---|
|
pageNumber |
Integer |
否 |
要求返回的第几页的数据，默认1。 |
|
pageSize |
Integer |
否 |
每页返回的数据数，要求大于0，小于100，默认10。 |
|
name |
String |
否 |
任务名称 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | 200 |
结果代码，200表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。 |
| Count | Integer | 1 |
总数。 |
| Data | Array of HotWordsTaskPo |
查询结果。 |
|
| HotWordsTaskPo | |||
| DialogueParam | Struct |
对话数据参数 |
|
| DataSetIds | String | 154,136,155,156, |
数据集id |
| DialogueId | Long | 111 |
内部字段，请忽略。 |
| EndIndex | Integer | -1 |
对话范围结束位置，-1表示最后一句 |
| EndTime | String | 2020-11-06T00:00Z |
待分析录音的结束时间，不填表示本周期的开始时间 |
| Role | Integer | 2 |
角色，0：客服；1：客户；2：所有；3：系统 默认：2 |
| SourceType | Integer | 3 |
对话来源，0：呼叫中心；3：数据集 默认：0 |
| StartIndex | Integer | 1 |
对话范围开始位置，0表示第一句 |
| StartTime | String | 2020-11-05T00:00Z |
待分析录音的开始时间，不填表示本周期的开始时间 |
| EndTime | String | 2020-11-30T21:16Z |
任务最后一次执行时间，不填表示一直执行 |
| InstanceStatus | Integer | 1 |
执行状态，0：新建；1：执行中；2：完成；3：失败 |
| LastExecutionTime | String | 2020-11-30T21:16Z |
任务最近一次执行时间 |
| Message | String | xxxx |
只有状态status=3时，才有失败原因 |
| Name | String | test |
任务名称 |
| StartTime | String | 2020-11-30T21:16Z |
首次执行时间，格式：’yyyy-MM-dd HH:mm:ss’；为空表示立即执行 |
| Status | Integer | 1 |
0：禁用；1：启用 默认：1 |
| TaskConfigId | Long | 221 |
任务id |
| TimeInterval | Integer | 1 |
type=0时表示周期间隔，比如24，结合timeUnit可确定具体时间间隔；默认：1 |
| TimeUnit | Integer | 5 |
时间单位，13: 秒；12：分钟；11：小时；5：天，4：星期；2：月；默认：天 |
| Type | Integer | 1 |
0：周期任务；1：一次性任务 默认：0 |
| WordsParam | Struct |
关注词、禁用词信息 |
|
| Excludes | String | 你好 |
禁用词，不关注的关键词，逗号分隔 |
| ExtraConfigId | Long | 1 |
词id |
| Includes | String | 投诉 |
额外关注的关键词，逗号分隔 |
| Message | String | successful |
出错时表示出错详情，成功时为successful。 |
| PageNumber | Integer | 1 |
当前页。 |
| PageSize | Integer | 10 |
每页条数。 |
| RequestId | String | 3CEA0495-341B-4482-9AD9-8191EF4**** |
请求id，提工单时可提供此字段值用于排查问题。 |
| Success | Boolean | true |
请求是否成功，调用方可根据此字段来判断请求是否成功：true表示成功；false/null表示失败。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListHotWordsTasks
&JsonStr={"pageNumber":1,"pageSize":10}
&<公共请求参数>正常返回示例
XML 格式
<ListHotWordsTasksResponse>
<Message>successful</Message>
<PageSize>1</PageSize>
<RequestId>F033E47F-2A63-4BBC-805F-DC498AE9***</RequestId>
<PageNumber>1</PageNumber>
<Data>
<HotWordsTaskPo>
<Status>1</Status>
<TaskConfigId>15</TaskConfigId>
<Type>1</Type>
<TimeInterval>1</TimeInterval>
<Message/>
<InstanceStatus>2</InstanceStatus>
<StartTime>2020-11-30T21:16Z</StartTime>
<LastExecutionTime>2020-11-30T21:16Z</LastExecutionTime>
<TimeUnit>5</TimeUnit>
<WordsParam>
<Includes>你好</Includes>
<ExtraConfigId>1</ExtraConfigId>
<Excludes>禁词</Excludes>
</WordsParam>
<Name>生产热词分析测试01</Name>
<DialogueParam>
<Role>2</Role>
<StartIndex>0</StartIndex>
<SourceType>3</SourceType>
<EndIndex>-1</EndIndex>
<DataSetIds>154,136,155,156,157,158,159,160,161,162,163</DataSetIds>
</DialogueParam>
</HotWordsTaskPo>
</Data>
<Count>13</Count>
<Code>200</Code>
<Success>true</Success>
</<ListHotWordsTasksResponse>JSON 格式
{
"Message":"successful",
"PageSize":1,
"RequestId":"F033E47F-2A63-4BBC-805F-DC498AE9***",
"PageNumber":1,
"Data":{
"HotWordsTaskPo":[
{
"Status":1,
"TaskConfigId":15,
"Type":1,
"TimeInterval":1,
"Message":"",
"InstanceStatus":2,
"StartTime":"2020-11-30T21:16Z",
"LastExecutionTime":"2020-11-30T21:16Z",
"TimeUnit":5,
"WordsParam":{
"Includes":"你好",
"ExtraConfigId":1,
"Excludes":"禁词"
},
"Name":"生产热词分析测试01",
"DialogueParam":{
"Role":2,
"StartIndex":0,
"SourceType":3,
"EndIndex":-1,
"DataSetIds":"154,136,155,156,157,158,159,160,161,162,163"
}
}
]
},
"Count":13,
"Code":"200",
"Success":true
}错误码
访问错误中心查看更多错误码。
