# 增加或修改二维码规则

调试工具

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

# 接口说明

# 接口英文名

addJumpQRCode

# 功能描述

该接口用于增加或修改二维码规则

# 注意事项

# 调用说明

  • 该接口用于增加或修改二维码规则,适用于增加或修改“扫普通二维码打开小程序”的二维码规则,也适用于增加或修改“扫服务号二维码打开小程序”的二维码规则。
  • 如果是增加或修改“扫普通二维码打开小程序”的二维码规则,则涉及参数为prefix、permit_sub_rule、path、open_version、debug_url、is_edit。
  • 如果是增加或修改“扫服务号二维码打开小程序”的二维码规则,则涉及参数prefix、appid、path、is_edit,详情可查看下方文档说明。

# 服务号调用说明

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

# 调用方式

# HTTPS 调用


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

# 第三方调用

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

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

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

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用authorizer_access_token
is_edit number 编辑标志位,0 表示新增二维码规则,1 表示修改已有二维码规则。
prefix string 二维码规则。
path string 小程序功能页面。
open_version number 测试范围。
1表示开发版(配置只对开发者生效);2表示体验版(配置对管理员、体验者生效);3表示正式版(配置对开发者、管理员和体验者生效)。
增加或修改“扫普通二维码打开小程序”的二维码规则才需要传这个参数。
debug_url array<string> 测试链接,至多 5 个用于测试的二维码完整链接,此链接必须符合已填写的二维码规则。
增加或修改“扫普通二维码打开小程序”的二维码规则才需要传这个参数。
permit_sub_rule number 是否独占符合二维码前缀匹配规则的所有子规 1 为不占用,2 为占用。查看详细规则
增加或修改“扫普通二维码打开小程序”的二维码规则才需要传这个参数。
appid string 扫了服务号二维码之后要跳转的小程序的appid。增加或修改“扫服务号二维码打开小程序”的二维码规则才需要传这个参数。

# 返回参数

属性 类型 说明
errcode number 错误码
errmsg string 错误信息

# 其他说明

  • 不管普通二维码规则是否发布,开发者/体验者/管理员在扫描 debug_url 所对应的二维码时,都会根据 open_version 来决定打开开发版、体验版或正式版。

# 调用示例

示例说明: 增加或修改“扫普通二维码打开小程序”的二维码规则

# 请求数据示例


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

# 返回数据示例


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

示例说明: 增加或修改“扫服务号二维码打开小程序”的二维码规则

# 请求数据示例


{
  "prefix": "http://weixin.qq.com/q/kZgfwMTm72Wxxxx",
  "appid": “wxxxxxx”,
  "path": "pages/index/index",
  "is_edit": 0
} 

# 返回数据示例


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

# 错误码

错误码 错误描述 解决方案
-1 system error 系统繁忙,此时请开发者稍候再试
40001 invalid credential  access_token isinvalid or not latest 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
85066 illegal prefix 链接错误
85070 prefix in black list 个人类型小程序无法设置二维码规则
85071 prefix added repeated 已添加该链接,请勿重复添加
85072 prefix owned by other 该链接已被占用
85073 prefix beyond limit 前缀个数已满
85075 can not access 个人类型小程序无法设置二维码规则
40166 invalid appid appid 参数不合法
85068 test url is not the sub  prefix 测试链接不是子链接
85069 check confirm file fail 校验文件失败
85076 check ICP fail 检查ICP失败
44990 reach max api second frequence limit 频率过快,超过5次/秒;降低调用频率