For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/device/scan/scanCode.md.

scanCode

调起扫码能力。

扫码预览

扫码预览 scanCode

使用限制

WARNING

Android、iOS:双端对 scanType 的过滤支持不一致,部分取值可能不生效;依赖类型过滤的调用方可能扫出预期外的码型。

支持版本

前端库版本不低于 0.0.25。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

接入准备

权限要求

类型标识是否必须平台说明
系统权限相机权限必须Android、iOS从相机扫码需要系统相机权限

授权行为

  • 首次调用会触发系统相机权限申请;用户拒绝后调用失败,需引导用户在系统设置中重新开启相机权限

使用说明

  • onlyFromCamera 为 false 时允许从相册选择图片识别

调用方式

异步 API

scanCode(params?: ScanCodeParams): Promise<ScanCodeResult>

入参

名称类型必填默认值约束说明
onlyFromCameraboolean否false为 true 时不允许从相册选择图片识别是否仅允许从相机扫码。
scanTypeScanCodeType[]否允许全部支持的码型-允许的扫码类型。Android、iOS:双端对 scanType 的过滤支持不一致,部分取值可能不生效。

调用示例

import { scanCode } from '@doubao-dev/framework/api';

const { result, scanType } = await scanCode({
  onlyFromCamera: true,
  scanType: ['qrCode']
});

console.log(result, scanType);

成功返回

名称类型必返说明
characterSetstring是字符集。
pathstring是从扫码结果中解析出的页面路径。
rawDatastring是原始数据,通常为 Base64 字符串。
resultstring是扫码结果文本。
scanTypeScanResultType是扫码结果类型。Android、iOS:双端对 scanType 的过滤支持不一致,部分取值可能不生效。

返回示例

{
  "characterSet": "utf-8",
  "path": "",
  "rawData": "aHR0cHM6Ly9leGFtcGxlLmNvbQ==",
  "result": "https://example.com",
  "scanType": "QR_CODE"
}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 103,
  "errMsg": "feature not support"
}

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportAndroid、iOS当前豆包版本不支持扫码升级至支持扫码能力的豆包版本后重试。
112invalid resultiOS扫码成功但未返回可用的扫码结果数据稍后重试;持续失败时反馈扫码结果异常。

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS