Richiesta di verifica SMS in un'app Android

Per verificare automaticamente i numeri di telefono, devi implementare sia la parte client che quella server del flusso di verifica. Questo documento descrive come implementare la parte client in un'app per Android.

Per avviare il flusso di verifica del numero di telefono in un'app per Android, invia il numero di telefono al server di verifica e chiama l'API SMS Retriever per iniziare ad ascoltare un messaggio SMS contenente un codice una tantum per la tua app. Dopo aver ricevuto il messaggio, invia il codice una tantum al server per completare la procedura di verifica.

Per preparare l'app, completa i passaggi descritti nelle sezioni seguenti.

Prerequisiti per le app

Assicurati che il file di build dell'app utilizzi i seguenti valori:

  • minSdkVersion 19 o versioni successive
  • compileSdkVersion 28 o versioni successive

Configura la tua app

Nel file build.gradle a livello di progetto, includi il repository Maven di Google e il repository centrale Maven nelle sezioni buildscript e allprojects:

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

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

Aggiungi la dipendenza Google Play Services per l'API SMS Retriever al file di build Gradle del modulo, che in genere è app/build.gradle:

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

1. Ottenere il numero di telefono dell'utente

Puoi ottenere il numero di telefono dell'utente nel modo più appropriato per la tua app. Spesso, la migliore esperienza utente è quella di utilizzare il selettore di suggerimenti per chiedere all'utente di scegliere tra i numeri di telefono memorizzati sul dispositivo ed evitare così di dover digitare manualmente un numero di telefono. Per utilizzare il selettore di suggerimenti:

// 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. Avviare il recupero degli SMS

Quando è tutto pronto per verificare il numero di telefono dell'utente, recupera un'istanza dell'oggetto SmsRetrieverClient, chiama startSmsRetriever e collega i listener di esito positivo e negativo all'attività di recupero degli 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
    // ...
  }
});

L'attività di recupero degli SMS rimane in ascolto per un massimo di cinque minuti per un messaggio SMS che contiene una stringa univoca che identifica la tua app.

3. Invia il numero di telefono al tuo server.

Dopo aver ottenuto il numero di telefono dell'utente e aver iniziato ad ascoltare i messaggi SMS, invia il numero di telefono dell'utente al tuo server di verifica utilizzando qualsiasi metodo (di solito con una richiesta HTTPS POST).

Il server genera un messaggio di verifica e lo invia via SMS al numero di telefono che hai specificato. Consulta la sezione Eseguire la verifica via SMS sul server.

4. Ricevere messaggi di verifica

Quando viene ricevuto un messaggio di verifica sul dispositivo dell'utente, Play Services trasmette esplicitamente alla tua app un intent SmsRetriever.SMS_RETRIEVED_ACTION, che contiene il testo del messaggio. Utilizza un BroadcastReceiver per ricevere questo messaggio di verifica.

Nell'handler BroadcastReceiver di onReceive, recupera il testo del messaggio di verifica (e, facoltativamente, l'indirizzo del mittente) dagli extra dell'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:
          // (Optional) Get SMS Sender address - only available in
          // GMS version 24.20 onwards, else it will return null
          String senderAddress = extras.getString(SmsRetriever.EXTRA_SMS_ORIGINATING_ADDRESS);
          // Get SMS message contents
          String message = extras.getString(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;
      }
    }
  }
}

Registra questo BroadcastReceiver con il filtro per intent com.google.android.gms.auth.api.phone.SMS_RETRIEVED (il valore della costante SmsRetriever.SMS_RETRIEVED_ACTION) e l'autorizzazione com.google.android.gms.auth.api.phone.permission.SEND (il valore della costante SmsRetriever.SEND_PERMISSION) nel file AndroidManifest.xml della tua app, come nell'esempio seguente, o in modo dinamico utilizzando 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. Invia il codice monouso dal messaggio di verifica al tuo server

Ora che hai il testo del messaggio di verifica, utilizza un'espressione regolare o un'altra logica per ottenere il codice monouso dal messaggio. Il formato del codice monouso dipende da come li hai implementati nel server.

Infine, invia il codice monouso al server tramite una connessione sicura. Quando il server riceve il codice monouso, registra che il numero di telefono è stato verificato.