# 增加或修改二维码规则

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

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

接口英文名：qrcodeJumpAdd

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

- 该接口所属的权限集 id 为：3、18

- 服务商获得其中之一权限集授权后，可通过使用 [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](/doc/service/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "prefix",
    "类型": "string",
    "必填": "是",
    "示例": "http://weixin.qq.com/q/kZgfwMTm72Wxxxx",
    "说明": "二维码规则。"
  },
  {
    "参数名": "appid",
    "类型": "string",
    "必填": "是",
    "示例": "wxxxxxx",
    "说明": "扫了服务号二维码之后要跳转的小程序的appid。增加或修改“扫服务号二维码打开小程序”的二维码规则才需要传这个参数。"
  },
  {
    "参数名": "path",
    "类型": "string",
    "必填": "是",
    "示例": "pages/index/index",
    "说明": "小程序功能页面。"
  },
  {
    "参数名": "is_edit",
    "类型": "number",
    "必填": "是",
    "示例": "0",
    "说明": "编辑标志位，0 表示新增二维码规则，1 表示修改已有二维码规则（注意，已经发布的规则，不支持修改）"
  },
  {
    "参数名": "open_version",
    "类型": "number",
    "必填": "是",
    "示例": "-",
    "说明": "测试范围。\n1表示开发版（配置只对开发者生效）；2表示体验版（配置对管理员、体验者生效)；3表示正式版（配置对开发者、管理员和体验者生效）。\n增加或修改“扫普通二维码打开小程序”的二维码规则才需要传这个参数。"
  },
  {
    "参数名": "debug_url",
    "类型": "array",
    "必填": "否",
    "示例": "-",
    "说明": "测试链接，至多 5 个用于测试的二维码完整链接，此链接必须符合已填写的二维码规则。\n增加或修改“扫普通二维码打开小程序”的二维码规则才需要传这个参数。"
  },
  {
    "参数名": "permit_sub_rule",
    "类型": "number",
    "必填": "是",
    "示例": "-",
    "说明": "是否独占符合二维码前缀匹配规则的所有子规 1 为不占用，2 为占用。[查看详细规则](/miniprogram/introduction/qrcode.md)\n增加或修改“扫普通二维码打开小程序”的二维码规则才需要传这个参数。"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

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

### 服务号调用说明

- 服务商要调用这个接口，必须要先获得服务号需将权限集 id 为3的[权限集](/doc/oplatform/Third-party_Platforms/2.0/product/offical_account_authority.md)授权给服务商，否则会出现61007的报错。[排错指南](/doc/oplatform/Third-party_Platforms/2.0/troubleshooting/third_party_authority_instructions_troubleshooting.md)
- 服务号要先关联小程序才可以调用该接口。如果服务号尚未关联小程序，可以通过关联小程序([linkMiniprogram](/doc/oplatform/openApi/ams/percentage/api_getshareratio.md))的接口，或在「公众号管理[后台](https://mp.weixin.qq.com/)-广告与服务-小程序管理」关联小程序。

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

## 5. 代码示例

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

请求示例

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

返回示例

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

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

请求示例

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

返回示例

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

## 6. 错误码

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

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

## 7. 适用范围

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