Einmalige Einwilligung zum Lesen eines SMS-Bestätigungscodes anfordern

Auf dieser Seite wird beschrieben, wie Sie mit der SMS User Consent API die Nutzereinwilligung einholen. um eine einzelne SMS-Bestätigungsnachricht zu lesen. Wenn der Nutzer einwilligt, gibt die API Text der Nachricht, über den Sie den Bestätigungscode und führen Sie den Bestätigungsvorgang aus.

Abhängigkeiten installieren

Fügen Sie die Play-Dienste-Authentifizierungskomponente in die Datei build.gradle Ihrer 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 ermitteln

Wenn Sie die Telefonnummer des Nutzers nicht kennen, fordern Sie sie an, bevor Sie eine SMS senden des Bestätigungsvorgangs.

Sie können die Telefonnummer des Nutzers auf eine Weise ermitteln, die für Ihren Erwägen Sie die Verwendung des Hinweisauswahl für Smart Lock für Passwörter dem Nutzer beim Ausfüllen der Telefonnummer zu helfen, falls diese Informationen nicht erforderlich waren. um das Nutzerkonto zu erstellen. 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 warten. Wenn Sie die Telefonnummer kennen, von der die SMS Nachricht erstellt haben, geben Sie sie an (übergeben Sie andernfalls null). Auf diese Weise werden die SMS Die User Consent API wird nur bei Nachrichten von dieser Nummer ausgelöst.

So beginnst du mit der Spracheingabe:

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 eingehende SMS empfangen haben, können Sie Ihre Bestätigung System sendet den Bestätigungscode an die Telefonnummer des Nutzers, die du im den ersten Schritt.

Wenn das Gerät in den nächsten fünf Minuten eine SMS mit folgendem Inhalt erhält, einmaligen Code senden, senden die Play-Dienste eine Aufforderung an deine App, um die Berechtigung zum Lesen der Nachricht zu erhalten. Eine Nachricht löst den Broadcast aus wenn folgende Kriterien erfüllt sind:

• Die Nachricht enthält einen alphanumerischen String mit 4–10 Zeichen und mindestens einem Nummer.
• Wenn Sie die Telefonnummer des Absenders angegeben haben, Nummer.

Diese Broadcasts mit einem Übertragungsempfänger verarbeiten, der die SEND_PERMISSION hat Berechtigung und antwortet auf SMS_RETRIEVED_ACTION Intents. Um ein neues den Übertragungsempfänger registrieren:

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 dazu auf einmalige Berechtigung zum Lesen des Nachrichteninhalts.

Wichtig: Sie können erkennen, dass der Broadcast-Intent von der SMS Retriever API stammt, indem Sie Hinzufügen der Berechtigung com.google.android.gms.auth.api.phone.permission.SEND zu an deinen Receiver. Diese Berechtigungseinstellung ist in den Google Play-Diensten verfügbar Version 19.8.31 oder höher.

Wichtig: Fügen Sie die Berechtigung nicht hinzu. com.google.android.gms.auth.api.phone.permission.SEND zu deiner App hinzufügen. Dieses Die Berechtigung sollte nur verwendet werden, um zu erkennen, dass der Intent vom SMS Retriever stammt API auf dem Übertragungsempfänger.

3. Bestätigungscode aus einer Nachricht abrufen

In der Methode onActivityResult() die Antwort des Nutzers auf Ihre Anfrage verarbeiten um eine Genehmigung zu erhalten. Wenn Sie den Ergebniscode RESULT_OK erhalten, hat der Nutzer, der um den Inhalt der Nachricht zu lesen und den Nachrichtentext aus der Intention.

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 haben, können Sie den Bestätigungscode parsen das Formular automatisch ausfüllen oder den Bestätigungsvorgang auf andere Weise abschließen.