水电煤缴费服务
用户在搜索水电煤缴费相关需求时,搜索会展现水电煤缴费服务卡片,提供快捷的在线一键缴费服务。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
cash | string | 缴费项目 | “水费”“电费”“燃气费”等 |
city | string | 城市名称,可为空 | “北京”“上海” |
当同时提供 intent.city 和 location.city 时,优先使用 intent.city。因为 intent 内容是从用户搜索词中直接提取的。
通过平台上传 txt 文件
资源方需要将自己小程序能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
- {"city":"北京","cash":"水费"}
{"city":"上海","cash":"电费"}
{"city":"","cash":"燃气费"}
通过开放 API 上传
未开放
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型(大部分开发者可不关心) | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景(大部分开发者可不关心) | “mobile”:移动搜索;”pc”: PC 搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
location | object | 用户定位信息 | JSON 对象 |
location.province | string | 用户所在省份 | “北京”/“浙江”,不含行政区划单位,例如”市、省、自治区”,可能为空 |
location.city | string | 用户所在城市 | “北京”/“杭州”,不含行政区划单位,例如”市”,可能为空 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48013 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
- {
"type": "sp_ala",
"srcid": "48013",
"surface": "mobile",
"intent": {
"city":"",
"cash":"电费"
},
"location": {
"province":"浙江",
"city": "杭州"
}
}
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果,2 代表请求参数错误,3 代表内部服务错误 | 0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的 data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
jump_url | string | 必选 | 服务主功能(如电费缴纳)的跳转路径,例如:/page/of/target |
service_name | string | 必选 | 服务名称(以服务结尾),例如:电费缴纳服务 |
service_title | string | 必选 | 主服务button标题,例如:一键缴纳 |
service_icon_name | string | 必选 | 主服务图标名,详见服务图标使用指南 |
description_list | array | 必选 | 服务介绍列表,最少1个,最多3个 |
description_list.description | string | 必选 | 服务介绍,1-100字,例如:登录即可快速在线缴纳电费 |
index_url | string | 必选 | 小程序更多服务列表页跳转路径(一般为首页跳转路径),例如:/page/of/target |
more_service_list | array | 整体可选,选后不可为空 | 更多服务列表,最少3个,最多8个 |
more_service_list.icon_name | string | 必选 | 更多服务图标名,详见服务图标使用指南 |
more_service_list.text | string | 必选 | 更多服务名称,建议4字,例如:水费缴纳 |
more_service_list.url | string | 可选 | 更多服务跳转路径,例如:/page/of/target;每项更多服务 url 和 tel 只能同时存在一种 |
more_service_list.tel | string | 可选 | 更多服务电话,例如:tel:123456;每项更多服务 url 和 tel 只能同时存在一种 |
举例:从 webhook 返回的 JSON (加密前)
- {
"status": 0,
"msg": "string",
"data": {
"jump_url": "/page/of/target",
"service_name": "电费缴纳服务",
"service_title": "一键缴纳",
"service_icon_name": "dianfeijiaona",
"description_list": [{
"description": "登录即可快速在线缴纳电费"
}],
"index_url": "/page/of/target",
"more_service_list": [{
"icon_name": "shuifeijiaona",
"text": "水费缴纳",
"url": "/page/of/target"
}, {
"icon_name": "ranqijiaona",
"text": "燃气缴纳",
"url": "/page/of/target"
}, {
"icon_name": "kefudianhua",
"text": "客服电话",
"url": "tel:1234556"
}]
}
}