用户在搜索“乌龙茶”、“红茶”等茶叶类型时,搜索结果页会展现茶叶大全卡片。用户在搜索结果页查看茶叶品种、品貌信息,点击图文结构体可跳转至茶叶详情页获取更多茶叶百科知识。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
tea_type | string | 茶叶类型 | 必选,资源所覆盖的茶叶类型,包括父类(如乌龙茶)和子类(如铁观音),如:“红茶”、“乌龙茶”、“铁观音”等 |
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"tea_type":"铁观音"} |
通过开放 API 上传
详细接入方式参见API 上传方式
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48065 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
jump_url | string | 必选 | 点击卡片的跳转链接地址,跳转至提供茶叶百科的落地页。url 字段需返回 H5 或智能小程序页面路径,例如“/page/of/target” |
title | string | 必选 | 标题文案,茶叶名称,如“乌龙茶” |
image | string | 必选 | 茶叶图片链接,以“https”开头 |
info | array | 必选 | 茶叶基本信息文本数组,当标题为茶叶二级类目时为茶叶的产地、所属类目,如:“产地:福建 泉州”,“类目:乌龙茶”;当标题为茶叶一级类目时为茶叶的产地、历史,如:“产地:福建”,“起源:宋朝”。字符串数组,最少 2 个,最多 2 个 |
text | string | 必选 | 茶叶简介文案,以“简介:”开头,对该茶叶特点的阐述 |
label | array | 必选 | 标签,茶叶的性质标签,如“性平”,字符串数组,最多 3 个 |
url | string | 必选 | 点击左图右文结构的跳转链接地址,二级分类茶种跳转至茶叶详情页;一级分类茶种跳转至子茶种列表页。url 字段需返回 H5 或智能小程序页面路径,例如“/page/of/target” |
table_rows | array | 必选 | 表格数据配置,最少 2 个,最多 25 个 |
table_rows.grade | string | 必选 | 表格第一列,品级,如:“特级”、“一级”、“二级” |
table_rows.description | string | 必选 | 表格第二列,茶叶的茶叶的特征描述文案,如:“形状肥壮圆结、沉重匀整、呈蜻蜓头;色泽油润砂绿;汤色金黄明亮 浓艳。”,最短 1 个字符,最长 40 个字符 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |