my.scan(object object)
支付宝客户端 10.1.38 或更高版本； 若版本较低，建议采取 兼容处理。
主体： 企业支付宝小程序 、 个人支付宝小程序
my.scan 调起客户端扫码界面进行扫码。
object object
查看示例
| 属性 | 类型 | 默认值 | 必填 | 描述 | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| scantype | array | ['qrcode','barcode'] | 否 | 扫码识别类型。 | ||||||||||||||||||||||
| ||||||||||||||||||||||||||
| hidealbum | boolean | false | 否 | 是否只能从相机扫码，不允许从相册选择图片。 | ||||||||||||||||||||||
| success | function | - | 否 | 调用成功的回调函数。 | ||||||||||||||||||||||
| fail | function | - | 否 | 调用失败的回调函数。 | ||||||||||||||||||||||
| complete | function | - | 否 | 调用结束的回调函数（调用成功、失败都会执行）。 | ||||||||||||||||||||||
success 回调函数
参数
object res
查看示例
| 属性 | 类型 | 描述 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | string | 扫码结果。 | ||||||||||
| result | string | 码内容。 | ||||||||||
| scantype | string | 码类型。 | ||||||||||
| imagechannel | string | 码图像来源。 | ||||||||||
| ||||||||||||
| rawdata | string | base64 字节流。 | ||||||||||
fail 回调的参数为 object，error 属性为错误码，errormessage 属性为错误消息。
| 错误码 | 错误消息 | 凯发app官方网站的解决方案 |
|---|---|---|
| 10 | 用户取消操作。 | 正常交互流程。无需做特殊处理。 |
| 2001 | 用户不允许授权。 | 用户拒绝为当前小程序授权。 请在交互中考虑此情况。如有需要，请向用户强调该授权的必要性。 |
| 2002 | 用户不允许授权。 | 用户拒绝为当前小程序授权，并勾选了“总是保持以上选择”后，再次调用授权接口产生的报错。 如有需要，提醒或引导用户手动授权：小程序右上角胶囊按钮->设置->打开权限开关；或者通过调用 my.opensetting 帮助用户打开设置页面。 |
| 2003 | 用户勾选了不允许授权选项。 | 用户拒绝为当前小程序授权，并勾选了“总是保持以上选择”。 如有需要，提醒或引导用户手动授权：小程序右上角胶囊按钮->设置->打开权限开关；或者通过调用 my.opensetting 帮助用户打开设置页面。 |
代码示例
扫码体验
my.scan(object object)
success 回调参数
fail 回调参数
my.scan({
success: function(res) {
console.log(res);
},
fail: function(err) {
console.log(err);
}
});{
"code": "https://p.dqbdsh.com?scene=scen=1063482",
"imagechannel": "camera",
"qrcode": "https://p.dqbdsh.com?scene=scen=1063482",
"rawdata": "ahr0chm6ly9wlmrxymrzac5jb20/c2nlbmu9u0nftj0xmdyzndgy",
"result": "https://p.dqbdsh.com?scene=scen=1063482",
"scantype": "qr"
}
{
"error": 10,
"errormessage": "用户取消操作。"
}
- tip
此接口的作用是获取扫码结果供当前小程序使用。如果想要唤起支付宝的扫一扫功能，请使用 my.ap.openalipayapp。
q：通过 my.scan 扫描小程序码，能否获得其中的小程序应用参数？
a：
小程序码的码值中并不直接包含小程序应用参数。建议调用 my.ap.openalipayapp 唤起支付宝的扫一扫功能扫描小程序码，在打开的小程序内部去正常获取参数。