查看页面收录情况

小程序内部搜索API提供针对页面的查询能力,小程序开发者输入搜索词后,将返回自身小程序和搜索词相关的页面。因此,利用该接口,开发者可以查看指定内容的页面被微信平台的收录情况;同时,该接口也可供开发者在小程序内应用,给小程序用户提供搜索能力。使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

请求地址

POST https://api.weixin.qq.com/wxa/sitesearch?access_token=TOKEN

请求参数

属性 类型 默认值 必填 说明
access_token String 第三方平台接口调用令牌authorizer_access_token
keyword string 关键词
next_page_info string 请求下一页的参数,开发者无需理解。为空时查询的是第一页内容,如需查询下一页,把返回参数的next_page_info填充到这里即可

请求示例

curl -d '
{
    "query": "微信",
    "next_page_info": ""
}' https://api.weixin.qq.com/wxa/sitesearch?access_token=TOKEN

返回值

返回的 JSON 数据包

属性 类型 说明
errcode string 错误码
errmsg string 错误信息
items Array.<Object> 搜索结果列表
has_next_page boolean 是否有下一页
next_page_info string 请求下一页的参数,开发者无需理解,如需查询下一页结果,把该参数填充到下页请求参数中的next_page_info即可
hit_count number 估算索引文档数

items 的结构

属性 类型 说明
title string 小程序页面标题
description string 小程序页面摘要
image string 小程序页面代表图
path string 小程序页面路径

调用成功时的返回示例

{
    "errcode":0,
    "errmsg":"ok",
    "items": [
        {
            "title": "<em class="highlight">微信</em>版本更新!",
            "description": "...今日,<em class="highlight">微信</em>官方发布<em class="highlight">微信</em>X.Y.Z版本...",
            "image": "http://image.weixin.qq.com/1.jpeg",
            "path": "pages/normal/index?id=20191210A0C29X00"
        },
        {
            "title": "<em class="highlight">微信</em>小程序发布新功能!",
            "description": "<em class="highlight">微信</em>小程序发布了XXX功能...",
            "image": "http://image.weixin.qq.com/2.jpeg",
            "path": "pages/normal/index?id=20191210A0C29X11"
        },
    ],
    "has_next_page": 1,
    "hit_count": 100,
    "next_page_info":"eyJwYWdlX3BhcmFtIjpbeyJzdWJzeXNfdHlwZSI6MTAsInNlcnZlcl9vZmZzZXQiOjAsInNlcnZlcl9saW1pdCI6MTIwLCJpbmRleF9zdGVwIjoyMCwiaW5kZXhfb2Zmc2V0IjoyMH1dLCJjbGllbnRfb2Zmc2V0IjowLCJjbGllbnRfbGltaXQiOjEwfQ=="
}

返回码说明

说明
0 请求成功
-1 系统繁忙,此时请开发者稍候再试
47101 搜索结果总数超过了1000条
47102 next_page_info参数错误
其他错误码 请查看全局错误码