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

    • # 获取ShortLink

    调试诊断

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

    接口英文名：generateShortLink

    获取小程序 Short Link，适用于微信内拉起小程序的业务场景。目前对所有非个人主体小程序开放。通过该接口，可以选择生成到期失效和永久有效的小程序短链，详情见获取 Short Link。

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 调用方法：shortlink.generate

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

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：88

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

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

    # 请求体 Request Payload

    参数名类型必填说明
    page_urlstring是通过 Short Link 进入的小程序页面路径，必须是已经发布的小程序存在的页面，可携带 query，最大1024个字符
    page_titlestring否页面标题，不能包含违法信息，超过20字符会用... 截断代替
    is_permanentboolean否默认值false。生成的 Short Link 类型，短期有效：false，永久有效：true

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明枚举
    errcodenumber错误码 枚举值
    errmsgstring错误信息 -
    linkstring生成的小程序 Short Link -

    # 4. 枚举信息

    # Res.errcode Enum

    错误码

    枚举值描述
    40001invalid credential access_token isinvalid or not latest； 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
    40066invalid url；url不存在，即，已发布小程序没有对应url
    40225invalid page title；无效的页面标题
    85400reach max long time quota limit；长期有效Scheme或short link达到生成上限10万，不可再生成。
    45009单天生成Short Link数量超过上限100万
    43104this appid does not have permission；没有调用权限，参考api权限限制

    # 5. 注意事项

    # 调用上限

    Link 将根据是否为到期有效与失效时间参数，分为 短期有效ShortLink 与 永久有效ShortLink：

    • 单个小程序每日生成 ShortLink 上限为100万个（包含短期有效 ShortLink 与长期有效 ShortLink ）
    • 单个小程序总共可生成永久有效 ShortLink 上限为10万个，请谨慎调用。
    • 短期有效ShortLink 有效时间为30天，单个小程序生成短期有效ShortLink 不设上限。

    # 6. 代码示例

    请求示例

    { "page_url": "pages/publishHomework/publishHomework?query1=q1", "page_title": "Homework title", "is_permanent":false }

    返回示例

    { "errcode": 0, "errmsg": "ok", "link": "Short Link" }

    # 7. 错误码

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

    错误码错误描述解决方案
    40001invalid credential access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
    40066invalid urlurl不存在，即，已发布小程序没有对应url
    40225invalid page title无效的页面标题
    43104this appid does not have permission没有调用权限，目前只开放给电商类目（具体包含以下一级类目：电商平台、商家自营、跨境电商）
    45009单天生成Short Link数量超过上限100万
    85400reach max long time quota limit长期有效Scheme或short link达到生成上限10万，不可再生成。

    # 8. 适用范围

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