微信小程序
获取 URL Link
# 获取URLLink
调试工具
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >= 1.02.1904090
(最新稳定版下载),wx-server-sdk
>= 0.4.0
# 接口说明
# 接口英文名
generateUrlLink
# 功能描述
获取小程序 URL Link,适用于短信、邮件、网页、微信内等拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放,详见获取 URL Link
# 注意事项
# 调用上限
- 每天生成 URL Scheme 和 URL Link 总数量上限为50万
- 自 2022 年 4 月 11 日起,URL Link有效期最长 30 天,不再支持永久有效的URL Link、不再区分短期有效URL Link与长期有效URL Link。若在微信外打开,用户可以在浏览器页面点击进入小程序。每个独立的URL Link被用户访问后,仅此用户可以再次访问并打开对应小程序,其他用户无法再次通过相同URL Link打开该小程序。在本次规则调整生效前已经生成的URL Link,如果有效期超过30天或长期会被降级为30天有效,只能被1个用户访问,开始时间从调整日期开始计算。详细调整说明可见《小程序链接生成与使用规则调整公告》
# 返回值说明
- 如果调用成功,会直接返回生成的小程序 URL Link。如果请求失败,会返回 JSON 格式的数据。
# 其他注意事项
- 只能生成已发布的小程序的 URL Link。
- 在微信内或者安卓手机打开 URL Link 时,默认会先跳转官方 H5 中间页,如果需要定制 H5 内容,可以使用云开发静态网站。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/generate_urllink?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.urllink.generate
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:88、115
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
# 返回参数
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
{
"path": "/pages/publishHomework/publishHomework",
"query": "",
"is_expire":true,
"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"
}
示例说明: 云函数调用
# 请求数据示例
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": '',
"isExpire": true,
"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",
"urlLink": "URL Link"
}