# 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

# 请求参数

jump_wxa 的结构

# 返回值

# openlink

生成的小程序 scheme 码

# 异常返回

# Object

JSON

errcode 的合法值

# 返回值说明

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

# 示例

请求

{
    "jump_wxa":
    {
        "path": "/pages/publishHomework/publishHomework",
        "query": "a=1&b=2"
    },
    "expire_time":1606737600
}

返回

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

# 云调用

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

# 接口方法

openapi.urlscheme.generate

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

# 请求参数

jumpWxa 的结构

# 返回值

# openlink

生成的小程序 scheme 码

# 异常

# Object

JSON

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": 'a=1&b=2'
        },
        "expireTime": 1606737600
      })
    return result
  } catch (err) {
    return err
  }
}

返回

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