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

    • # 获取商业化URL Link

    接口应在服务器端调用，详细说明参见服务端API。

    # 接口说明

    # 接口英文名

    generateCommercialUrlLink

    # 功能描述

    • 该接口用于获取小程序商业化 URL Link，适用于短信、邮件、网页、微信内等拉起小程序的业务场景。商业化 URL Link 有数量限制，目前仅针对国内非个人主体的小程序开放，商业化 URL Link 相较于普通 URL Link，支持了同一个 URL Link 可以被多个用户访问的特性。

    # 调用方式

    # HTTPS 调用

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

    # 第三方调用

    • 调用方式以及出入参和HTTPS相同，仅是调用的token不同

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

    • 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

    # 请求参数

    属性 类型 必填说明
    access_token string 是 接口调用凭证，该参数为 URL 参数，非 Body 参数。使用getAccessToken 或者 authorizer_access_token
    path string 是 通过 URL Link 进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query 。path 为空时会跳转小程序主页
    query string 是 通过 URL Link 进入小程序时的query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~%
    expire_type number 是 默认值0。小程序 URL Link 失效类型，失效时间：0，失效间隔天数：1
    expire_time number 是 到期失效的 URL Link 的失效时间，为 Unix 时间戳。生成的到期失效 URL Link 在该时间前有效。最长有效期为30天。expire_type 为 0 必填。
    expire_interval number 是 到期失效的URL Link的失效间隔天数。生成的到期失效URL Link在该间隔时间到达前有效。最长间隔天数为30天。expire_type 为 1 必填。
    cloud_base object 是 云开发静态网站自定义 H5 配置参数，可配置中转的云开发 H5 页面。不填默认用官方 H5 页面。
    属性 类型 必填 说明
    env string 否
    domain string 否
    path string 否
    query string 否
    resource_appid string 否
    env_version string 是 默认值"release"。要打开的小程序版本。正式版为 "release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。

    # 返回参数

    属性 类型 说明
    errcode number 错误码
    errmsg string 错误信息
    url_link string 生成的小程序 URL Link

    # 调用示例

    示例说明: HTTPS请求示例

    # 请求数据示例

    
{
    "path": "/pages/publishHomework/publishHomework",
    "query": "",
    "expire_type":1,
    "expire_interval":1,
    "env_version": "release",
    "cloud_base":
    {
        "env": "xxx",
        "domain": "xxx.xx",
        "path": "/jump-wxa.html",
        "query": "a=1&b=2"
    }
}

    # 返回数据示例

    
{
    "errcode": 0,
    "errmsg": "ok",
    "url_link": "URL Link"
}

    # 错误码

    错误码 错误码取值 解决方案
    -1 system error 系统繁忙，此时请开发者稍候再试
    40001 invalid credential  access_token isinvalid or not latest 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
    40002 暂无生成权限（非个人主体小程序无权限，未申请 NFC 能力的小程序无权限）
    40165 invalid weapp pagepath 参数path填写错误，更正后重试
    40212 invalid query 参数query填写错误 ，query格式遵循URL标准，即k1=v1&k2=v2
    44990 reach max api second frequence limit 频率过快，超过100次/秒；降低调用频率
    45009 reach max api daily quota limit 调用超过天级别频率限制。可调用clear_quota接口恢复调用额度。
    85079 miniprogram has no online release 小程序没有线上版本，即小程序尚未发布，不可进行该操作
    85400 reach max long time quota limit 长期有效Scheme或short link达到生成上限10万，不可再生成。
    85401 time limit between 1min and 1year 参数expire_time填写错误，时间间隔大于1分钟且小于1年，更正后重试
    85402 invalid env_version 参数env_version填写错误，更正后重试
    85404 appid has no enough quota quota余额不足，增加quota后重试

    # 调试

    通过开发者工具的”快速 URL Link编译“可以调试生成的 URL Link 自定义编译条件