微信小程序 小程序搜索·siteSearch

2022-05-12 15:22 更新

search.siteSearch

本接口應(yīng)在服務(wù)器端調(diào)用,詳細(xì)說(shuō)明參見(jiàn)服務(wù)端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

小程序內(nèi)部搜索API提供針對(duì)頁(yè)面的查詢能力,小程序開發(fā)者輸入搜索詞后,將返回自身小程序和搜索詞相關(guān)的頁(yè)面。因此,利用該接口,開發(fā)者可以查看指定內(nèi)容的頁(yè)面被微信平臺(tái)的收錄情況;同時(shí),該接口也可供開發(fā)者在小程序內(nèi)應(yīng)用,給小程序用戶提供搜索能力。

調(diào)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請(qǐng)求地址

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

請(qǐng)求參數(shù)

屬性 類型 默認(rèn)值 必填 說(shuō)明
access_token string 接口調(diào)用憑證
keyword string 關(guān)鍵詞
next_page_info string 請(qǐng)求下一頁(yè)的參數(shù),開發(fā)者無(wú)需理解。為空時(shí)查詢的是第一頁(yè)內(nèi)容,如需查詢下一頁(yè),把返回參數(shù)的next_page_info填充到這里即可

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說(shuō)明
errcode string 錯(cuò)誤碼
errmsg string 錯(cuò)誤信息
items Array.<Object> 搜索結(jié)果列表
has_next_page boolean 是否有下一頁(yè)
next_page_info string 請(qǐng)求下一頁(yè)的參數(shù),開發(fā)者無(wú)需理解,如需查詢下一頁(yè)結(jié)果,把該參數(shù)填充到下頁(yè)請(qǐng)求參數(shù)中的next_page_info即可
hit_count number 估算索引文檔數(shù)

errcode 的合法值

說(shuō)明 最低版本
-1 系統(tǒng)繁忙,此時(shí)請(qǐng)開發(fā)者稍候再試
47101 搜索結(jié)果總數(shù)超過(guò)了1000條
47102 next_page_info參數(shù)錯(cuò)誤

items 的結(jié)構(gòu)

屬性 類型 說(shuō)明
title string 小程序頁(yè)面標(biāo)題
description string 小程序頁(yè)面摘要
image string 小程序頁(yè)面代表圖
path string 小程序頁(yè)面路徑

使用示例

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

調(diào)用成功時(shí)的返回示例

{
    "errcode":0,
    "errmsg":"ok",
    "items": [
        {
            "title": "<em class="highlight">微信</em>版本更新!",
            "description": "...今日,<em class="highlight">微信</em>官方發(fā)布<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>小程序發(fā)布新功能!",
            "description": "<em class="highlight">微信</em>小程序發(fā)布了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=="
}

云調(diào)用

云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過(guò) wx-server-sdk 使用。

接口方法

openapi.search.siteSearch
需在 config.json 中配置 search.siteSearch API 的權(quán)限,詳情

請(qǐng)求參數(shù)

屬性 類型 默認(rèn)值 必填 說(shuō)明
keyword string 關(guān)鍵詞
nextPageInfo string 請(qǐng)求下一頁(yè)的參數(shù),開發(fā)者無(wú)需理解。為空時(shí)查詢的是第一頁(yè)內(nèi)容,如需查詢下一頁(yè),把返回參數(shù)的next_page_info填充到這里即可

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說(shuō)明
errCode string 錯(cuò)誤碼
errMsg string 錯(cuò)誤信息
items Array.<Object> 搜索結(jié)果列表
hasNextPage boolean 是否有下一頁(yè)
nextPageInfo string 請(qǐng)求下一頁(yè)的參數(shù),開發(fā)者無(wú)需理解,如需查詢下一頁(yè)結(jié)果,把該參數(shù)填充到下頁(yè)請(qǐng)求參數(shù)中的next_page_info即可
hitCount number 估算索引文檔數(shù)

errCode 的合法值

說(shuō)明 最低版本
0 成功

items 的結(jié)構(gòu)

屬性 類型 說(shuō)明
title string 小程序頁(yè)面標(biāo)題
description string 小程序頁(yè)面摘要
image string 小程序頁(yè)面代表圖
path string 小程序頁(yè)面路徑

異常

Object

拋出的異常

屬性 類型 說(shuō)明
errCode string 錯(cuò)誤碼
errMsg string 錯(cuò)誤信息

errCode 的合法值


說(shuō)明 最低版本
-1 系統(tǒng)繁忙,此時(shí)請(qǐng)開發(fā)者稍候再試
47101 搜索結(jié)果總數(shù)超過(guò)了1000條
47102 next_page_info參數(shù)錯(cuò)誤


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)