Cómo solicitar el consentimiento único para leer un código de verificación por SMS

En esta página, se describe cómo usar la API de SMS User Consent para solicitar su consentimiento para leer un solo mensaje de verificación SMS. Si el usuario otorga su consentimiento, la API muestra el texto del mensaje, del cual puedes obtener el código de verificación y completar el proceso de verificación.

Instala dependencias

Incluye el componente de autenticación de los Servicios de Play en el archivo build.gradle de tu app:

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. Obtén el número de teléfono del usuario

Si no tienes el número de teléfono del usuario, solicítalo antes de iniciar un SMS de verificación de identidad.

Puede obtener el número de teléfono del usuario de un modo adecuado para su . Considera usar la Selector de sugerencias de Smart Lock para contraseñas para ayudar al usuario a completar su número de teléfono si esa información no era necesaria para crear la cuenta del usuario. Para usar el selector de sugerencias, haz lo siguiente:

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. Comienza a escuchar los mensajes entrantes

A continuación, llama al método startSmsUserConsent() de la API de SMS User Consent para comenzar a la escucha de mensajes entrantes. Si sabes el número de teléfono desde el que se envió el SMS se originará el mensaje y especifícalo (de lo contrario, pasa null). De esta manera, el SMS La API de User Consent solo se activará en los mensajes de este número.

Sigue estos pasos para comenzar a escuchar:

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

Una vez que estés escuchando los SMS entrantes, puedes tener tu verificación envía el código de verificación al número de teléfono del usuario, que ingresaste el primer paso.

Durante los siguientes cinco minutos, cuando el dispositivo reciba un mensaje SMS que contenga un código único, los Servicios de Play transmitirán a tu app un intent para solicitarlo al usuario a fin de obtener permiso para leer el mensaje. Un mensaje activa la transmisión solo si cumple con los siguientes criterios:

• El mensaje contiene una cadena alfanumérica de 4 a 10 caracteres con al menos uno de la fila.
• Si especificaste el número de teléfono del remitente, esa persona envió el mensaje. de la fila.

Controla estas transmisiones con un receptor de emisión que tenga SEND_PERMISSION. permiso y responde a los intents SMS_RETRIEVED_ACTION. Para crear y registra el receptor de emisión:

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

Cuando inicias una actividad para EXTRA_CONSENT_INTENT, le solicitas al usuario lo siguiente: permiso único para leer el contenido del mensaje.

Importante: Puedes detectar que el intent de transmisión es de la API de SMS Retriever agregar el permiso com.google.android.gms.auth.api.phone.permission.SEND tu receptor. Este parámetro de configuración de permisos está disponible en los Servicios de Google Play versión 19.8.31 o posterior.

Importante: No agregues el permiso. com.google.android.gms.auth.api.phone.permission.SEND a tu app. Esta el permiso solo debe usarse para detectar que el intent es del recuperador de SMS API en el receptor de emisión.

3. Cómo obtener el código de verificación de un mensaje

En el método onActivityResult(), controla la respuesta del usuario a tu solicitud. permiso. Si obtienes un código de resultado RESULT_OK, el usuario otorgó permiso para leer el contenido del mensaje y puedes obtener el texto del intent.

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

Una vez que tengas el texto del mensaje, podrás analizar el código de verificación y Autocompletar el formulario o completar el flujo de verificación de alguna otra manera.