Einmalige Einwilligung zum Lesen eines SMS-Bestätigungscodes anfordern

Auf dieser Seite wird beschrieben, wie Sie mit der SMS User Consent API die Einwilligung der Nutzer zum Lesen einer einzelnen SMS-Bestätigungsnachricht einholen. Wenn der Nutzer einwilligt, gibt die API den Text der Nachricht zurück, aus der Sie den Bestätigungscode abrufen und die Überprüfung abschließen können.

Abhängigkeiten installieren

Füge die Authentifizierungskomponente der Play-Dienste in die Datei build.gradle deiner App ein:

implementation 'com.google.android.gms:play-services-auth:17.0.0'
implementation 'com.google.android.gms:play-services-auth-api-phone:17.4.0'

1. Telefonnummer des Nutzers abrufen

Wenn Sie die Telefonnummer des Nutzers nicht haben, fordern Sie sie an, bevor Sie mit der SMS-Bestätigung beginnen.

Sie können die Telefonnummer des Nutzers auf eine für Ihre App geeignete Weise ermitteln. Verwenden Sie gegebenenfalls die Hinweisauswahl für Smart Lock für Passwörter, die dem Nutzer beim Ausfüllen seiner Telefonnummer hilft, wenn diese Informationen zum Erstellen des Nutzerkontos nicht erforderlich waren. So verwenden Sie die Hinweisauswahl:

Kotlin

private val CREDENTIAL_PICKER_REQUEST = 1  // Set to an unused request code

// Construct a request for phone numbers and show the picker
private fun requestHint() {
    val hintRequest = HintRequest.Builder()
        .setPhoneNumberIdentifierSupported(true)
        .build()
    val credentialsClient = Credentials.getClient(this)
    val intent = credentialsClient.getHintPickerIntent(hintRequest)
    startIntentSenderForResult(
        intent.intentSender,
        CREDENTIAL_PICKER_REQUEST,
        null, 0, 0, 0
    )
}

public override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    when (requestCode) {
        CREDENTIAL_PICKER_REQUEST ->
            // Obtain the phone number from the result
            if (resultCode == Activity.RESULT_OK && data != null) {
                val credential = data.getParcelableExtra<Credential>(Credential.EXTRA_KEY)
                // credential.getId();  <-- will need to process phone number string
            }
        // ...
    }
}

Java

private static final int CREDENTIAL_PICKER_REQUEST = 1;  // Set to an unused request code

// Construct a request for phone numbers and show the picker
private void requestHint() throws IntentSender.SendIntentException {
    HintRequest hintRequest = new HintRequest.Builder()
            .setPhoneNumberIdentifierSupported(true)
            .build();
    PendingIntent intent = Credentials.getClient(this).getHintPickerIntent(hintRequest);
    startIntentSenderForResult(intent.getIntentSender(),
            RESOLVE_HINT, null, 0, 0, 0);
}

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

2. Warten auf eingehende Nachrichten starten

Rufen Sie als Nächstes die Methode startSmsUserConsent() der SMS User Consent API auf, um auf eingehende Nachrichten zu warten. Wenn Sie die Telefonnummer kennen, von der die SMS gesendet werden soll, geben Sie sie an (ansonsten null übergeben). So löst die SMS User Consent API nur bei Nachrichten von dieser Nummer aus.

So hören Sie zu:

Kotlin

// Start listening for SMS User Consent broadcasts from senderPhoneNumber
// The Task<Void> will be successful if SmsRetriever was able to start
// SMS User Consent, and will error if there was an error starting.
val task = SmsRetriever.getClient(context).startSmsUserConsent(senderPhoneNumber /* or null */)

Java

// Start listening for SMS User Consent broadcasts from senderPhoneNumber
// The Task<Void> will be successful if SmsRetriever was able to start
// SMS User Consent, and will error if there was an error starting.
Task<Void> task = SmsRetriever.getClient(context).startSmsUserConsent(senderPhoneNumber /* or null */);

Sobald Sie auf eingehende SMS warten, können Sie Ihr Verifizierungssystem anweisen, den Bestätigungscode an die Telefonnummer des Nutzers zu senden, die Sie im ersten Schritt erhalten haben.

Wenn das Gerät in den nächsten fünf Minuten eine SMS-Nachricht mit einem Einmalcode empfängt, senden die Play-Dienste an Ihre App einen Intent, um den Nutzer um Erlaubnis zum Lesen der Nachricht zu bitten. Eine Nachricht löst den Broadcast nur aus, wenn sie die folgenden Kriterien erfüllt:

• Die Nachricht enthält einen alphanumerischen String mit 4–10 Zeichen und mindestens einer Zahl.
• Wenn Sie die Telefonnummer des Absenders angegeben haben, wurde die Nachricht von dieser Nummer gesendet.

Verarbeiten Sie diese Broadcasts mit einem Broadcastempfänger, der die Berechtigung SEND_PERMISSION hat und auf SMS_RETRIEVED_ACTION-Intents reagiert. So erstellen und registrieren Sie den Übertragungsempfänger:

Kotlin

private val SMS_CONSENT_REQUEST = 2  // Set to an unused request code
private val smsVerificationReceiver = object : BroadcastReceiver() {
    override fun onReceive(context: Context, intent: Intent) {
        if (SmsRetriever.SMS_RETRIEVED_ACTION == intent.action) {
            val extras = intent.extras
            val smsRetrieverStatus = extras?.get(SmsRetriever.EXTRA_STATUS) as Status

            when (smsRetrieverStatus.statusCode) {
                CommonStatusCodes.SUCCESS -> {
                    // Get consent intent
                    val consentIntent = extras.getParcelable<Intent>(SmsRetriever.EXTRA_CONSENT_INTENT)
                    try {
                        // Start activity to show consent dialog to user, activity must be started in
                        // 5 minutes, otherwise you'll receive another TIMEOUT intent
                        startActivityForResult(consentIntent, SMS_CONSENT_REQUEST)
                    } catch (e: ActivityNotFoundException) {
                        // Handle the exception ...
                    }
                }
                CommonStatusCodes.TIMEOUT -> {
                    // Time out occurred, handle the error.
                }
            }
        }
    }
}

override fun onCreate(savedInstanceState: Bundle?) {
    // ...

    val intentFilter = IntentFilter(SmsRetriever.SMS_RETRIEVED_ACTION)
    registerReceiver(smsVerificationReceiver, SmsRetriever.SEND_PERMISSION, intentFilter)
}

Java

private static final int SMS_CONSENT_REQUEST = 2;  // Set to an unused request code
private final BroadcastReceiver smsVerificationReceiver = new BroadcastReceiver() {
    @Override
    public void onReceive(Context context, Intent intent) {
        if (SmsRetriever.SMS_RETRIEVED_ACTION.equals(intent.getAction())) {
            Bundle extras = intent.getExtras();
            Status smsRetrieverStatus = (Status) extras.get(SmsRetriever.EXTRA_STATUS);

            switch (smsRetrieverStatus.getStatusCode()) {
                case CommonStatusCodes.SUCCESS:
                    // Get consent intent
                    Intent consentIntent = extras.getParcelable(SmsRetriever.EXTRA_CONSENT_INTENT);
                    try {
                        // Start activity to show consent dialog to user, activity must be started in
                        // 5 minutes, otherwise you'll receive another TIMEOUT intent
                        startActivityForResult(consentIntent, SMS_CONSENT_REQUEST);
                    } catch (ActivityNotFoundException e) {
                        // Handle the exception ...
                    }
                    break;
                case CommonStatusCodes.TIMEOUT:
                    // Time out occurred, handle the error.
                    break;
            }
        }
    }
};

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    // ...

    IntentFilter intentFilter = new IntentFilter(SmsRetriever.SMS_RETRIEVED_ACTION);
    registerReceiver(smsVerificationReceiver, SmsRetriever.SEND_PERMISSION, intentFilter);
}

Wenn Sie eine Aktivität für EXTRA_CONSENT_INTENT starten, fordern Sie den Nutzer einmalig auf, den Inhalt der Nachricht zu lesen.

Wichtig: Sie können erkennen, dass der Broadcast-Intent von der SMS Retriever API stammt, indem Sie Ihrem Empfänger die Berechtigung com.google.android.gms.auth.api.phone.permission.SEND hinzufügen. Diese Berechtigungseinstellung ist ab Version 19.8.31 der Google Play-Dienste verfügbar.

Wichtig: Fügen Sie die Berechtigung com.google.android.gms.auth.api.phone.permission.SEND nicht Ihrer App hinzu. Diese Berechtigung sollte nur verwendet werden, um festzustellen, ob der Intent von der SMS Retriever API auf dem Broadcast-Empfänger stammt.

3. Bestätigungscode aus einer Nachricht abrufen

Verarbeiten Sie in der Methode onActivityResult() die Antwort des Nutzers auf Ihre Berechtigungsanfrage. Wenn Sie den Ergebniscode RESULT_OK erhalten, hat der Nutzer die Berechtigung zum Lesen des Nachrichteninhalts erteilt. Sie können den Nachrichtentext aus dem Intent abrufen.

Kotlin

public override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    when (requestCode) {
        // ...
        SMS_CONSENT_REQUEST ->
            // Obtain the phone number from the result
            if (resultCode == Activity.RESULT_OK && data != null) {
                // Get SMS message content
                val message = data.getStringExtra(SmsRetriever.EXTRA_SMS_MESSAGE)
                // Extract one-time code from the message and complete verification
                // `message` contains the entire text of the SMS message, so you will need
                // to parse the string.
                val oneTimeCode = parseOneTimeCode(message) // define this function

                // send one time code to the server
            } else {
                // Consent denied. User can type OTC manually.
            }
    }
}

Java

@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    switch (requestCode) {
        // ...
        case SMS_CONSENT_REQUEST:
            if (resultCode == RESULT_OK) {
                // Get SMS message content
                String message = data.getStringExtra(SmsRetriever.EXTRA_SMS_MESSAGE);
                // Extract one-time code from the message and complete verification
                // `sms` contains the entire text of the SMS message, so you will need
                // to parse the string.
                String oneTimeCode = parseOneTimeCode(message); // define this function

                // send one time code to the server
            } else {
                // Consent canceled, handle the error ...
            }
            break;
    }
}

Sobald Sie den Nachrichtentext erhalten haben, können Sie den Bestätigungscode analysieren und das Formular automatisch ausfüllen oder den Bestätigungsvorgang auf andere Weise abschließen.