# 获取已设置的二维码规则 [调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools) > 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。 接口英文名：qrcodeJumpGet 该接口用于获取已设置的二维码规则 ## 1. 调用方式 ### HTTPS 调用 ```bash POST https://api.weixin.qq.com/cgi-bin/wxopen/qrcodejumpget?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 [ { "参数名": "appid", "类型": "string", "必填": "是", "说明": "小程序的appid。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。" }, { "参数名": "get_type", "类型": "number", "必填": "是", "说明": "默认值为0。 0：查询最近新增 10000 条（数量大建议用1或者2）；1：prefix查询；2：分页查询，按新增顺序返回。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。" }, { "参数名": "prefix_list", "类型": "array", "必填": "否", "说明": "prefix查询，get_type=1 必传，最多传 200 个前缀。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。" }, { "参数名": "page_num", "类型": "number", "必填": "否", "说明": "页码，get_type=2 必传，从 1 开始。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。" }, { "参数名": "page_size", "类型": "number", "必填": "否", "说明": "每页数量，get_type=2 必传，最大为 200。获取“扫服务号二维码打开小程序”已设置的二维码规则才需要传这个参数。" } ] ``` ## 3. 返回参数 ### 返回体 `Response Payload` ```json [ { "参数名": "errcode", "类型": "number", "说明": "错误码" }, { "参数名": "errmsg", "类型": "string", "说明": "错误信息" }, { "参数名": "rule_list", "类型": "objarray", "说明": "二维码规则详情列表" }, { "参数名": "qrcodejump_open", "类型": "number", "说明": "是否已经打开二维码跳转链接设置" }, { "参数名": "list_size", "类型": "number", "说明": "二维码规则数量" }, { "参数名": "qrcodejump_pub_quota", "类型": "number", "说明": "本月还可发布的次数" }, { "参数名": "total_count", "类型": "number", "说明": "二维码规则总数据量，用于分页查询" } ] ``` "> ### Res.rule_list(Array) `Object Payload` 二维码规则详情列表 ```json [ { "参数名": "prefix", "类型": "string", "说明": "二维码规则，说明，服务号二维码规则已过滤不展示。" }, { "参数名": "path", "类型": "string", "说明": "小程序功能页面。" }, { "参数名": "state", "类型": "number", "说明": "发布标志位，1 表示未发布，2 表示已发布。" }, { "参数名": "open_version", "类型": "number", "说明": "测试范围。\n获取“扫普通二维码打开小程序”已设置的二维码规则才返回这个参数。\n1表示开发版（配置只对开发者生效）；2表示体验版（配置对管理员、体验者生效)；3表示正式版（配置对开发者、管理员和体验者生效）。\n特别说明，不管普通二维码规则是否发布，开发者/体验者/管理员在扫描 debug_url 所对应的二维码时，都会根据 open_version 来决定打开开发版、体验版或正式版" }, { "参数名": "debug_url", "类型": "array", "说明": "测试链接（选填）可填写不多于 5 个用于测试的二维码完整链接，此链接必须符合已填写的二维码规则。获取“扫普通二维码打开小程序”已设置的二维码规则才返回这个参数。" } ] ``` ## 4. 注意事项 ### 调用说明 - 该接口用于获取已设置的二维码规则，适用于获取“扫普通二维码打开小程序”已设置的二维码规则，也适用于获取“扫服务号二维码打开小程序”已设置的二维码规则。 - 如果是获取“扫普通二维码打开小程序”已设置的二维码规则，则无需任何入参，使用小程序的[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)即可调用。 - 如果是获取“扫服务号二维码打开小程序”已设置的二维码规则，则需要传appid、get_type、prefix_list、page_num、page_size等参数，详情可查看下方文档说明。 ### 服务号调用说明 - 服务商要调用这个接口获取“扫服务号二维码打开小程序”已设置的二维码规则，必须要先获得服务号需将权限集 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))的接口，或在“公众号管理后台—广告与服务—小程序管理”关联小程序。 ## 5. 代码示例 ### 5.1 获取“扫普通二维码打开小程序”已设置的二维码规则 请求示例 ``` json { "appid": "wx1234567890abcdef", "get_type": 1, "prefix_list": [ "https://weixin.qq.com/qrcodejump" ] } ``` 返回示例 ```json { "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 } ``` ### 5.2 获取“扫服务号二维码打开小程序”已设置的二维码规则 请求示例 ``` json { "appid": "wx1234567890abcdef", "get_type": 1, "prefix_list": [ "https://weixin.qq.com/qrcodejump" ] } ``` 返回示例 ```json { "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 } ``` ## 6. 错误码 以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。 ```json [ { "错误码": "-1", "错误描述": "system error", "解决方案": "系统繁忙，此时请开发者稍候再试" }, { "错误码": "0", "错误描述": "ok", "解决方案": "成功" }, { "错误码": "40001", "错误描述": "invalid credential  access_token isinvalid or not latest", "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口" }, { "错误码": "40097", "错误描述": "参数有误", "解决方案": "请求参数错误" }, { "错误码": "40166", "错误描述": "invalid appid", "解决方案": "appid 参数不合法" }, { "错误码": "44990", "错误描述": "接口请求太快", "解决方案": "超过5次/秒频率限制" }, { "错误码": "85075", "错误描述": "can not access", "解决方案": "个人类型小程序无法设置二维码规则" }, { "错误码": "886001", "错误描述": "系统繁忙", "解决方案": "请重试" } ] ``` ## 7. 适用范围 本接口支持「服务号（仅认证）」账号类型调用。其他账号类型如无特殊说明，均不可调用。