服务器收到旅游攻略查询请求后,调用该接口获取旅游攻略信息。
下面描述的为接口内针对旅游攻略的定义,请求参数定义通过inquire.intent.slots传递
响应参数定义通过reply.commands.body.templateContent中返回,下面重点定义这两部分信息。
方法:POST
URL:/travel/travelTipsInfo
旅游攻略数据请求
支持指定景点id查询景点攻略信息;
支持指定景点名称查询景点攻略信息;
支持指定景点名称和地址位置(国家、省、市、区)查询景点攻略信息;
支持指定地址位置(国家、省、市、区)查询景点攻略信息;
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
name | 景点名称 | 否 | string | |
country | 国家名,如中国 | 否 | string | |
province | 省份名,如江苏省 | 否 | string | |
city | 城市名,如南京 | 否 | string | |
district | 城市下属区名称,如雨花台、雨花台区 | 否 | string | |
county | 城市下属县名称,如江宁、江宁县 | 否 | string | |
id | 景点 | 否 | string | |
limit | 请求景点的结果数, 默认为 10 | 否 | string |
旅游攻略数据响应
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
items | 旅游攻略列表 | 否 | TravelTipsItems [] | TravelTipsItem |
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
id | 旅游攻略ID | 是 | string | 最大长度:32 |
name | 景点名称 | 否 | string | 最大长度:64 |
title | 旅游攻略标题 | 是 | string | 最大长度:256 |
brief | 旅游攻略简介 | 否 | string | 最大长度:256 |
content | 旅游攻略内容 | 是 | string | 最大长度:256 |
location | 旅游景点位置 | 否 | Location | |
image | 旅游攻略相关图片,在small结构中返回288*192px图片 | 是 | Image | |
detailUrl | 旅游攻略详情页跳转地址 | 是 | Interaction | |
scenicUrl | 攻略对应景点详情页地址 | 否 | Interaction | |
updateTime | 攻略发布时间(日期,格式2020-01-09) | 否 | DateFormatString | |
updateSite | 攻略发布地点 | 否 | String | 最大长度:64 |
showMoreUrl | 查看更多跳转地址 | 否 | Interaction |
- {
- "version": "1.0",
- "session": {
- "isNew": "true",
- "sessionId": "123456"
- },
- "endpoint": {
- "auth": {
- "apiAccessToken": "",
- "application": {
- "appId": "da8afea3619a411fb59bf5f673b7ff1e"
- }
- },
- "device": {
- "deviceId": "2906",
- "supportedInterfaces": {}
- },
- "audioPlayer": {
- "token": "",
- "posInMilliSeconds": "",
- "playStatus": ""
- },
- "locale": "zh_CN"
- },
- "header": {
- "type": "IntentRequest",
- "prodPkgName": "com.huawei.intelligent",
- "timestamp": "15869741258"
- },
- "inquire": {
- "inquireId": "efd1f6ca-8fdf-11e8-9eb6-529269fb1459",
- "intent": {
- "name": "",
- "apiKey": "travel-scenicInfo",
- "slots": {
- "name": {
- "name": "name",
- "values": [
- {
- "real": "天安门"
- }
- ]
- },
- "country": {
- "name": "country",
- "slotType": "string",
- "values": [
- {
- "real": "中国"
- }
- ]
- },
- "province": {
- "name": "province",
- "slotType": "string",
- "values": [
- {
- "real": "北京"
- }
- ]
- },
- "city": {
- "name": "city",
- "slotType": "string",
- "values": [
- {
- "real": "北京"
- }
- ]
- }
- },
- "utterance": {
- "original": ""
- }
- }
- }
- }
- {
- "version": "1.0",
- "reply": {
- "displayText": "displayText",
- "commands": [
- {
- "head": {
- "namespace": "Render",
- "name": "DisplayTemplate"
- },
- "body": {
- "templateType": "travel-scenicInfo",
- "templateContent": {
- "items": [
- {
- "id": "1001",
- "name": "天安门广场",
- "title": "故宫及天安门广场参观攻略指南",
- "brief": "1949年以来,天安门在中国奠定的的地位从来没有被撼动",
- "content": "【北京概述】 北京,中国的首都。中国八大古都之一。关于北京的概况相信大家多多少少都有一些了解。如果喜欢文物古迹,那北京就是怀古的天堂,即使用一周时间也是不够玩的。",
- "location": {
- "locationSystem": "GCJ02",
- "latitude": "39.909604",
- "longitude": "116.397228",
- "poiId": ""
- },
- "image": {
- "small": {
- "url": "string",
- "widthPixels": 0,
- "heightPixels": 0
- },
- "medium": {
- "url": "string",
- "widthPixels": 0,
- "heightPixels": 0
- },
- "large": {
- "url": "string",
- "widthPixels": 0,
- "heightPixels": 0
- }
- },
- "detailUrl": {
- "webURL": "string",
- "deepLink": {
- "url": "string",
- "appName": "string",
- "appPackage": "string",
- "minVersion": 0,
- "minAndroidAPILevel": 0
- },
- "quickApp": {
- "url": "string",
- "minPlatformVersion": 0,
- "minVersion": 0
- }
- },
- "scenicUrl": {
- "webURL": "string",
- "deepLink": {
- "url": "string",
- "appName": "string",
- "appPackage": "string",
- "minVersion": 0,
- "minAndroidAPILevel": 0
- },
- "quickApp": {
- "url": "string",
- "minPlatformVersion": 0,
- "minVersion": 0
- }
- },
- "updateTime": "2019-12-22",
- "updateSite": "北京"
- },
- {
- "id": "1001",
- "name": "天安门广场",
- "title": "做观光2线游北京 打卡天安门、故宫、王府井、前门",
- "brief": "",
- "content": "跟我一起坐上观光2号线,静静地欣赏北京的美。天安门广场、故宫、前门、王府井,北京的历史文化、限定于繁华尽收眼底,3分钟的视频带你打卡北京著名景点。",
- "location": {
- "locationSystem": "GCJ02",
- "latitude": "39.909604",
- "longitude": "116.397228",
- "poiId": ""
- },
- "image": {
- "small": {
- "url": "string",
- "widthPixels": 0,
- "heightPixels": 0
- },
- "medium": {
- "url": "string",
- "widthPixels": 0,
- "heightPixels": 0
- },
- "large": {
- "url": "string",
- "widthPixels": 0,
- "heightPixels": 0
- }
- },
- "detailUrl": {
- "webURL": "string",
- "deepLink": {
- "url": "string",
- "appName": "string",
- "appPackage": "string",
- "minVersion": 0,
- "minAndroidAPILevel": 0
- },
- "quickApp": {
- "url": "string",
- "minPlatformVersion": 0,
- "minVersion": 0
- }
- },
- "scenicUrl": {
- "webURL": "string",
- "deepLink": {
- "url": "string",
- "appName": "string",
- "appPackage": "string",
- "minVersion": 0,
- "minAndroidAPILevel": 0
- },
- "quickApp": {
- "url": "string",
- "minPlatformVersion": 0,
- "minVersion": 0
- }
- },
- "updateTime": "2018-12-12",
- "updateSite": "北京"
- }
- ]
- }
- }
- }
- ]
- },
- "isEndSession": true,
- "errorCode": "0",
- "errorMessage": "OK"
- }
服务器定时调用三方合作伙伴服务器接口,获取景点的全量或者增量索引数据,用于华为侧根据用户的输入判断是否为景点信息查询从而调用景点服务,或者根据用户的位置信息判断用户附近是否有景点,向用户展示景点卡片。
接口公共定义参考内容数据同步接口定义
下面描述接口内针对附近的服务的数据定义。
方法:POST
URL:/travel/scenic
景点垂类索引数据同步请求消息定义
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
pagination | 请求体中的分页结构,携带分页查询条件。 | 是 | PaginationReq | |
dataType | 取元数据的范围,是全量的,还是增量实时的 | 是 | string | 最大长度:16,枚举值: |
timestamp | 增量实时获取时带时间戳,获取该时间后的变更数据。时间格式,yyyyMMddHHmmss,正则Pattern:[0-9]{14} | 否 | string |
景点垂类索引数据同步响应消息定义
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
data | 返回的景点索引数据 | 是 | ScenicInfoRspItem | |
pagination | 分页信息 | 是 | PaginationRsp | |
errorCode | 返回结果状态 | 是 | string | 最大长度:32 |
errorMessage | 返回结果状态描述信息 | 否 | string | 最大长度:256 |
ScenicInfoRspItem
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
serviceId | 景点ID | 是 | string | 最大长度:32 |
name | 景点名称 | 否 | string | 最大长度:64 |
locationSystem | 定位数据坐标系统,取值为:BD09LL(百度球面坐标)、GCJ02(国测局加密坐标)、WGS84(GPS设备获取的坐标),首选WGS84坐标系 | 否 | string | 枚举值: |
latitude | 附近的服务纬度,ddd.dddddd 【度 . 度 格式】的十进制小数部分(6位) | 否 | string | 最大长度:10 |
longitude | 附近的服务经度,ddd.dddddd 【度 . 度 格式】的十进制小数部分(6位) | 否 | string | 最大长度:10 |
serviceType | 附近的服务类型 | 否 | string | 枚举值: |
country | 附近服务所属国家 | 否 | string | 最大长度:32 |
province | 附近服务所属省名 | 否 | string | 最大长度:32 |
city | 附近服务所属城市名 | 否 | string | 最大长度:32 |
district | 附近服务所属区县名 | 否 | string | 最大长度:32 |
description | 附近服务描述 | 否 | string | 最大长度:10240 |
address | 景点的详细地址 | 否 | string | 最大长度:512 |
serviceImage | 景点图片信息 | 否 | ImageInfo |
- {
- "pagination": {
- "limit": 0,
- "start": "string"
- },
- "dataType": "FULL",
- "timestamp": "string"
- }
- 响应
- {
- "data": [
- {
- "serviceId":"1001",
- "name": "天安门广场",
- "locationSystem": "GCJ02",
- "latitude": "39.909604",
- "longitude": "116.397228",
- "serviceType": "SCENIC",
- "country": "中国",
- "province": "北京",
- "city": "北京市",
- "district": "东城区"
- },
- {
- "serviceId": "1002",
- "serviceName": "故宫",
- "locationSystem": "GCJ02",
- "latitude": "39.916696",
- "longitude": "116.390837",
- "serviceType": "SCENIC",
- "country": "中国",
- "province": "北京",
- "city": "北京市",
- "district": "东城区"
- }
- ],
- "pagination": {
- "next": "string",
- "total": 100
- },
- "errorCode": "string",
- "errorMessage": "string"
- }
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
webURL | 点击整个卡片需要实际跳转的H5链接,要求为https地址 | 否 | string | 最大长度:512 |
deepLink | 对原生App的跳转 | 否 | NativeAppLinkInteraction | |
quickApp | 对快应用的扩展 | 否 | QuickAppLinkInteraction |
对原生App的跳转
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
url | App的deeplink地址 | 是 | string | 最大长度:512 |
appName | App名称 | 否 | string | 最大长度:256 |
appPackage | App包名 | 是 | string | 最大长度:256 |
minVersion | 支持的APP的最小版本号VersionCode | 是 | long | |
minAndroidAPILevel | 所需android最小API Level | 否 | long |
对快应用的扩展
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
url | 快应用的deeplink地址 | 是 | string | 最大长度:512 |
minPlatformVersion | 所需快应用引擎最小版本号。 | 是 | long | |
minVersion | 支持的快应用的最小版本号VersionCode | 是 | long |
单个图片信息
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
url | 图片URL,要求为https格式 | 是 | string | 最大长度:512 |
widthPixels | 图片宽度(像素) | 是 | long | 最小值:1,最大值:16384 |
heightPixels | 图片高度(像素) | 是 | long | 最小值:1,最大值:16384 |
图片信息,至少提供一张图
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
small | 小图 | 否 | Image | |
medium | 中图 | 否 | Image | |
large | 大图 | 否 | Image |
展示标签信息定义
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
tagMode | 标签样式 | 否 | string | 最大长度:32,枚举值: |
tagContent | 标签展示内容 | 否 | string | 最大长度:64 |
color | 标签展示颜色 | 否 | string | 安卓色值 |
日期格式定义
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
DateFormatString | 日期格式, yyyy-MM-dd | 是 | string | pattern: '[0-9]{4}\-[0-9]{1,2}\-[0-9]{1,2}' |
位置信息定义
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
locationSystem | 定位数据坐标系统,取值为:BD09LL(百度球面坐标)、GCJ02(国测局加密坐标)、WGS84(GPS设备获取的坐标) | 是 | string | BD09LL - GCJ02 - WGS84 |
latitude | 纬度,ddd.dddddd 【度 . 度 格式】的十进制小数部分(6位) | 是 | string | 最大长度:10 |
longitude | 经度,ddd.dddddd 【度 . 度 格式】的十进制小数部分(6位) | 是 | string | 最大长度:10 |
poiId | 位置Id | 否 | string | 最大长度:32 |
日期格式定义
成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
DateFormatString | 时间格式,yyyyMMddHHmmssSSS | 是 | string | pattern: [0-9]{17}' |