urlscheme.generate
- HTTPS 调用
- 云调用

urlscheme.generate

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

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

获取小程序scheme码，适用于短信、邮件、外部网页等拉起小程序的业务场景。通过该接口，可以选择生成到期失效和永久有效的小程序码，目前仅针对国内非个人主体的小程序开放，详见获取URL scheme码。

调用方式：

HTTPS 调用
云调用

HTTPS 调用

请求地址

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

请求参数

属性	类型	默认值	必填	说明
access_token	string		是	接口调用凭证
jump_wxa	Object		否	跳转到的目标小程序信息。
is_expire	boolean	false	否	生成的scheme码类型，到期失效：true，永久有效：false。
expire_time	number		否	到期失效的scheme码的失效时间，为Unix时间戳。生成的到期失效scheme码在该时间前有效。最长有效期为1年。生成到期失效的scheme时必填。

jump_wxa 的结构

属性	类型	默认值	必填	说明
path	string		是	通过scheme码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带query。path为空时会跳转小程序主页。
query	string		是	通过scheme码进入小程序时的query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：!#$&’()*+,/:;=?@-._~

返回值

openlink

生成的小程序scheme码

异常返回

Object

JSON

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

errcode 的合法值

值	说明	最低版本
40002	暂无生成权限
40013	生成权限被封禁
85079	小程序未发布
40165	参数path填写错误
40212	参数query填写错误
85401	参数expire_time填写错误，时间间隔大于1分钟且小于1年
44990	生成Scheme频率过快（超过100次/秒）
85400	长期有效Scheme达到生成上限10万
45009	单天生成Scheme数量超过上限50万

返回值说明

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

示例

请求

{
    "jump_wxa":
    {
        "path": "/pages/publishHomework/publishHomework",
        "query": ""
    },
    "is_expire":true,
    "expire_time":1606737600
}

{
 "errcode": 0,
 "errmsg": "ok",
 "openlink": Scheme,
}

云调用

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

接口方法

openapi.urlscheme.generate

需在 config.json 中配置 urlscheme.generate API 的权限，详情

请求参数

属性	类型	默认值	必填	说明
jumpWxa	Object		否	跳转到的目标小程序信息。
isExpire	boolean	false	否	生成的scheme码类型，到期失效：true，永久有效：false。
expireTime	number		否	到期失效的scheme码的失效时间，为Unix时间戳。生成的到期失效scheme码在该时间前有效。最长有效期为1年。生成到期失效的scheme时必填。

jumpWxa 的结构

属性	类型	默认值	必填	说明
path	string		是	通过scheme码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带query。path为空时会跳转小程序主页。
query	string		是	通过scheme码进入小程序时的query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：!#$&’()*+,/:;=?@-._~

返回值

openlink

生成的小程序scheme码

异常

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.urlscheme.generate({
        jumpWxa: {
          path: '/pages/publishHomework/publishHomework',
          query: ''
        },
        isExpire: true,
        expireTime: 1606737600
      })
    return result
  } catch (err) {
    return err
  }
}

{
 "errcode": 0,
 "errmsg": "ok",
 "openlink": Scheme,
}