用户在搜索“正能量句子”等泛需求时,搜索结果页会每日分享一句正能量卡片。用户可在结果页查看相关句子,点击按钮跳转至资源方落地页查看更多内容。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
sentence | string | 句子类型 | 可选,句子的类型,如早安、正能量、励志 |
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"sentence":"早安"} |
通过开放 API 上传
资源方仅需要通过 txt 文件上传一个空的 intent 到平台。详细接入方式参见API 上传方式
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48090 |
当前资源的 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 | 必选 | 点击卡片标题的跳转路径,应跳转至资源方落地页,该落地页应该含有卡片展示的句子详细内容。如果收到的 surface 请求是 mobile,请返回小程序路径,如/page/of/target;如果收到的 surface 请求是 web_h5,请返回 H5 路径,如/page/of/target(以/开头,不含域名) |
tag | array | 可选 | 横滑 Tag 列表,最少 2 个,最多 10 个,第一个 tag 需要与返回的 intent 中所包含的句子类型相吻合 |
tag_text | string | 可选 | Tag 文案,最短 1 个字符,最长 6 个字符,如:“早安”“哲理”“正能量” |
tag_url | string | 可选 | Tag 链接地址。如:“/page/of/target” |
item | array | 必选 | 左图右文列表数据配置,固定为 1 组。 |
item_image | string | 必选 | 图片链接,对应句子的配图。以“https”开头的图片链接图片横竖比 1:1 |
item_text | string | 必选 | 段落本体,每日一句的内容。如:“生活不能等别人来安排,要自已去争取和奋斗;而不论其结果是喜是悲,但可以慰藉的是,你总不枉在这世界上活了一场。” |
举例:从 webhook 返回的 JSON (加密前)
1 | { |