中国老百姓有查看黄历的习惯,通过查看黄历来挑选适合从事某项活动的日子,比如通过看黄历来确定哪天适合搬家,那天适合结婚等等。
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
activity | string | 活动 | 必选,如”搬家”。 |
通过平台上传 txt 文件
资源方需要将自己小程序能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"activity":""} |
注意:为了能召回”黄道吉日”等泛需求,需要上传一个空的 activity。
通过开放 API 上传
详细接入方式参见 API 上传方式
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
time | object | 用户表达的关于时间的成分 | JSON 对象 |
query_info.query_year | string | 用户 query 中表达的年份 | “2019” |
query_info.query_month | string | 用户 query 中表达的月份 | “10” |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48019 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
注:以下发送的参数中query_info对象中的具体字段可能是空字符,开发者需要注意兼容,当为空时开发者可以根据具体情况返回默认值
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的 data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
jump_url | string | 必选 | 标题&日历跳转链接,点击跳转到相应时间的相应活动的落地页里 |
time | string | 必选 | 展现在结果页的黄历的年月,格式为 xxxx 年 xx 月,如 2019 年 11 月 |
activity | string | 必选 | 用户要查询活动,如搬家,嫁娶等,格式为 xx 吉日,如搬家吉日,嫁娶吉日等 |
fit_legend | string | 必选 | 宜事图例,文本为适合 xx,如适合搬家,适合嫁娶等。注:黄道吉日、吉日等的图例,文本为:黄道吉日 |
aviod_legend | string | 必选 | 忌事图例,文本为不宜 xx,如:”不宜搬家”,”不宜嫁娶”等 |
calendar_list | array | 必选 | 必须提交五周共 35 天的日历,包括上个月末和下个月初的日期,每一行从周一开始展示,字段包括阳历,农历,节日,节日优先级高于农历(与落地页日历保持一致) |
calendar_list.data | integer | 必选 | 阳历日期,如:28、19、30 |
calendar_list.lunar_data | string | 必选 | 农历日历(节日或节气)如:初三、初四、初五、老人节、寒霜、国庆节 |
calendar_list.is_suit | integer | 必选 | 是否为宜日,1 为宜日,0 为空,-1 为忌日,如:-1,0,1 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |