search.submitPages
本接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载)
wx-server-sdk >= 0.4.0
小程序开发者可以通过本接口提交小程序页面url及参数信息,让微信可以更及时的收录到小程序的页面信息,开发者提交的页面信息将可能被用于小程序搜索结果展示。
调用方式:
- HTTPS 调用
- 云调用
HTTPS 调用
请求地址
POST https://api.weixin.qq.com/wxa/search/wxaapi_submitpages?access_token=TOKEN
请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证 | |
pages | Array.<Object> | 是 | 小程序页面信息列表 |
pages 的结构
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
path | string | 是 | 页面路径 | |
query | string | 是 | 页面参数 |
返回值
Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errcode | string | 错误码 |
errmsg | string | 错误信息 |
errcode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
-1 | 系统繁忙,此时请开发者稍候再试 | |
0 | 请求成功 | |
40066 | 递交的页面被sitemap标记为拦截,具体查看errmsg提示。 | |
40210 | pages 中的path参数不存在或为空 | |
40212 | paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2 | |
40219 | pages不存在或者参数为空 | |
47001 | http请求包不是合法的JSON | |
47004 | 每次提交的页面数超过1000(备注:每次提交页面数应小于或等于1000) | |
47006 | 当天提交页面数达到了配额上限,请明天再试 | |
85091 | 小程序的搜索开关被关闭。请访问设置页面打开开关再重试 | |
85083 | 小程序的搜索功能被禁用 |
请求示例
curl -d '
{
"pages": [
{
"path": "pages/index/index",
"query": "userName=wechat_user"
},
{
"path": "pages/video/index",
"query": "vid=123"
}
]
}' https://api.weixin.qq.com/wxa/search/wxaapi_submitpages?access_token=TOKEN
云调用
云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。
接口方法
openapi.search.submitPages
需在 config.json 中配置 search.submitPages API 的权限,详情
请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
pages | Array.<Object> | 是 | 小程序页面信息列表 |
pages 的结构
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
path | string | 是 | 页面路径 | |
query | string | 是 | 页面参数 |
返回值
Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
errCode | string | 错误码 |
errMsg | string | 错误信息 |
errCode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
0 | 成功 |
异常
Object
抛出的异常
属性 | 类型 | 说明 |
---|---|---|
errCode | string | 错误码 |
errMsg | string | 错误信息 |
errCode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
-1 | 系统繁忙,此时请开发者稍候再试 | |
40066 | 递交的页面被sitemap标记为拦截,具体查看errmsg提示。 | |
40210 | pages 中的path参数不存在或为空 | |
40212 | paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2 | |
40219 | pages不存在或者参数为空 | |
47001 | http请求包不是合法的JSON | |
47004 | 每次提交的页面数超过1000(备注:每次提交页面数应小于或等于1000) | |
47006 | 当天提交页面数达到了配额上限,请明天再试 | |
85091 | 小程序的搜索开关被关闭。请访问设置页面打开开关再重试 | |
85083 | 小程序的搜索功能被禁用 |