Solicitar consentimento único para ler um código de verificação por SMS

Esta página descreve como usar a API SMS User Consent para solicitar o consentimento do usuário para ler uma única mensagem de verificação SMS. Se o usuário consente, a API retorna o texto da mensagem, da qual você pode obter o código de verificação e concluir o processo de verificação.

Instalar dependências

Inclua o componente de autenticação do Google Play Services no arquivo build.gradle do seu 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. Receber o número de telefone do usuário

Se você não tiver o número de telefone do usuário, solicite-o antes de enviar um SMS. fluxo de verificação.

Você pode obter o número de telefone do usuário de forma adequada para sua app. Considere usar o Seletor de dicas do Smart Lock para senhas para ajudar o usuário a preencher o número de telefone se essa informação não for necessária. para criar a conta do usuário. Para usar o seletor de dica:

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
           
}
       
// ...
   
}
}
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. Começar a detectar mensagens recebidas

Em seguida, chame o método startSmsUserConsent() da API SMS User Consent para começar. detectando as mensagens recebidas. Se você souber o número de telefone do qual o SMS a mensagem será originada, especifique-a (caso contrário, transmita null). Dessa forma, o SMS A API User Consent será acionada somente nas mensagens desse número.

Para começar a ouvir:

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

Quando ouvir as mensagens SMS recebidas, você poderá fazer a verificação sistema, envie o código de verificação para o número de telefone do usuário, que você recebeu a primeira etapa.

Nos próximos cinco minutos, quando o dispositivo receber uma mensagem SMS contendo um código único, o Google Play Services transmitirá ao seu app uma intent para solicitar a permissão de leitura da mensagem. Uma mensagem aciona a transmissão somente se atender a estes critérios:

  • A mensagem contém uma sequência alfanumérica de 4 a 10 caracteres com pelo menos um número
  • Se você especificou o número de telefone do remetente, a mensagem foi enviada por ele número

Processe essas transmissões com um broadcast receiver que tenha o SEND_PERMISSION e responde a intents SMS_RETRIEVED_ACTION. Para criar e registre o broadcast receiver:

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

Ao iniciar uma atividade para EXTRA_CONSENT_INTENT, você solicita que o usuário permissão única para ler o conteúdo da mensagem.

3. Receber o código de verificação de uma mensagem

No método onActivityResult(), processe a resposta do usuário à sua solicitação solicitando permissão. Se você receber um código de resultado RESULT_OK, o usuário concedeu permissão para ler o conteúdo da mensagem e receber o texto dela da intent.

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

Depois de receber o texto da mensagem, você pode analisar o código de verificação e preencher automaticamente o formulário ou concluir o fluxo de verificação.