# urlscheme.generateNFC

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

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

获取用于 NFC 的小程序 scheme 码，适用于 NFC 拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放，详见 NFC 标签打开小程序。

调用方式：

HTTPS 调用
云调用

# HTTPS 调用

# 请求地址

POST https://api.weixin.qq.com/wxa/generatenfcscheme?access_token=ACCESS_TOKEN

# 请求参数

属性	类型	必填	说明
access_token / cloudbase_access_token	string	是	接口调用凭证
jump_wxa	Object	否	跳转到的目标小程序信息。
sn	string	否	scheme对应的设备sn，仅一机一码时填写
model_id	string	是	scheme对应的设备model_id

jump_wxa 的结构

属性	类型	默认值	必填	说明
path	string		否	通过 scheme 码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。
query	string		否	通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`!#$&'()*+,/:;=?@-._~%``
env_version	string	"release"	否	要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。

# 返回值

# openlink

生成的小程序 scheme 码

# 异常返回

# Object

JSON

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

errcode 的合法值

值	说明	最低版本
-1	系统繁忙，请稍后重试
40002	暂无生成权限（非个人主体小程序无权限，未申请NFC能力的小程序无权限）
40013	生成权限被封禁
85079	小程序未发布
40165	参数path填写错误
40212	参数query填写错误
85402	参数env_version填写错误
44990	生成Scheme频率过快（超过200次/秒）
44993	单天生成Scheme+URL Link数量超过上限50万
85400	长期有效Scheme或short link达到生成上限10万，不可再生成。
9800003	model_id检查不通过
9800007	此model_id尚未获得该能力，请能力申请通过后再试
9800008	能力类型为一机一码，sn不能为空
9800009	能力类型为一型一码，sn需为空

# 返回值说明

如果调用成功，会直接返回生成的小程序 scheme 码。如果请求失败，会返回 JSON 格式的数据。

# 示例

请求

{
    "jump_wxa":
    {
        "path": "/pages/publishHomework/publishHomework",
        "query": ""
    },
    "sn": "xxx",
    "model_id": "xxx"
}

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

# 云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

# 接口方法

openapi.urlscheme.generateNFC

需在 config.json 中配置 urlscheme.generateNFC API 的权限，详情

# 请求参数

属性	类型	必填	说明
jumpWxa	Object	否	跳转到的目标小程序信息。
sn	string	否	scheme对应的设备sn，仅一机一码时填写
modelId	string	是	scheme对应的设备model_id

jumpWxa 的结构

属性	类型	默认值	必填	说明
path	string		否	通过 scheme 码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。
query	string		否	通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`!#$&'()*+,/:;=?@-._~%``
envVersion	string	"release"	否	要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。

# 返回值

# openlink

生成的小程序 scheme 码

# 异常

# Object

JSON

属性	类型	说明
errCode	number	错误码
errMsg	string	错误信息

errCode 的合法值

值	说明	最低版本

# 示例

请求

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.urlscheme.generateNFC({
        "sn": 'xxx',
        "jumpWxa": {
          "path": '/pages/publishHomework/publishHomework',
          "query": ''
        },
        "modelId": 'xxx'
      })
    return result
  } catch (err) {
    return err
  }
}

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