Bu sayfada, tek bir SMS doğrulama mesajını okumak için kullanıcıdan izin istemek amacıyla SMS User Consent API'nin nasıl kullanılacağı açıklanmaktadır. Kullanıcı izin verirse API mesaj metnini döndürür. Bu metinden doğrulama kodunu alabilir ve doğrulama sürecini tamamlayabilirsiniz.
Bağımlıları yükleme
Play Hizmetleri kimlik doğrulama bileşenini uygulamanızın build.gradle dosyasına ekleyin:
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. Kullanıcının telefon numarasını alma
Kullanıcının telefon numarası yoksa SMS doğrulama akışı başlatmadan önce numara isteyin.
Kullanıcının telefon numarasını uygulamanıza uygun bir şekilde edinebilirsiniz. Kullanıcının hesabını oluşturmak için bu bilgiler gerekmiyorsa kullanıcının telefon numarasını doldurmasına yardımcı olmak üzere Şifreler için Smart Lock ipucu seçiciyi kullanabilirsiniz. İpucu seçiciyi kullanmak için:
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. Gelen mesajları dinlemeye başla
Ardından, gelen mesajları işlemeye başlamak için SMS User Consent API'nin startSmsUserConsent() yöntemini çağırın. SMS mesajının iletildiği telefon numarasını biliyorsanız bu numarayı belirtin (aksi halde null değerini de geçirin). Bu şekilde, SMS User Consent API yalnızca bu numaradan gelen mesajlarda tetiklenir.
Dinlemeye başlamak için:
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 */);
Gelen SMS mesajlarını dinledikten sonra, doğrulama sisteminizin doğrulama kodunu kullanıcının ilk adımda aldığınız telefon numarasına göndermesini sağlayabilirsiniz.
Cihaz, tek seferlik kod içeren bir SMS mesajı aldığında Play Hizmetleri, sonraki beş dakika boyunca uygulamanıza mesajı okuma izni vermek için bir niyet yayınlar. Bir mesaj, yalnızca şu ölçütleri karşılıyorsa yayını tetikler:
- Mesaj, en az bir rakam içeren 4-10 karakterlik alfanümerik bir dize içerir.
- Gönderenin telefon numarasını belirttiyseniz, ileti bu numara tarafından gönderilmiştir.
Bu yayınları, SEND_PERMISSION iznine sahip ve SMS_RETRIEVED_ACTION amaçlarına yanıt veren bir yayın alıcısıyla yönetin. Yayın alıcısını oluşturmak ve kaydetmek için:
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);
}
EXTRA_CONSENT_INTENT için bir etkinlik başlatarak mesajın içeriğini okumak için kullanıcıdan tek seferlik izin istersiniz.
3. Doğrulama kodunu mesajla alma
onActivityResult() yönteminde, kullanıcının izin isteğinize verdiği yanıtı işleyin. RESULT_OK sonuç kodunu alırsanız kullanıcı, mesajın içeriğini okuma izni vermiştir ve mesaj metnini amaçtan alabilirsiniz.
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;
}
}
Mesaj metnini aldıktan sonra doğrulama kodunu ayrıştırabilir ve formu otomatik olarak doldurabilir veya doğrulama akışını başka bir şekilde tamamlayabilirsiniz.