查询scheme码

查询scheme码

调试工具

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

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

接口说明

接口英文名

queryScheme

功能描述

该接口用于查询小程序 scheme 码，包括加密 scheme 和明文 scheme

调用方式

HTTPS 调用

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

云调用

• 出入参和HTTPS调用相同，调用方式可查看云调用说明文档
• 接口方法为: openapi.urlscheme.query

第三方调用

• 调用方式以及出入参和HTTPS相同，仅是调用的token不同
• 该接口所属的权限集id为：88、115
• 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token
scheme	string	否	小程序 scheme 码。支持加密 scheme 和明文 scheme
query_type	number	否	查询类型。默认值0，查询 scheme 码信息：0， 查询每天剩余访问次数：1

返回参数

	属性	类型	说明
	errcode	number	错误码
	errmsg	string	错误信息
	scheme_info	object	scheme 信息
	属性类型说明appidstring小程序 appidpathstring小程序页面路径querystring小程序页面querycreate_timenumber创建时间，为 Unix 时间戳expire_timenumber到期失效时间，为 Unix 时间戳，0 表示永久生效env_versionstring要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop"
	quota_info	object	quota 配置
	属性类型说明remain_visit_quotanumberURL Scheme（加密+明文）/加密 URL Link 单天剩余访问次数

调用示例

示例说明: 查询加密 scheme

请求数据示例

{
    "scheme": "weixin://dl/business/?t=XTSkBZlzqmn&cq=a%3Dhello",
    "query_type": 0
}

返回数据示例

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

示例说明: 查询明文 scheme

请求数据示例

{
    "scheme": "weixin://dl/business/?appid=xxx&path=xxx&query=a%3D1%26b%3D2&env_version=release",
     "query_type": 0
}

返回数据示例

{
 "errcode": 0,
 "errmsg": "ok",
 "scheme_info": {
   "appid": "appid",
   "path": "xxx",
   "query": "a=1&b=2",
   "env_version": "release"
 }
} 

示例说明: 查询剩余访问次数

请求数据示例

{ 
    "query_type": 1
} 

返回数据示例

{
 "errcode": 0,
 "errmsg": "ok",
 "quota_info": {
   "remain_visit_quota": 1000000
   }
 }
} 

示例说明: 云函数调用示例

请求数据示例

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",
 "schemeInfo": {
   "appid": "appid",
   "path": "",
   "query": "",
   "createTime": 611928113,
   "expireTime": 0,
   "envVersion": "release"
 }
} 

错误码

错误码	错误描述	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
85403	not found	scheme/url link不存在
40097	invalid args	参数错误
0	ok	ok
40002	invalid grant_type	暂无生成权限（非个人主体小程序无权限，未申请 NFC 能力的小程序无权限）
40165	invalid weapp pagepath	参数path填写错误，更正后重试
40212	invalid query	参数query填写错误 ，query格式遵循URL标准，即k1=v1&k2=v2
85402	invalid env_version	参数env_version填写错误，更正后重试
85405	appid or path not support plain scheme	小程序 appid 或者 path 未开启明文 scheme