# urllink.query

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

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

查询小程序 url_link 配置。

调用方式：

HTTPS 调用
云调用

# HTTPS 调用

# 请求地址

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

# 请求参数

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

# 返回值

# Object

返回的 JSON 数据包。

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

errcode 的合法值

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

url_link_info 的结构

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

cloud_base 的结构

属性	类型	说明
env	string	云开发环境
domain	string	静态网站自定义域名，不填则使用默认域名
path	string	云开发静态网站 H5 页面路径，不可携带 query
query	string	云开发静态网站 H5 页面 query 参数
resource_appid	string	第三方批量代云开发时必填，表示创建该 `env` 的 appid （小程序/第三方平台）

# 示例

请求

{
    "url_link": "https://wxaurl.cn/BQZRrcFCPvg"
}

{
 "errcode": 0,
 "errmsg": "ok",
 "url_link_info": {
   "appid": "appid",
   "path": "",
   "query": "",
   "create_time": 611928113,
   "expire_time": 0,
   "env_version": "release",
   "cloud_base" : {
     "env": "",
     "doamin": "",
     "path": "",
     "query": "",     
     "resource_appid": ""
   }
 },
 "visit_openid": ""
}

# 云调用

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

# 接口方法

openapi.urllink.query

需在 config.json 中配置 urllink.query API 的权限，详情

# 请求参数

属性	类型	默认值	必填	说明
urlLink	string		是	小程序 url_link

# 返回值

# Object

返回的 JSON 数据包。

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

errCode 的合法值

值	说明	最低版本
0	成功

urlLinkInfo 的结构

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

cloudBase 的结构

属性	类型	说明
env	string	云开发环境
domain	string	静态网站自定义域名，不填则使用默认域名
path	string	云开发静态网站 H5 页面路径，不可携带 query
query	string	云开发静态网站 H5 页面 query 参数
resourceAppid	string	第三方批量代云开发时必填，表示创建该 `env` 的 appid （小程序/第三方平台）

# 异常

# Object

抛出的异常

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

errCode 的合法值

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

# 示例

请求

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.urllink.query({
        "urlLink": 'https://wxaurl.cn/BQZRrcFCPvg'
      })
    return result
  } catch (err) {
    return err
  }
}

{
 "errcode": 0,
 "errmsg": "ok",
 "url_link_info": {
   "appid": "appid",
   "path": "",
   "query": "",
   "create_time": 611928113,
   "expire_time": 0,
   "env_version": "release",
   "cloud_base" : {
     "env": "",
     "doamin": "",
     "path": "",
     "query": "",     
     "resource_appid": ""
   }
 },
 "visit_openid": ""
}