# urlscheme.query

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

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

查询小程序 scheme 码。

调用方式:

# HTTPS 调用

# 请求地址

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

# 请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
scheme string 小程序 scheme 码

# 返回值

# Object

返回的 JSON 数据包。

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
scheme_info Object scheme 配置
visit_openid string 访问该链接的openid,没有用户访问过则为空字符串

errcode 的合法值

说明 最低版本
0 查询成功
-1 系统繁忙,稍后重试
40097 参数不合法
85403 scheme 不存在

scheme_info 的结构

属性 类型 说明
appid string 小程序 appid。
path string 小程序页面路径。
query string 小程序页面query。
create_time number 创建时间,为 Unix 时间戳。
expire_time number 到期失效时间,为 Unix 时间戳,0 表示永久生效
env_version string 要打开的小程序版本。正式版为"release",体验版为"trial",开发版为"develop"。

# 示例

请求

{
    "scheme": "weixin://dl/business/?t=XTSkBZlzqmn"
}

返回

{
 "errcode": 0,
 "errmsg": "ok",
 "scheme_info": {
   "appid": "appid",
   "path": "",
   "query": "",
   "create_time": 611928113,
   "expire_time": 0,
   "env_version": "release"
 },
 "visit_openid": ""
}

# 云调用

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

# 接口方法

openapi.urlscheme.query

需在 config.json 中配置 urlscheme.query API 的权限,详情

# 请求参数

属性 类型 默认值 必填 说明
scheme string 小程序 scheme 码

# 返回值

# Object

返回的 JSON 数据包。

属性 类型 说明
errCode number 错误码
errMsg string 错误信息
schemeInfo Object scheme 配置
visitOpenid string 访问该链接的openid,没有用户访问过则为空字符串

errCode 的合法值

说明 最低版本
0 成功

schemeInfo 的结构

属性 类型 说明
appid string 小程序 appid。
path string 小程序页面路径。
query string 小程序页面query。
createTime number 创建时间,为 Unix 时间戳。
expireTime number 到期失效时间,为 Unix 时间戳,0 表示永久生效
envVersion string 要打开的小程序版本。正式版为"release",体验版为"trial",开发版为"develop"。

# 异常

# Object

抛出的异常

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本
-1 系统繁忙,稍后重试
40097 参数不合法
85403 scheme 不存在

# 示例

请求

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.query({
        "scheme": 'weixin://dl/business/?t=XTSkBZlzqmn'
      })
    return result
  } catch (err) {
    return err
  }
}

返回

{
 "errcode": 0,
 "errmsg": "ok",
 "scheme_info": {
   "appid": "appid",
   "path": "",
   "query": "",
   "create_time": 611928113,
   "expire_time": 0,
   "env_version": "release"
 },
 "visit_openid": ""
}