历史上的今天数据获取

服务器收到历史上的今天查询请求后,调用该接口获取服务或者服务目录信息。

接口公共定义

参考官方网站的Fulfillment API接口定义。

下面描述的为接口内针对历史上的今天查询的定义,请求参数定义通过inquire.intent.slots传递。

响应参数定义通过reply.commands.body.templateContent中返回,下面重点定义这两部分信息。

方法:POST
URL:/calendar/history

请求

历史上的今天数据请求

成员名称

描述

是否必选

类型

取值范围

beginDate

起始日期,格式为yyyy-MM-dd,如2020-04-27

是

string


endDate

结束日期,格式为yyyy-MM-dd,如2020-04-29

否

string


响应

历史上的今天数据响应

成员名称

描述

是否必选

类型

取值范围

items

历史上的今天列表

否

CalendarHistoryInfoItem []

serviceInfoList

date

日期,格式为yyyy-MM-dd,如2020-04-29

是

string


结构定义

CalendarHistoryInfoItem

成员名称

描述

是否必选

类型

取值范围

year

历史年份,格式为yyyy

是

string

最大长度: 4

event

事件描述

是

string

最大长度:512

keyEvent

关键事件标识,不带默认为非关键事件

否

string

枚举值:

0:非关键事件

1:关键事件

keyword

事件描述中的关键词信息,可以做高亮展示,多个关键词用英文逗号分隔

否

string

最大长度:128

period

事件年代分类,如古代、近现代、当代

否

string

最大Item数:32

eventType

事件类型

否

string

枚举值:

大事件

出生名人

逝世名人

请求

  1. {
  2.  "version": "1.0",
  3.  "session": {
  4.    "isNew": "true",
  5.    "sessionId": "123456"
  6.  },
  7.  "endpoint": {
  8.    "auth": {
  9.      "apiAccessToken": "",
  10.      "application": {
  11.        "appId": "da8afea3619a411fb59bf5f673b7ff1e"
  12.      }
  13.    },
  14.    "device": {
  15.      "deviceId": "2906",
  16.      "supportedInterfaces": {}
  17.    },
  18.    "audioPlayer": {
  19.      "token": "",
  20.      "posInMilliSeconds": "",
  21.      "playStatus": ""
  22.    },
  23.    "locale": "zh_CN"
  24.  },
  25.  "header": {
  26.    "type": "IntentRequest",
  27.    "prodPkgName": "com.huawei.calendar",
  28.    "timestamp": "15869741258"
  29.  },
  30.  "inquire": {
  31.    "inquireId": "efd1f6ca-8fdf-11e8-9eb6-529269fb1459",
  32.    "intent": {
  33.      "apiKey": "calendar-history",
  34.      "slots": {
  35.        "beginDate": {
  36.          "name": " beginDate ",
  37.          "values": [
  38.            {
  39.              "real": "2020-05-19"
  40.            }
  41.          ]
  42.        },
  43.        "endDate": {
  44.          "name": "endDate",
  45.          "values": [
  46.            {
  47.              "real": "2020-05-20"
  48.            }
  49.          ]
  50.        }
  51.      }
  52.    },
  53.    "utterance": {
  54.      "original": ""
  55.    }
  56.  }
  57. }

查询响应

  1. {
  2.  "version": "1.0",
  3.  "reply": {
  4.    "speech": {
  5.      "type": "",
  6.      "text": ""
  7.    },
  8.    "isEndSession": false,
  9.    "commands": [
  10.      {
  11.        "head": {
  12.          "name": "DisplayTemplate",
  13.          "namespace": "Render"
  14.        },
  15.        "body": {
  16.          "templateType": "nearby-servicesInfo",
  17.          "templateContent": {
  18.            "items": [
  19.              {
  20.                "date": "2020-05-19",
  21.                "almanacInfo": [
  22.                  {
  23.                    "year": "2008",
  24.                    "event": "国务院决定,2008-5-19至21为全国哀悼日。",
  25.                    "keyEvent": "0",
  26.                    "keyword": "全国哀悼日",
  27.                    "period": "近现代",
  28.                    "eventType": "大事件"
  29.                  },
  30.                  {
  31.                    "year": "2007",
  32.                    "event": "台湾中正纪念堂正式更名为台湾民主纪念馆",
  33.                    "keyEvent": "0",
  34.                    "keyword": "台湾中正纪念堂",
  35.                    "period": "近现代",
  36.                    "eventType": "大事件"
  37.                  },
  38.                  {
  39.                    "year": "1975",
  40.                    "event": "中国羽毛球运动员张宁出生。",
  41.                    "keyEvent": "0",
  42.                    "keyword": "",
  43.                    "period": "",
  44.                    "eventType": "出生名人"
  45.                  },
  46.                  {
  47.                    "year": "1825",
  48.                    "event": "克劳德.昂利.圣西门,法国空想社会主义",
  49.                    "keyEvent": "0",
  50.                    "keyword": "",
  51.                    "period": "",
  52.                    "eventType": "逝世名人"
  53.                  }
  54.                ]
  55.              },
  56.             {
  57.                "date": "2020-05-20",
  58.                "almanacInfo": [
  59.                  {
  60.                    "year": "2014",
  61.                    "event": "第四次亚信峰会(亚洲相互协作与信任措施会议)在上海举行",
  62.                    "keyEvent": "0",
  63.                    "keyword": "亚洲相互协作与信任措施会议",
  64.                    "period": "",
  65.                    "eventType": "大事件"
  66.                  },
  67.                  {
  68.                    "year": "2019",
  69.                    "event": "降旗康男,日本导演,曾执导电影《铁道员》",
  70.                    "keyEvent": "0",
  71.                    "keyword": "",
  72.                    "period": "",
  73.                    "eventType": "逝世名人"
  74.                  },
  75.                  {
  76.                    "year": "1987",
  77.                    "event": "赵帆,中国内地男歌手,2010快乐男声全国第12名。",
  78.                    "keyEvent": "0",
  79.                    "keyword": "",
  80.                    "period": "",
  81.                    "eventType": "出生名人"
  82.                  }
  83.                ]
  84.              }
  85.            ]
  86.          }
  87.        }
  88.      }
  89.    ]
  90.  },
  91.  "errorCode": "0",
  92.  "errorMessage": "ok"
  93. }