文档

ListHotTopics - 获取热点列表

更新时间:

获取热点事件列表。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
AgentKeystring

业务空间唯一标识:AgentKey

xxxxx_p_efm
TopicSourcestring

热榜源筛选,支持的热榜源。热榜源详见 API:ListHotSources

热榜源筛选,支持的热榜源。热榜源详见API:ListHotSources
Topicsarray

热榜主题事件筛选

string

热榜主题事件名称

xxx
TopicVersionstring

数据版本筛选

数据版本筛选
TopicQuerystring

根据热榜主题全文检索

根据热榜主题全文检索
TopicIdsarray

热榜主题 ID 列表

string

热榜主题 ID

xxxxxx
WithNewsboolean

响应是否包含新闻

true
NextTokenstring

下一页的 token

下一页的token
MaxResultsinteger

最大返回结果数

1

返回参数

名称类型描述示例值
object

PageResult2

Codestring

状态码

NoData
Dataarray<object>

业务数据

object

热点事件列表

AsyncTaskIdstring

异步任务 ID(自定义主题场景下使用)

异步任务ID(自定义主题场景下使用)
CreateUserstring

创建用户 ID(自定义主题场景下使用)

创建用户ID(自定义主题场景下使用)
HotValuelong

热度值

61
Idstring

热榜 ID

热榜ID
Statusstring

异步任务状态(自定义事件场景下使用) (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)

FAILED
StructureSummaryarray<object>

结构化主题摘要列表

object
DocListarray<object>

生成该标题摘要引用的文章

object
Sourcestring

文章来源

夸克
Titlestring

文章标题

xxxxx
Urlstring

文章 URL

http://www.example.com
Summarystring

摘要

摘要
Titlestring

标题

标题
Summarystring

热榜摘要

热榜摘要
TaskErrorMessagestring

异步任务失败错误信息

异步任务失败错误信息
TaskStatusinteger

异步任务状态.0-待执行,1-执行中,2-执行成功 3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)

26
Topicstring

主题唯一名称

主题唯一名称
TopicSourcestring

热榜源,目前支持的热榜源: Toutiao:头条、Quark:夸克、Baidu:百度、Sina:新浪。Custom:自定义、Aggregation:热点话题榜

热榜源,目前支持的热榜源: Toutiao:头条、Quark:夸克、Baidu:百度、Sina:新浪。Custom:自定义、Aggregation:热点话题榜
Versionstring

数据版本

数据版本
HttpStatusCodeinteger

http 状态码

200
MaxResultsinteger

最大返回结果数

94
Messagestring

错误说明

success
NextTokenstring

下一页的 token

下一页的token
RequestIdstring

请求唯一标识

1813ceee-7fe5-41b4-87e5-982a4d18cca5
Successboolean

是否成功:true 成功,false 失败

true
TotalCountinteger

总数

23

示例

正常返回示例

JSON格式

{
  "Code": "NoData",
  "Data": [
    {
      "AsyncTaskId": "异步任务ID(自定义主题场景下使用)",
      "CreateUser": "创建用户ID(自定义主题场景下使用)",
      "HotValue": 61,
      "Id": "热榜ID",
      "Status": "FAILED",
      "StructureSummary": [
        {
          "DocList": [
            {
              "Source": "夸克",
              "Title": "xxxxx",
              "Url": "http://www.example.com"
            }
          ],
          "Summary": "摘要",
          "Title": "标题"
        }
      ],
      "Summary": "热榜摘要",
      "TaskErrorMessage": "异步任务失败错误信息",
      "TaskStatus": 26,
      "Topic": "主题唯一名称",
      "TopicSource": "热榜源,目前支持的热榜源: Toutiao:头条、Quark:夸克、Baidu:百度、Sina:新浪。Custom:自定义、Aggregation:热点话题榜",
      "Version": "数据版本"
    }
  ],
  "HttpStatusCode": 200,
  "MaxResults": 94,
  "Message": "success",
  "NextToken": "下一页的token",
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "TotalCount": 23
}

错误码

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