Чтобы автоматически подтверждать номера телефонов, необходимо реализовать клиентскую и серверную части процесса подтверждения. В этом документе рассказывается, как реализовать клиентскую часть в приложении для Android.
Чтобы начать подтверждение номера телефона в приложении для Android, отправьте номер телефона на сервер проверки и вызовите SMS Retriever API, чтобы начать прослушивание SMS-сообщения с одноразовым кодом для вашего приложения. После получения сообщения отправьте одноразовый код обратно на сервер, чтобы завершить процесс проверки.
Чтобы подготовить приложение, выполните нужные действия в разделах, указанных ниже.
Требования к приложению
Убедитесь, что в файле сборки приложения приведены значения, указанные ниже.
- минимальная версия SDK – 19 или выше;
- compileSdkVersion 28 или более поздней версии.
Настройка приложения
В файле build.gradle на уровне проекта добавьте репозиторий Maven от Google и центральный репозиторий Maven в разделы buildscript и allprojects:
buildscript {
repositories {
google()
mavenCentral()
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
Добавьте зависимость сервисов Google Play для SMS Retriever API в файл build.gradle модуля – обычно это app/build.gradle:
dependencies {
implementation 'com.google.android.gms:play-services-auth:22.0.0'
implementation 'com.google.android.gms:play-services-auth-api-phone:18.3.1'
}
Как получить номер телефона пользователя
Вы можете получить номер телефона пользователя любым подходящим для вашего приложения способом. Часто удобнее всего использовать подсказки, чтобы пользователь мог выбрать номер телефона, сохраненный на устройстве, и не вводить его вручную. Чтобы использовать подсказки:
// 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
}
}
}
Как запустить SMS Retriever
Когда вы будете готовы подтвердить номер телефона пользователя, получите экземпляр объекта SmsRetrieverClient, вызовите startSmsRetriever и прикрепите к задаче получения 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 using 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
// ...
}
});
Задача получения SMS ожидает до пяти минут, пока не будет получено SMS-сообщение, содержащее уникальную строку, которая идентифицирует ваше приложение.
Отправьте номер телефона на свой сервер
Получив номер телефона пользователя и начав прослушивать SMS-сообщения, отправьте номер телефона пользователя на сервер проверки любым способом (обычно с помощью запроса HTTPS POST).
Ваш сервер сгенерирует проверочное сообщение и отправит его в виде SMS на указанный номер телефона. Подробнее о том, как выполнить проверку по SMS на сервере…
получать сообщения с кодом подтверждения;
Когда на устройство пользователя приходит сообщение с кодом подтверждения, сервисы Google Play явным образом передают в ваше приложение SmsRetriever.SMS_RETRIEVED_ACTION Intent, содержащий текст сообщения. Используйте BroadcastReceiver, чтобы получить это сообщение с кодом подтверждения.
В обработчике BroadcastReceiver для onReceive получите текст сообщения с кодом подтверждения (и, при необходимости, адрес отправителя) из дополнительных данных намерения:
/**
* BroadcastReceiver to wait for SMS messages. This can be registered either
* in the AndroidManifest or at runtime. Filters 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;
}
}
}
}
Чтобы зарегистрировать BroadcastReceiver, используйте следующие данные:
- Фильтр интентов:
com.google.android.gms.auth.api.phone.SMS_RETRIEVED(значение константыSmsRetriever.SMS_RETRIEVED_ACTION) - Разрешение:
com.google.android.gms.auth.api.phone.permission.SEND(значение константыSmsRetriever.SEND_PERMISSION).
Вы можете зарегистрировать получателя в файле AndroidManifest.xml своего приложения, как показано в примере ниже, или динамически с помощью 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>
Отправьте одноразовый код из сообщения с подтверждением на свой сервер.
Теперь, когда у вас есть текст сообщения с кодом подтверждения, используйте регулярное выражение или другую логику, чтобы получить одноразовый код из сообщения. Формат одноразового кода зависит от того, как вы реализовали его на сервере.
Наконец, отправьте одноразовый код на свой сервер по защищенному соединению. Когда ваш сервер получит одноразовый код, он запишет, что номер телефона подтвержден.