# 获取已设置的二维码规则

调试工具

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

# 接口说明

# 接口英文名

getJumpQRCode

# 功能描述

该接口用于获取已设置的二维码规则

# 注意事项

# 调用说明

  • 该接口用于获取已设置的二维码规则,适用于获取“扫普通二维码打开小程序”已设置的二维码规则,也适用于获取“扫服务号二维码打开小程序”已设置的二维码规则。
  • 如果是获取“扫普通二维码打开小程序”已设置的二维码规则,则无需任何入参,使用小程序的authorizer_access_token即可调用。
  • 如果是获取“扫服务号二维码打开小程序”已设置的二维码规则,则需要传appid、get_type、prefix_list、page_num、page_size等参数,详情可查看下方文档说明。

# 服务号调用说明

  • 服务商要调用该个接口获取“扫服务号二维码打开小程序”已设置的二维码规则,必须要先获得服务号需将权限集 id 为3的权限集授权给服务商,否则会出现61007的报错。
  • 服务号要先关联小程序才可以调用该接口。如果服务号尚未关联小程序,可以通过关联小程序(linkMiniprogram)的接口去关联。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/cgi-bin/wxopen/qrcodejumpget?access_token=ACCESS_TOKEN 

# 第三方调用

  • 调用方式以及出入参和HTTPS相同,仅是调用的token不同

  • 该接口所属的权限集id为:3、18

  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用authorizer_access_token
appid string 小程序的appid。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。
get_type number 默认值为0。 0:查询最近新增 10000 条(数量大建议用1或者2);1:prefix查询;2:分页查询,按新增顺序返回。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。
prefix_list array<string> prefix查询,get_type=1 必传,最多传 200 个前缀。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。
page_num number 页码,get_type=2 必传,从 1 开始。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。
page_size number 每页数量,get_type=2 必传,最大为 200。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。

# 返回参数

属性 类型说明
errcode number 错误码
errmsg string 错误信息
rule_list array<object> 二维码规则详情列表
属性 类型 说明
prefix string 二维码规则,说明,服务号二维码规则已过滤不展示。
path string 小程序功能页面。
state number 发布标志位,1 表示未发布,2 表示已发布。
open_version number 测试范围。
获取“扫普通二维码打开小程序”已设置的二维码规则才返回这个参数。
1表示开发版(配置只对开发者生效);2表示体验版(配置对管理员、体验者生效);3表示正式版(配置对开发者、管理员和体验者生效)。
特别说明,不管普通二维码规则是否发布,开发者/体验者/管理员在扫描 debug_url 所对应的二维码时,都会根据 open_version 来决定打开开发版、体验版或正式版
debug_url array<string> 测试链接(选填)可填写不多于 5 个用于测试的二维码完整链接,此链接必须符合已填写的二维码规则。获取“扫普通二维码打开小程序”已设置的二维码规则才返回这个参数。
qrcodejump_open number 是否已经打开二维码跳转链接设置
list_size number 二维码规则数量
qrcodejump_pub_quota number 本月还可发布的次数
total_count number 二维码规则总数据量,用于分页查询

# 调用示例

示例说明: 获取“扫普通二维码打开小程序”已设置的二维码规则

# 请求数据示例


POST https://api.weixin.qq.com/cgi-bin/wxopen/qrcodejumpget?access_token=ACCESS_TOKEN
 

# 返回数据示例


{
  "errcode": 0,
  "errmsg": "ok",

  "rule_list": [
    {
      "prefix": "https://weixin.qq.com/qrcodejump",
      "open_version": 1,
      "state": 1,
      "permit_sub_rule": 1,
      "path": "pages / index / index ",
      "debug_url": [
        "https://weixin.qq.com/qrcodejump?a=1",
        "https://weixin.qq.com/qrcodejump?a=1",
        "https://weixin.qq.com/qrcodejump?a=2",
        "https: //weixin.qq.com/qrcodejump?a=2"
      ]
    },
    {
      "prefix": "https://weixin.qq.com/qrcodejumptest",
      "open_version": 1,
      "state": 1,
      "permit_sub_rule": 1,
      "path": "pages/index/index",
      "debug_url": [
        "https://weixin.qq.com/qrcodejumptest?a=1",
        "https://weixin.qq.com/qrcodejumptest?a=1",
        "https://weixin.qq.com/qrcodejumptest?a=2",
        "https: //weixin.qq.com/qrcodejumptest?a=2"
      ]
    }
  ],

  "qrcodejump_open": 0,
  "list_size": 2,
  "qrcodejump_pub_quota": 20,
"total_count":3
} 

示例说明: 获取“扫服务号二维码打开小程序”已设置的二维码规则

# 请求数据示例


{
  "appid": "wx444444"
}

 

# 返回数据示例


{
  "errcode": 0,
  "errmsg": "ok",

  "rule_list": [
    {
      "prefix": "https://weixin.qq.com/qrcodejump",
      "state": 1,
      "path": "pages/index/index"
    },
    {
      "prefix": "https://weixin.qq.com/qrcodejumptest",
      "state": 1,
      "path": "pages/index/index"
    }
  ],

  "qrcodejump_open": 0,
  "list_size": 2,
  "qrcodejump_pub_quota": 20,
  "total_count": 10
} 

# 错误码

错误码 错误描述 解决方案
40001 invalid credential  access_token isinvalid or not latest 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
40166 invalid appid appid 参数不合法
85075 can not access 个人类型小程序无法设置二维码规则
-1 system error 系统繁忙,此时请开发者稍候再试