智能小程序OPENCARD
开放类目

精选文档查询

用户在搜索教育类文档需求时，搜索会展现精选文档聚合卡片，提供优质的文档资源查看下载信息。

示意图

intent 上传接口

当前资源 intent 意图参数

key 类型 含义 要求 示例/说明
variable string 文档名称 可选 “一年级语文上册”
category string 文档分类 可选 “教案”

通过平台上传 txt 文件

资源方需要将自己小程序能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上，txt 文件的具体要求参见接入流程-上传 Intent 数据。

当前资源分类 txt 上传文件内容示例如下：

1
{ "variable": "一年级语文上册", "catetory": "教案" }

通过开放 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 资源编号 48012

当前资源的 intent 参数参考上节 “intent 上传接口“。

举例：发送给 webhook 的 JSON (解密后)

1
2
3
4
5
6
7
8
9
{
  "type": "sp_ala",
  "srcid": "48012",
  "surface": "mobile",
  "intent": {
    "variable": "一年级语文上册",
    "category": "教案"
  }
}

从 webhook 返回的结果

外层通用数据字段

key 类型 含义 示例/说明
status integer 结果状态码，0 代表正确，1 代表无结果，
2 代表请求参数错误，3 代表内部服务错误		 0
msg string 出错消息，当非 0 时提供 “”
data object 要返回的资源数据内容 JSON 对象，每个资源分类不同

当前资源分类的 data object 字段内容

key 类型 要求 说明
jump_url string 必选 结构化元素：链接，点击卡片标题跳转的链接。当卡片展示 1 个文档，跳转到展示该文档的页面；当卡片展现大于 1 个文档，跳转到卡片包含的文档列表页（小程序样例数据：/path/to/page h5 样例数据：http://www.lottery.gov.cn/）
tag_list array 整体可选，选后不可为空 Tags，该文档的结构化列表数据，最少 2 个，最多 10 个
tag_list.text string 必选 选项 tag 标签上的文案，如一年级、二年级等，默认展示第一个 tag，且该 tag 需要满足 intent 所体现的用户主需求。
tag_list.url string 必选 结构化元素：链接，点击 tag 区域跳转的链接
item_list array 必选 个数组件数据（数组），指文档篇数，最少 1 个，最多 3 个
item_list.title string 必选 文档标题文案，两行截断
item_list.image string 必选 文档缩略图的图片链接，图片尺寸 3:4，像素 364*486，不符合比例的图片将按固定比例被居中裁剪
item_list.extra_info string 必选 文案，文档类型、文档页数，中间用符号隔开
item_list.read_num string 必选 文案，文档浏览量
item_list.labels array 可选，选后不可为空 标签组，如热、新、免费阅读等。字符串数组，最多 3 个，字数在 5 个字以内
item_list.source_icon string 必选 作者头像，必须 https 开头
item_list.source_text string 必选 作者名称
item_list.source_extra string 可选，选后不可为空 作者等级，如高级教师
item_list.url string 必选 结构化元素：链接，文档链接
links array 整体可选，选后不可为空 Slink 子链列表数据，最少 2 个，最多 5 个
links.text string 必选 子链文案，2/3/4/5 等分分别最大支持 8/6/4/2 个字，具体文案如教案、教学设计等
links.url string 必选 结构化元素：链接

举例：从 webhook 返回的 JSON (加密前)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
  "data": {
    "item_list": [
      {
        "extra_info": "ppt | 65 页",
        "image": "https://xxx.jpg",
        "labels": ["免费阅读", "新"],
        "read_num": "阅读量: 82",
        "source_extra": "二级教师",
        "source_icon": "https://xxx.jpg",
        "source_text": "小A",
        "title": "精编人教部编版2019四年级上册语文教学课件—2走月亮",
        "url": "/path/to/page"
      },
      {
        "extra_info": "word | 7 页",
        "image": "https://xxx.jpg",
        "labels": ["免费阅读", "新"],
        "read_num": "阅读量: 64",
        "source_extra": "教师",
        "source_icon": "https://xxx.jpg",
        "source_text": "元宝老师",
        "title": "精编部编版2019年五年级上册语文教案-2.落花生",
        "url": "/path/to/page"
      }
    ],
    "jump_url": "/path/to/page",
    "links": [
      {
        "text": "教案",
        "url": "/path/to/page"
      },
      {
        "text": "教学设计",
        "url": "/path/to/page"
      }
    ],
    "tag_list": [
      {
        "text": "全部",
        "url": "/path/to/page"
      },
      {
        "text": "一年级",
        "url": "/path/to/page"
      },
      {
        "text": "二年级",
        "url": "/path/to/page"
      },
      {
        "text": "三年级",
        "url": "/path/to/page"
      },
      {
        "text": "四年级",
        "url": "/path/to/page"
      },
      {
        "text": "五年级",
        "url": "/path/to/page"
      },
      {
        "text": "六年级",
        "url": "/path/to/page"
      }
    ]
  },
  "msg": "",
  "status": 0
}
停水（停电）信息查询 在线阅读
反 馈帮 助 回 到顶 部