ขอการยืนยันทาง SMS ในแอป Android

หากต้องการยืนยันหมายเลขโทรศัพท์โดยอัตโนมัติ คุณต้องใช้ทั้งส่วนของไคลเอ็นต์และเซิร์ฟเวอร์ในขั้นตอนการยืนยัน เอกสารนี้จะอธิบายวิธี นำส่วนของไคลเอ็นต์ในแอป Android

หากต้องการเริ่มขั้นตอนการยืนยันหมายเลขโทรศัพท์ในแอป Android ให้ส่งหมายเลขโทรศัพท์ไปยังเซิร์ฟเวอร์การยืนยันและเรียก SMS Retriever API เพื่อเริ่มฟังข้อความ SMS ที่มีรหัสแบบใช้ครั้งเดียวของแอป หลังจากได้รับข้อความแล้ว คุณจะส่งรหัสแบบใช้ครั้งเดียวกลับไปยังเซิร์ฟเวอร์เพื่อทำการยืนยันให้เสร็จสมบูรณ์

ก่อนเริ่มต้น

ทําตามขั้นตอนในส่วนต่อไปนี้เพื่อเตรียมแอป

ข้อกำหนดเบื้องต้นของแอป

ตรวจสอบว่าไฟล์บิลด์ของแอปใช้ค่าต่อไปนี้

  • minSdkVersion 19 ขึ้นไป
  • คอมไพล์SdkVersion 28 ขึ้นไป

กำหนดค่าแอป

ในไฟล์ create.gradle ระดับโปรเจ็กต์ ให้ใส่ที่เก็บ Maven ของ Google และที่เก็บส่วนกลาง Maven ไว้ทั้งในส่วน buildscript และ allprojects

buildscript {
    repositories {
        google()
        mavenCentral()
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
    }
}

เพิ่มทรัพยากร Dependency ของบริการ Google Play สำหรับ SMS Retriever API ไปยังไฟล์บิลด์ Gradle ของโมดูล ซึ่งโดยทั่วไปแล้วมักเป็น app/build.gradle ดังนี้

dependencies {
  implementation 'com.google.android.gms:play-services-auth:21.0.0'
  implementation 'com.google.android.gms:play-services-auth-api-phone:18.0.2'
}

1. รับหมายเลขโทรศัพท์ของผู้ใช้

คุณสามารถรับหมายเลขโทรศัพท์ของผู้ใช้ด้วยวิธีใดก็ตามที่เหมาะสมกับแอปของคุณ โดยส่วนใหญ่แล้ว การใช้เครื่องมือเลือกคำแนะนำเพื่อขอให้ผู้ใช้เลือกจากหมายเลขโทรศัพท์ที่จัดเก็บไว้ในอุปกรณ์มักจะเป็นประสบการณ์ที่ดีที่สุดเพื่อหลีกเลี่ยงการพิมพ์หมายเลขโทรศัพท์ด้วยตนเอง วิธีใช้เครื่องมือเลือกคำแนะนำ

// Construct a request for phone numbers and show the picker
private void requestHint() {
    HintRequest hintRequest = new HintRequest.Builder()
           .setPhoneNumberIdentifierSupported(true)
           .build();

    PendingIntent intent = Auth.CredentialsApi.getHintPickerIntent(
            apiClient, hintRequest);
    startIntentSenderForResult(intent.getIntentSender(),
            RESOLVE_HINT, null, 0, 0, 0);
}

// Obtain the phone number from the result
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
  super.onActivityResult(requestCode, resultCode, data);
  if (requestCode == RESOLVE_HINT) {
      if (resultCode == RESULT_OK) {
          Credential credential = data.getParcelableExtra(Credential.EXTRA_KEY);
          // credential.getId();  <-- will need to process phone number string
      }
  }
}

2. เริ่มต้น SMS Retriever

เมื่อคุณพร้อมที่จะยืนยันหมายเลขโทรศัพท์ของผู้ใช้ ให้รับอินสแตนซ์ของออบเจ็กต์ SmsRetrieverClient เรียก startSmsRetriever และแนบ Listener ที่สำเร็จและล้มเหลวในงานการเรียก SMS ด้วย โดยทำดังนี้

// Get an instance of SmsRetrieverClient, used to start listening for a matching
// SMS message.
SmsRetrieverClient client = SmsRetriever.getClient(this /* context */);

// Starts SmsRetriever, which waits for ONE matching SMS message until timeout
// (5 minutes). The matching SMS message will be sent via a Broadcast Intent with
// action SmsRetriever#SMS_RETRIEVED_ACTION.
Task<Void> task = client.startSmsRetriever();

// Listen for success/failure of the start Task. If in a background thread, this
// can be made blocking using Tasks.await(task, [timeout]);
task.addOnSuccessListener(new OnSuccessListener<Void>() {
  @Override
  public void onSuccess(Void aVoid) {
    // Successfully started retriever, expect broadcast intent
    // ...
  }
});

task.addOnFailureListener(new OnFailureListener() {
  @Override
  public void onFailure(@NonNull Exception e) {
    // Failed to start retriever, inspect Exception for more details
    // ...
  }
});

งานการเรียก SMS จะรอเป็นเวลาสูงสุด 5 นาทีสำหรับข้อความ SMS ที่มีสตริงที่ไม่ซ้ำกันซึ่งระบุแอปของคุณ

3. ส่งหมายเลขโทรศัพท์ไปยังเซิร์ฟเวอร์ของคุณ

หลังจากได้รับหมายเลขโทรศัพท์ของผู้ใช้และเริ่มฟังข้อความ SMS แล้ว ให้ส่งหมายเลขโทรศัพท์ของผู้ใช้ไปยังเซิร์ฟเวอร์การยืนยันโดยใช้วิธีการใดก็ได้ (โดยปกติจะใช้คำขอ HTTPS POST)

เซิร์ฟเวอร์ของคุณจะสร้างข้อความยืนยันและส่ง SMS ไปยังหมายเลขโทรศัพท์ที่คุณระบุ โปรดดูที่ดำเนินการยืนยันทาง SMS บนเซิร์ฟเวอร์

4. รับข้อความการยืนยัน

เมื่อได้รับข้อความยืนยันในอุปกรณ์ของผู้ใช้ บริการ Google Play จะเผยแพร่ Intent SmsRetriever.SMS_RETRIEVED_ACTION ไปยังแอปของคุณอย่างชัดแจ้ง ซึ่งจะมีข้อความดังกล่าว โปรดใช้ BroadcastReceiver เพื่อรับ ข้อความยืนยันนี้

ในเครื่องจัดการ onReceive ของ BroadcastReceiver ให้รับข้อความยืนยันจากส่วนเสริมของ Intent ดังนี้

/**
 * BroadcastReceiver to wait for SMS messages. This can be registered either
 * in the AndroidManifest or at runtime.  Should filter Intents on
 * SmsRetriever.SMS_RETRIEVED_ACTION.
 */
public class MySMSBroadcastReceiver extends BroadcastReceiver {

  @Override
  public void onReceive(Context context, Intent intent) {
    if (SmsRetriever.SMS_RETRIEVED_ACTION.equals(intent.getAction())) {
      Bundle extras = intent.getExtras();
      Status status = (Status) extras.get(SmsRetriever.EXTRA_STATUS);

      switch(status.getStatusCode()) {
        case CommonStatusCodes.SUCCESS:
          // Get SMS message contents
          String message = (String) extras.get(SmsRetriever.EXTRA_SMS_MESSAGE);
          // Extract one-time code from the message and complete verification
          // by sending the code back to your server.
          break;
        case CommonStatusCodes.TIMEOUT:
          // Waiting for SMS timed out (5 minutes)
          // Handle the error ...
          break;
      }
    }
  }
}

ลงทะเบียน BroadcastReceiver นี้ด้วยตัวกรอง Intent com.google.android.gms.auth.api.phone.SMS_RETRIEVED (ค่าคงที่ SmsRetriever.SMS_RETRIEVED_ACTION) และสิทธิ์com.google.android.gms.auth.api.phone.permission.SEND (ค่าคงที่ SmsRetriever.SEND_PERMISSION) ในไฟล์ AndroidManifest.xml ของแอปตามตัวอย่างต่อไปนี้ หรือใช้ Context.registerReceiver แบบไดนามิก

<receiver android:name=".MySMSBroadcastReceiver" android:exported="true"
          android:permission="com.google.android.gms.auth.api.phone.permission.SEND">
    <intent-filter>
        <action android:name="com.google.android.gms.auth.api.phone.SMS_RETRIEVED"/>
    </intent-filter>
</receiver>

5. ส่งรหัสแบบใช้ครั้งเดียวจากข้อความยืนยันไปยังเซิร์ฟเวอร์ของคุณ

เมื่อได้รับข้อความยืนยันแล้ว ให้ใช้นิพจน์ทั่วไปหรือตรรกะอื่นๆ เพื่อรับรหัสแบบใช้ครั้งเดียวจากข้อความ รูปแบบของโค้ดแบบใช้ครั้งเดียวขึ้นอยู่กับวิธีที่คุณนำไปใช้ในเซิร์ฟเวอร์

สุดท้าย ส่งรหัสแบบใช้ครั้งเดียวไปยังเซิร์ฟเวอร์ผ่านการเชื่อมต่อที่ปลอดภัย เมื่อเซิร์ฟเวอร์ได้รับรหัสแบบใช้ครั้งเดียว ระบบจะบันทึกว่าหมายเลขโทรศัพท์ได้รับการยืนยันแล้ว

ไม่บังคับ: บันทึกหมายเลขโทรศัพท์ด้วย Smart Lock สำหรับรหัสผ่าน

หรือหลังจากที่ผู้ใช้ยืนยันหมายเลขโทรศัพท์แล้ว คุณสามารถแจ้งให้ผู้ใช้บันทึกบัญชีหมายเลขโทรศัพท์นี้ด้วย Smart Lock สำหรับรหัสผ่านเพื่อให้ใช้งานในแอปอื่นๆ และอุปกรณ์อื่นๆ ได้โดยอัตโนมัติโดยไม่ต้องพิมพ์หรือเลือกหมายเลขโทรศัพท์อีกครั้ง โดยทำดังนี้

Credential credential = new Credential.Builder(phoneNumberString)
        .setAccountType("https://signin.example.com")  // a URL specific to the app
        .setName(displayName)  // optional: a display name if available
        .build();
Auth.CredentialsApi.save(apiClient, credential).setResultCallback(
            new ResultCallback() {
                public void onResult(Result result) {
                    Status status = result.getStatus();
                    if (status.isSuccess()) {
                        Log.d(TAG, "SAVE: OK");  // already saved
                    } else if (status.hasResolution()) {
                        // Prompt the user to save
                        status.startResolutionForResult(this, RC_SAVE);
                    }
                }
            });

จากนั้น หลังจากที่ผู้ใช้ติดตั้งแอปอีกครั้ง หรือติดตั้งแอปในอุปกรณ์เครื่องใหม่แล้ว คุณสามารถเรียกข้อมูลหมายเลขโทรศัพท์ที่บันทึกไว้ได้โดยไม่ต้องขอหมายเลขโทรศัพท์จากผู้ใช้อีก

// On the next install, retrieve the phone number
mCredentialRequest = new CredentialRequest.Builder()
    .setAccountTypes("https://signin.example.com")  // the URL specific to the developer
    .build();
Auth.CredentialsApi.request(apiClient, mCredentialRequest).setResultCallback(
    new ResultCallback<CredentialRequestResult>() {
        public void onResult(CredentialRequestResult credentialRequestResult) {
            if (credentialRequestResult.getStatus().isSuccess()) {
                credentialRequestResult.getCredential().getId();  // this is the phone number
            }
        }
    });

// Then, initiate verification and sign the user in (same as original verification logic)