# 获取ShortLink
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
# 接口说明
# 接口英文名
generateShortLink
# 功能描述
获取小程序 Short Link,适用于微信内拉起小程序的业务场景。目前只开放给电商类目(具体包含以下一级类目:电商平台、商家自营、跨境电商)。通过该接口,可以选择生成到期失效和永久有效的小程序短链,详见获取 Short Link。
# 注意事项
# 调用上限
Link 将根据是否为到期有效与失效时间参数,分为 短期有效ShortLink 与 永久有效ShortLink:
- 单个小程序每日生成 ShortLink 上限为100万个(包含短期有效 ShortLink 与长期有效 ShortLink )
- 单个小程序总共可生成永久有效 ShortLink 上限为10万个,请谨慎调用。
- 短期有效ShortLink 有效时间为30天,单个小程序生成短期有效ShortLink 不设上限。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/genwxashortlink?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.shortlink.generate
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:88、115
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token |
page_url | string | 是 | 通过 Short Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,可携带 query,最大1024个字符 |
page_title | string | 否 | 页面标题,不能包含违法信息,超过20字符会用... 截断代替 |
is_permanent | boolean | 否 | 默认值false。生成的 Short Link 类型,短期有效:false,永久有效:true |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
link | string | 生成的小程序 Short Link |
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
{
"page_url": "pages/publishHomework/publishHomework?query1=q1",
"page_title": "Homework title",
"is_permanent":false
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"link": "Short 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.shortlink.generate({
"pageUrl": 'pages/publishHomework/publishHomework?query1=q1',
"pageTitle": 'Homework title',
"isPermanent": false
})
return result
} catch (err) {
return err
}
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"link": "Short Link"
}
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
40066 | invalid url | url不存在,即,已发布小程序没有对应url |
40225 | invalid page title | 无效的页面标题 |
85400 | reach max long time quota limit | 长期有效Scheme或short link达到生成上限10万,不可再生成。 |
45009 | 单天生成Short Link数量超过上限100万 | |
43104 | this appid does not have permission | 没有调用权限,目前只开放给电商类目(具体包含以下一级类目:电商平台、商家自营、跨境电商) |