SMS-Bestätigung in einer Android-App anfordern

Damit Telefonnummern automatisch bestätigt werden können, musst du sowohl den Client- als auch den Serverteil des Bestätigungsvorgangs implementieren. In diesem Dokument wird die Implementierung des Clientteils in einer Android-App beschrieben.

Wenn Sie in einer Android-App den Vorgang für die Bestätigung der Telefonnummer starten möchten, senden Sie die Telefonnummer an Ihren Verifizierungsserver und rufen Sie die SMS Retriever API auf, um eine SMS mit einem einmaligen Code für Ihre App zu erhalten. Nachdem Sie die Nachricht erhalten haben, senden Sie den einmaligen Code zurück an Ihren Server, um den Bestätigungsvorgang 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 enthält:

  • Eine minSdkVersion von 19 oder höher
  • Eine CompilerSdkVersion von 28 oder höher

Eigene App konfigurieren

Fügen Sie in der build.gradle-Datei auf Projektebene das Maven-Repository von Google und das Maven Central Repository in die Abschnitte buildscript und allprojects ein:

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

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

Fügen Sie der Gradle-Build-Datei des Moduls (in der Regel app/build.gradle) die Abhängigkeit für die Google Play-Dienste für die SMS Retriever API hinzu:

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

1. Telefonnummer des Nutzers ermitteln

Sie können die Telefonnummer des Nutzers auf eine für Ihre App geeignete Weise abrufen. Oft ist es am besten, den Nutzer über die Hinweisauswahl zur Auswahl der Telefonnummern, die auf dem Gerät gespeichert sind, zu bitten. 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 bereit sind, die Telefonnummer des Nutzers zu überprüfen, rufen Sie eine Instanz des SmsRetrieverClient-Objekts ab, rufen Sie startSmsRetriever auf und hängen Sie Listener für Erfolg und Fehler 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
    // ...
  }
});

Die SMS-Abrufaufgabe wartet bis zu fünf Minuten auf eine SMS-Nachricht, die einen eindeutigen String enthält, der Ihre Anwendung identifiziert.

3. Telefonnummer an Ihren Server senden

Nachdem Sie die Telefonnummer des Nutzers erhalten und mit der Erfassung von SMS begonnen haben, senden Sie die Telefonnummer des Nutzers über eine beliebige Methode an Ihren Überprüfungsserver (normalerweise eine HTTPS-POST-Anfrage).

Ihr Server generiert eine Bestätigungsnachricht und sendet diese 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 die Play-Dienste explizit einen SmsRetriever.SMS_RETRIEVED_ACTION-Intent an Ihre App, der den Text der Nachricht enthält. Verwende BroadcastReceiver, um diese Bestätigungsnachricht zu erhalten.

Rufen Sie im onReceive-Handler von BroadcastReceiver den Text der Bestätigungsnachricht aus 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;
      }
    }
  }
}

Registrieren Sie diese BroadcastReceiver mit dem Intent-Filter com.google.android.gms.auth.api.phone.SMS_RETRIEVED (dem Wert der Konstante SmsRetriever.SMS_RETRIEVED_ACTION) und der Berechtigung com.google.android.gms.auth.api.phone.permission.SEND (dem Wert der Konstante SmsRetriever.SEND_PERMISSION) in der Datei AndroidManifest.xml Ihrer Anwendung, wie im folgenden Beispiel, oder dynamisch mit 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 Bestätigungsnachricht an Ihren Server.

Nachdem Sie nun den Text der Bestätigungsnachricht erhalten 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 sie auf Ihrem Server implementiert haben.

Senden Sie abschließend den einmaligen Code über eine sichere Verbindung an Ihren Server. Wenn Ihr Server den einmaligen Code erhält, zeichnet er auf, dass die Telefonnummer bestätigt wurde.

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

Nachdem der Nutzer seine Telefonnummer bestätigt hat, kannst du ihn optional mit Smart Lock für Passwörter auffordern, die Nummer in anderen Apps und anderen Geräten automatisch verfügbar zu machen, ohne die Telefonnummer noch einmal eingeben oder auswählen zu müssen:

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, können Sie 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)