# 获取ShortLink

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：generateShortLink

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

详情见[获取 Short Link](/miniprogram/dev/framework/open-ability/shortlink.md)。

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：shortlink.generate

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "page_url",
    "类型": "string",
    "必填": "是",
    "说明": "通过 Short Link 进入的小程序页面路径，必须是已经发布的小程序存在的页面，可携带 query，最大1024个字符"
  },
  {
    "参数名": "page_title",
    "类型": "string",
    "必填": "否",
    "说明": "短链标题，可自定义，不能包含违法信息，超过20字符会用... 截断代替"
  },
  {
    "参数名": "is_permanent",
    "类型": "boolean",
    "必填": "否",
    "说明": "默认值false。生成的 Short Link 类型，短期有效：false，永久有效：true"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码",
    "枚举": "枚举值"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息",
    "枚举": "-"
  },
  {
    "参数名": "link",
    "类型": "string",
    "说明": "生成的小程序 Short Link",
    "枚举": "-"
  }
]
```

## 4. 枚举信息

### Res.errcode `Enum`

错误码

```json
[
  {
    "枚举值": "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数量超过上限1000万"
  },
  {
    "枚举值": "43104",
    "描述": "this appid does not have permission；没有调用权限，参考api权限限制"
  }
]
```

## 5. 注意事项

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

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

## 6. 代码示例

请求示例

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

返回示例

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

## 7. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

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

## 8. 适用范围

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

![](https://res8.wxqcloud.qq.com.cn/wxdoc/56617deb-b17d-4cf1-bccd-71d2c41ccc76.svg)接口变更日志（1条）
2026 年 02 月 03 日更新  `page_title`  字段描述