시작하기

설치

AI-Assisted Setup으로 플러그인을 설치할 수 있습니다. 다음 명령어로 AI 도구에 Capgo 스킬을 추가하세요:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

그런 다음 아래 프롬프트를 사용하세요:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-android-sms-retriever` plugin in my project.

수동 설정을 선호한다면, 다음 명령어를 실행하여 플러그인을 설치하고 아래의 플랫폼별 지침을 따르세요:

npm install @capgo/capacitor-android-sms-retriever
npx cap sync android

빠른 시작

일회용 SMS를 수신하여 OTP를 추출한 뒤, 사용자가 code을(를) 요청하기 전에 retriever를 시작하세요.

import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

const smsListener = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  const code = message.match(/\b\d{4,8}\b/)?.[0];
  if (code) submitCode(code);
  // The SMS also ends with your 11-character app hash; validate it separately from the OTP.
});

await AndroidSmsRetriever.startWatch();

// When the flow completes:
await smsListener.remove();
await AndroidSmsRetriever.stopWatch();

자주 하는 실수

• Hash: SMS 템플릿에 앱 retriever hash가 포함되어야 합니다.
• 타임아웃: 사용자가 새로운 code을(를) 요청하면 watch를 재시작합니다.
• Play services: 기기에서 필요합니다.

가져오기

import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

Android 요구 사항

SMS Retriever를 사용하려면 Android 기기에 Google Play services가 필요합니다. 이 플러그인은 READ_SMS 또는 RECEIVE_SMS 권한을 요청하지 않습니다.

인증 SMS에는 다음에서 반환된 앱 해시(app hash)가 반드시 포함되어야 합니다: getHashString(). 앱 배포에 사용되는 서명 키의 해시를 생성하세요. Debug, release, Play App Signing 빌드는 각각 해시값이 다를 수 있습니다.

인증 SMS 수신 대기

import { AndroidSmsRetriever } from '@capgo/capacitor-android-sms-retriever';

const received = await AndroidSmsRetriever.addListener('smsReceived', ({ message }) => {
  const code = message.match(/\b\d{6}\b/)?.[0];
  console.log('Verification code:', code);
});

const timeout = await AndroidSmsRetriever.addListener('smsRetrieverTimeout', () => {
  console.log('SMS Retriever timed out');
});

const errors = await AndroidSmsRetriever.addListener('smsRetrieverError', ({ message }) => {
  console.error('SMS Retriever error:', message);
});

await AndroidSmsRetriever.startWatch();

// Remove listeners when the verification flow is done.
await received.remove();
await timeout.remove();
await errors.remove();

감시 중지

await AndroidSmsRetriever.stopWatch();

앱 해시 가져오기

const { hash } = await AndroidSmsRetriever.getHashString();
console.log(hash);

백엔드에서 전송하는 인증 SMS 끝에 이 해시를 포함하세요.

전화번호 힌트 요청

const { phoneNumber } = await AndroidSmsRetriever.getPhoneNumber();
console.log(phoneNumber);

Android에서 네이티브 Phone Number Hint UI를 표시하고, 사용자가 선택한 전화번호를 반환합니다.

SMS 예시

<#> 123456 is your verification code.
FA+9qCX9VSu

마지막 줄을 앱 서명 키의 해시값으로 교체하세요.

시작하기 다음 단계

사용 중이라면 시작하기 네이티브 플러그인 작업을 계획하려면, 이를 다음 항목과 연결하세요: @capgo/capacitor-android-sms-retriever 사용하기 @capgo/capacitor-android-sms-retriever 사용 시 네이티브 기능을 위해 Capgo 플러그인 디렉토리 Capgo Plugin Directory의 제품 워크플로우에 맞춰, Capgo의 Capacitor 플러그인 Capgo의 Capacitor 플러그인 구현 상세 내용에 대해서는, 플러그인 추가 또는 업데이트 플러그인 추가 또는 업데이트 구현 상세 내용에 대해서는, Ionic Enterprise 플러그인 대안 Ionic Enterprise 플러그인 대안의 제품 워크플로우에 대해서는.