# urllink.generate

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

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

获取小程序 URL Link,适用于短信、邮件、网页、微信内等拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放,详见获取 URL Link

调用方式:

# HTTPS 调用

# 请求地址

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

# 请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
path string 通过 URL Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,不可携带 query 。path 为空时会跳转小程序主页
query string 通过 URL Link 进入小程序时的query,最大1024个字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~%
env_version string "release" 要打开的小程序版本。正式版为 "release",体验版为"trial",开发版为"develop",仅在微信外打开时生效。
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 页面

cloud_base 的结构

属性 类型 默认值 必填 说明
env string 云开发环境
domain string 静态网站自定义域名,不填则使用默认域名
path string / 云开发静态网站 H5 页面路径,不可携带 query
query string 云开发静态网站 H5 页面 query 参数,最大 1024 个字符,只支持数字,大小写英文以及部分特殊字符:`!#$&'()*+,/:;=?@-._~%``
resource_appid string 第三方批量代云开发时必填,表示创建该 env 的 appid (小程序/第三方平台)

# 返回值

生成的小程序 URL Link

# 异常返回

# Object

JSON

属性 类型 说明
errcode number 错误码
errmsg string 错误信息

errcode 的合法值

说明 最低版本
-1 系统繁忙,请稍后重试
40002 暂无生成权限(非个人主体小程序无权限)
40013 生成权限被封禁
85079 小程序未发布
40165 参数 path 填写错误
40212 参数 query 填写错误
85401 参数expire_time填写错误,时间间隔大于1分钟且小于31年
85402 参数env_version填写错误
44990 生成URL Link频率过快(超过200次/秒)
44993 单天生成Scheme+URL Link数量超过上限50万
其他 云开发cloud_base参数错误码

# 返回值说明

如果调用成功,会直接返回生成的小程序 URL Link。如果请求失败,会返回 JSON 格式的数据。

# 示例

请求

{
    "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"
}

# 云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

# 接口方法

openapi.urllink.generate

需在 config.json 中配置 urllink.generate API 的权限,详情

# 请求参数

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

cloudBase 的结构

属性 类型 默认值 必填 说明
env string 云开发环境
domain string 静态网站自定义域名,不填则使用默认域名
path string / 云开发静态网站 H5 页面路径,不可携带 query
query string 云开发静态网站 H5 页面 query 参数,最大 1024 个字符,只支持数字,大小写英文以及部分特殊字符:`!#$&'()*+,/:;=?@-._~%``
resourceAppid string 第三方批量代云开发时必填,表示创建该 env 的 appid (小程序/第三方平台)

# 返回值

生成的小程序 URL Link

# 异常

# Object

JSON

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本

# 示例

请求

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.urllink.generate({
        "path": '/pages/publishHomework/publishHomework',
        "query": '',
        "expireType": 1,
        "expireInterval": 1,
        "envVersion": 'release',
        "cloudBase": {
          "env": 'xxx',
          "domain": 'xxx.xx',
          "path": '/jump-wxa.html',
          "query": 'a=1&b=2'
        }
      })
    return result
  } catch (err) {
    return err
  }
}

返回

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