小程序
取消
开发
中文
EN
取消
  • 服务端

    • # 搜一搜数据推送

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。

    接口英文名：submitpages

    小程序可以通过该功能推送优质内容的页面路径、参数和结构化数据等信息，让微信搜索可以更及时地收录到小程序内容，推送的内容将会被用于微信搜索结果展示，详情参考 内容接入。

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/wxa/search/wxaapi_submitpages?access_token=ACCESS_TOKEN

    # 云调用

    • 调用方法：search.submitPages

    • 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档。

    # 第三方调用

    • 本接口不支持第三方平台调用。

    # 2. 请求参数

    # 查询参数 Query String Parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token

    # 请求体 Request Payload

    参数名类型必填说明
    pagesobjarray是请求提交的小程序页面信息数组，一次可提交多个页面的信息。（注意：path+query标识唯一一个页面，微信侧会使用这个信息构造唯一id）

    # Body.pages(Array) Object Payload

    请求提交的小程序页面信息数组，一次可提交多个页面的信息。（注意：path+query标识唯一一个页面，微信侧会使用这个信息构造唯一id）

    参数名类型必填说明
    pathstring是以pages/开头的小程序页面路径。
    querystring是小程序页面请求参数
    data_listobjarray是小程序页面的数据，一个页面可以同时提交多个结构化信息

    # Body.pages(Array).data_listObject Payload

    小程序页面的数据，一个页面可以同时提交多个结构化信息

    参数名类型必填说明枚举
    @typestring是数据结构类型，用于标识目标业务系统枚举值
    updatenumber是更新字段；内容更新按照新增处理，如果页面路径（path+query）相同，微信会做覆盖更新。枚举值
    content_idstring是数据方自定义 id-
    page_typenumber是页面类型，固定填2-
    h5_urlstring否H5链接，推荐填写，如果该页面有对应的H5链接，则填上-
    titlestring是标题，长度建议在20个字-
    abstractarray否摘要，添加摘要有利于召回-
    refererstring否HTTP Referer，如果图片有防盗链逻辑，需要设置referer头，用于图片下载-
    cover_img_urlstring否封面图URL，图片url访问如果有有效期，建议设置为15天以上-
    mainbodystring是正文，不可带有html标签-
    authorobject否作者信息，推荐医疗类填写医生信息-
    videoobjarray否视频-
    time_publishnumber是发布时间，unix时间戳，单位秒-
    time_modifynumber是更新时间，unix时间戳，单位秒-
    extra_infoobject否补充字段，通用字段无法满足要求时，需要额外补充的字段，具体字段内容需要与微信协商-

    # Body.pages(Array).data_list.author Object Payload

    作者信息，推荐医疗类填写医生信息

    参数名类型必填说明
    author_namestring是作者名字
    author_titlestring否作者职务
    author_portraitstring否作者头像URL，头像尺寸不低于36px*36px。图片url访问如果有有效期，建议设置为15天以上

    # Body.pages(Array).data_list.videoObject Payload

    视频

    参数名类型必填说明
    video_titlestring否视频标题，如不填，则视为与页面标题一致
    video_lengthnumber是视频时长，单位为秒，优先五分钟内短视频
    video_imgstring是视频封面图URL，尺寸不低于686px*288px。图片url访问如果有有效期，建议设置为15天以上

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误描述

    # 4. 枚举信息

    # Body.pages(Array).data_list.@type Enum

    数据结构类型，用于标识目标业务系统

    枚举值描述
    wxsearch_cpdata正式数据，对应搜一搜正式环境，可被用户检索到
    wxsearch_testcpdata审核数据，对应搜一搜数据审核环境，用于数据审核及格式校验，不在搜索结果中展示

    # Body.pages(Array).data_list.update Enum

    更新字段；内容更新按照新增处理，如果页面路径（path+query）相同，微信会做覆盖更新。

    枚举值描述
    1新增
    3删除

    # 5. 注意事项

    本接口无特殊注意事项

    # 6. 代码示例

    请求示例

    {
    "pages": [
        {
            "path": "",
            "query": "",
            "data_list": [
                {
                    "@type": "",
                    "update": 0,
                    "content_id": "",
                    "page_type": 0,
                    "h5_url": "",
                    "title": "",
                    "abstract": [
                        ""
                    ],
                    "referer": "",
                    "cover_img_url": "",
                    "mainbody": "",
                    "author": {
                        "author_name": "",
                        "author_title": "",
                        "author_portrait": ""
                    },
                    "video": [
                        {
                            "video_title": "",
                            "video_length": 0,
                            "video_img": ""
                        }
                    ],
                    "time_publish": 0,
                    "time_modify": 0,
                    "extra_info": {}
                }
            ]
        }
    ]
}

    返回示例

    {
    "errcode": 0,
    "errmsg": ""
}

    # 7. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    40066invalid url小程序url配置了sitemap disallow
    40211invalid scope_data数据结构校验失败，附带进一步错误字段，如unexpected instance type: /content_id，表示content_id类型错误。
    40212invalid query不合法query
    40219pages is emptypages参数为空
    45002content size out of limithttp请求包过大，建议拆分或使用压缩
    47001data format errorhttp请求包不是合法Json
    47004submit pages count more than each quota每次提交的页面数超过1000（备注：每次提交页面数应小于或等于1000, 增量数据推荐单条推送）
    47006submit pages count reach daily limit, please try tomorrow当天提交页面数达到了配额上限，请明天再试（备注：每日限额页面数为50w）
    85083search status is banned小程序的搜索功能被禁用
    85091search status was turned off小程序的搜索开关被关闭。请访问设置页面打开
    108001system error系统失败，重试即可，请求中的页面可能部分成功
    108002page size out of limit单个页面大小超过阈值（最大为1M）
    108003permission denied审核数据前，需提交申请；推送正式数据前，需等待审核通过

    # 8. 适用范围

    本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明，均不可调用。