# 设置二维码规则

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:qrcodeJumpAdd

本接口用于增加或修改服务号二维码规则为小程序二维码规则

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

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

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
prefixstringhttp://weixin.qq.com/q/kZgfwMTm72Wxxxx二维码规则,填服务号的带参二维码url ,必须是http://weixin.qq.com/q/开头的url,例如http://weixin.qq.com/q/02P5KzM_xxxxx
appidstringwxxxxxx这里填要扫了服务号二维码之后要跳转的小程序的appid
pathstringpages/index/index小程序功能页面
is_editnumber0编辑标志位,0 表示新增二维码规则,1 表示修改已有二维码规则(注意,已经发布的规则,不支持修改)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息

# 4. 注意事项

# 调用说明

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

# 服务号调用说明

  • 服务商要调用该个接口,必须要先获得服务号需将权限集 id 为3的权限集授权给服务商,否则会出现61007的报错。
  • 服务号要先关联小程序才可以调用该接口。如果服务号尚未关联小程序,可以通过关联小程序(linkMiniprogram)的接口,或在「公众号管理后台-广告与服务-小程序管理」关联小程序。

# 5. 代码示例

# 5.1 增加或修改“扫普通二维码打开小程序”的二维码规则

请求示例

{
  "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"
}

# 5.2 增加或修改“扫服务号二维码打开小程序”的二维码规则

请求示例

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

返回示例

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

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
-1系统繁忙请重试
0ok成功
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
40097invalid args已发布规则不支持修改
40166 invalid appidappid 参数不合法
44990接口请求太快超过5次/秒
85066链接错误检查链接合法性
85068test url is not the sub  prefix测试链接不是子链接
85069check confirm file fail校验文件失败
85070URL命中黑名单无法添加
85071链接重复请勿重复添加
85072链接被占用检查链接归属
85073规则数已满超出数量限制
85075个人小程序限制无法设置规则
85076 check ICP fail检查ICP失败
886001系统繁忙请重试

# 7. 适用范围

本接口支持「服务号(仅认证)」账号类型调用。其他账号类型如无特殊说明,均不可调用。