Wysyłanie prośby o jednorazową zgodę na odczytanie kodu weryfikacyjnego z SMS-a

Na tej stronie dowiesz się, jak prosić użytkowników o zgodę za pomocą interfejsu SMS User Consent API aby odczytać pojedynczą wiadomość weryfikacyjną SMS. Jeśli użytkownik wyrazi zgodę, interfejs API zwróci Tekst wiadomości, z którego można pobrać kod weryfikacyjny, a następnie przejść proces weryfikacji.

Instalowanie zależności

Umieść komponent uwierzytelniania Usług Google Play w pliku build.gradle aplikacji:

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. Uzyskiwanie numeru telefonu użytkownika

Jeśli nie masz numeru telefonu użytkownika, poproś o nie, zanim zaczniesz wysyłać SMS-a proces weryfikacji.

Numer telefonu użytkownika można uzyskać w sposób odpowiedni dla jego . Rozważ użycie Selektor wskazówek dotyczących funkcji Smart Lock na hasła pomaganie użytkownikowi w uzupełnieniu numeru telefonu, jeśli te informacje nie są wymagane. aby utworzyć konto użytkownika. Aby użyć selektora podpowiedzi:

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. Zacznij nasłuchiwać wiadomości przychodzących

Następnie wywołaj metodę startSmsUserConsent() interfejsu SMS User Consent API, aby rozpocząć nasłuchiwanie przychodzących wiadomości. Jeśli znasz numer telefonu, z którego wysłano SMS-a pochodzi wiadomość, określ ją (w przeciwnym razie przekaż null). Dzięki temu SMS-y Interfejs User Consent API będzie uruchamiać się tylko w przypadku wiadomości z tego numeru.

Aby zacząć słuchać:

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

Gdy nasłuchujesz przychodzących SMS-ów, możesz włączyć weryfikację system wysyła kod weryfikacyjny na numer telefonu użytkownika podany co zrobić pierwszy krok.

Przez następne 5 minut, gdy urządzenie otrzyma SMS-a zawierającego za pomocą jednorazowego kodu, Usługi Google Play będą przekazywać do aplikacji komunikat z prośbą o zgodę. użytkownik ma uprawnienia do odczytania wiadomości. Komunikat aktywuje transmisję tylko wtedy, gdy spełnia te kryteria:

• Wiadomość zawiera ciąg alfanumeryczny o długości od 4 do 10 znaków, w którym co najmniej jeden numer.
• Jeśli podano numer telefonu nadawcy, wiadomość została wysłana z tego numeru. numer.

Obsługuj te komunikaty za pomocą odbiornika obsługującego SEND_PERMISSION uprawnienia i odpowiada na intencje SMS_RETRIEVED_ACTION. Aby tworzyć zarejestruj odbiornik:

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

Rozpoczynając aktywność na koncie EXTRA_CONSENT_INTENT, prosisz go o podanie jednorazowe uprawnienie do odczytu treści wiadomości.

Ważne: możesz wykryć, że intencja transmisji pochodzi z interfejsu SMS retriever API, dodanie uprawnienia com.google.android.gms.auth.api.phone.permission.SEND do odbiornika. To ustawienie uprawnień jest dostępne w Usługach Google Play wersji 19.8.31 lub nowszej.

Ważne: nie dodawaj uprawnienia com.google.android.gms.auth.api.phone.permission.SEND do Twojej aplikacji. Ten uprawnienia powinny być używane tylko do wykrywania intencji pochodzącej z modułu odbioru SMS-ów API w odbiorniku.

3. Uzyskaj kod weryfikacyjny z wiadomości

W metodzie onActivityResult() przetwórz odpowiedź użytkownika na Twoje żądanie w celu uzyskania uprawnień. Jeśli wyświetli się kod wyniku o wartości RESULT_OK, użytkownik przyznał uprawnienia do odczytu treści wiadomości, a następnie od intencji.

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

Po otrzymaniu wiadomości możesz przeanalizować kod weryfikacyjny i automatycznie wypełnić formularz lub w inny sposób dokończyć proces weryfikacji.