SMS-Bestätigung in einer Android-App anfordern

Zur automatischen Überprüfung von Telefonnummern müssen Sie sowohl den Client- als auch den Serverteil des Überprüfungsvorgangs implementieren. In diesem Dokument wird beschrieben, wie du den Clientteil in einer Android-App implementierst.

Um den Vorgang zur Bestätigung der Telefonnummer in einer Android-App zu starten, senden Sie die Telefonnummer an Ihren Verifizierungsserver und rufen Sie die SMS Retriever API auf. Sie wartet auf eine SMS mit einem Einmalcode für Ihre App. Nachdem Sie die Nachricht erhalten haben, senden Sie den Einmalcode an Ihren Server zurück, um den Bestätigungsprozess abzuschließen.

Hinweis

Führen Sie die Schritte in den folgenden Abschnitten aus, um Ihre App vorzubereiten.

Voraussetzungen für Apps

Achten Sie darauf, dass die Build-Datei Ihrer App die folgenden Werte verwendet:

  • MinSdkVersion von 19 oder höher
  • CompileSdkVersion von 28 oder höher

Eigene App konfigurieren

Füge in der Datei „build.gradle“ auf Projektebene sowohl in den Abschnitten buildscript als auch allprojects das Maven-Repository von Google und das Maven Central Repository ein:

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

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

Fügen Sie die Abhängigkeit von den Google Play-Diensten für die SMS Retriever API in die Gradle-Build-Datei Ihres Moduls ein. Das ist in der Regel 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. Telefonnummer des Nutzers abrufen

Sie können die Telefonnummer des Nutzers auf jede für Ihre App angemessene Weise abrufen. Häufig bietet es sich an, den Hinweis-Picker zu verwenden, um den Nutzer zur Auswahl einer der auf dem Gerät gespeicherten Telefonnummern aufzufordern. So muss die Telefonnummer nicht manuell eingegeben werden. So verwenden Sie die Hinweisauswahl:

// 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-Abruf starten

Wenn Sie die Telefonnummer des Nutzers bestätigen möchten, rufen Sie eine Instanz des SmsRetrieverClient-Objekts ab, rufen Sie startSmsRetriever auf und hängen Sie Erfolgs- und Fehler-Listener an die SMS-Abrufaufgabe an:

// 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
    // ...
  }
});

Beim SMS-Abruf wird bis zu fünf Minuten lang auf eine SMS gewartet, die einen eindeutigen String enthält, der Ihre App identifiziert.

3. Telefonnummer an Ihren Server senden

Nachdem Sie die Telefonnummer des Nutzers ermittelt und damit begonnen haben, SMS-Nachrichten zu empfangen, senden Sie die Telefonnummer des Nutzers mit einer beliebigen Methode (in der Regel mit einer HTTPS-POST-Anfrage) an Ihren Verifizierungsserver.

Ihr Server generiert eine Bestätigungsnachricht und sendet sie per SMS an die von Ihnen angegebene Telefonnummer. Weitere Informationen finden Sie unter SMS-Bestätigung auf dem Server durchführen.

4. Bestätigungsnachrichten erhalten

Wenn eine Bestätigungsnachricht auf dem Gerät des Nutzers empfangen wird, senden Play-Dienste explizit einen SmsRetriever.SMS_RETRIEVED_ACTION-Intent an Ihre App, der den Text der Nachricht enthält. Verwenden Sie eine BroadcastReceiver, um diese Bestätigungsnachricht zu erhalten.

Rufen Sie im onReceive-Handler des BroadcastReceiver den Text der Bestätigungsnachricht von den Extras des Intents ab:

/**
 * 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;
      }
    }
  }
}

Registriere diese BroadcastReceiver mit dem Intent-Filter com.google.android.gms.auth.api.phone.SMS_RETRIEVED (Wert der Konstante SmsRetriever.SMS_RETRIEVED_ACTION) und der Berechtigung com.google.android.gms.auth.api.phone.permission.SEND (Wert der Konstante SmsRetriever.SEND_PERMISSION) in der Datei AndroidManifest.xml deiner App wie im folgenden Beispiel oder dynamisch mithilfe von 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. Senden Sie den einmaligen Code aus der Verifizierungsnachricht an Ihren Server.

Da Sie nun den Text der Bestätigungsnachricht haben, verwenden Sie einen regulären Ausdruck oder eine andere Logik, um den einmaligen Code aus der Nachricht zu erhalten. Das Format des einmaligen Codes hängt davon ab, wie Sie ihn auf Ihrem Server implementiert haben.

Senden Sie den einmaligen Code schließlich über eine sichere Verbindung an Ihren Server. Wenn Ihr Server den einmaligen Code erhält, wird die Bestätigung der Telefonnummer aufgezeichnet.

Optional: Telefonnummer mit Smart Lock für Passwörter speichern

Optional: Nachdem der Nutzer seine Telefonnummer bestätigt hat, kannst du den Nutzer auffordern, dieses Telefonnummernkonto mit Smart Lock für Passwörter zu speichern. So ist es automatisch in anderen Apps und auf anderen Geräten verfügbar, ohne dass du die Telefonnummer noch einmal eingeben oder auswählen musst:

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);
                    }
                }
            });

Nachdem der Nutzer die App neu installiert oder auf einem neuen Gerät installiert hat, kannst du die gespeicherte Telefonnummer abrufen, ohne den Nutzer noch einmal nach seiner Telefonnummer fragen zu müssen:

// 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)