# 查询scheme码

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

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

接口英文名：queryScheme

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：urlscheme.query

- 出入参和 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](/minigame/dev/api-backend/access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "scheme",
    "类型": "string",
    "必填": "否",
    "说明": "小程序 scheme 码。支持加密 scheme 和明文 scheme"
  },
  {
    "参数名": "query_type",
    "类型": "number",
    "必填": "否",
    "说明": "查询类型。默认值0，查询  scheme 码信息：0， 查询每天剩余访问次数：1"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "scheme_info",
    "类型": "object",
    "说明": "scheme 信息"
  },
  {
    "参数名": "quota_info",
    "类型": "object",
    "说明": "quota 配置"
  }
]
```

### Res.scheme_info `Object Payload`

scheme 信息

```json
[
  {
    "参数名": "appid",
    "类型": "string",
    "说明": "小程序 appid"
  },
  {
    "参数名": "path",
    "类型": "string",
    "说明": "小程序页面路径"
  },
  {
    "参数名": "query",
    "类型": "string",
    "说明": "小程序页面query"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "创建时间，为 Unix 时间戳"
  },
  {
    "参数名": "expire_time",
    "类型": "number",
    "说明": "到期失效时间，为 Unix 时间戳，0 表示永久生效"
  },
  {
    "参数名": "env_version",
    "类型": "string",
    "说明": "要打开的小程序版本。正式版为\"release\"，体验版为\"trial\"，开发版为\"develop\""
  }
]
```

### Res.quota_info `Object Payload`

quota 配置

```json
[
  {
    "参数名": "remain_visit_quota",
    "类型": "number",
    "说明": "URL Scheme（加密+明文）/加密 URL Link 单天剩余访问次数"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

### 5.1 查询加密 scheme

请求示例

```json
{
  "scheme": "weixin://dl/business/?t=XTSkBZlzqmn&cq=a=hello",
  "query_type": 0
}
```

返回示例

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

### 5.2 查询明文 scheme

请求示例

```json
{
  "scheme": "weixin://dl/business/?appid=xxx&path=xxx&query=a=1&b=2&env_version=release",
  "query_type": 0
}
```

返回示例

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

### 5.3 查询剩余访问次数

请求示例

```json
{
  "query_type": 1
}
```

返回示例

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

### 5.4 云函数调用示例

请求示例

```json
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
  }
}
```

返回示例

```json
{
  "errCode": 0,
  "errMsg": "ok",
  "schemeInfo": {
    "appid": "appid",
    "path": "",
    "query": "",
    "createTime": 611928113,
    "expireTime": 0,
    "envVersion": "release"
  }
}
```

## 6. 错误码

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

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

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "小游戏": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。