หากต้องการยืนยันหมายเลขโทรศัพท์โดยอัตโนมัติ คุณต้องติดตั้งใช้งานทั้งส่วนไคลเอ็นต์และเซิร์ฟเวอร์ของขั้นตอนการยืนยัน เอกสารนี้อธิบายวิธีติดตั้งใช้งานส่วนไคลเอ็นต์ในแอป Android
หากต้องการเริ่มขั้นตอนการยืนยันหมายเลขโทรศัพท์ในแอป Android ให้ส่งหมายเลขโทรศัพท์ไปยังเซิร์ฟเวอร์การยืนยันและเรียก SMS Retriever API เพื่อเริ่มรับฟังข้อความ SMS ที่มีรหัสแบบครั้งเดียวสําหรับแอปของคุณ หลังจากได้รับข้อความแล้ว ให้ส่งรหัสแบบครั้งเดียวกลับไปยังเซิร์ฟเวอร์เพื่อดําเนินการยืนยันให้เสร็จสมบูรณ์
ก่อนเริ่มต้น
หากต้องการเตรียมแอป ให้ทำตามขั้นตอนในส่วนต่อไปนี้
ข้อกําหนดเบื้องต้นของแอป
ตรวจสอบว่าไฟล์บิลด์ของแอปใช้ค่าต่อไปนี้
- minSdkVersion 19 ขึ้นไป
- compileSdkVersion เท่ากับ 28 ขึ้นไป
กำหนดค่าแอป
ในไฟล์ build.gradle ระดับโปรเจ็กต์ ให้ใส่ที่เก็บ Maven ของ Google และที่เก็บ Maven กลางในส่วน buildscript
และ allprojects
ดังนี้
buildscript {
repositories {
google()
mavenCentral()
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
เพิ่มทรัพยากร Dependency ของ Google Play Services สำหรับ SMS Retriever API ลงในไฟล์บิลด์ Gradle ของโมดูล ซึ่งโดยทั่วไปคือ app/build.gradle
dependencies {
implementation 'com.google.android.gms:play-services-auth:21.3.0'
implementation 'com.google.android.gms:play-services-auth-api-phone:18.1.0'
}
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
}
}
}
2. เริ่มเครื่องมือดึงข้อมูล SMS
เมื่อพร้อมที่จะยืนยันหมายเลขโทรศัพท์ของผู้ใช้ ให้รับอินสแตนซ์ของออบเจ็กต์ 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 via 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 ที่มีสตริงที่ไม่ซ้ำกันซึ่งระบุแอปของคุณสูงสุด 5 นาที
3. ส่งหมายเลขโทรศัพท์ไปยังเซิร์ฟเวอร์
หลังจากได้รับหมายเลขโทรศัพท์ของผู้ใช้และเริ่มรับฟังข้อความ SMS แล้ว ให้ส่งหมายเลขโทรศัพท์ของผู้ใช้ไปยังเซิร์ฟเวอร์การยืนยันโดยใช้วิธีการใดก็ได้ (โดยปกติจะใช้คำขอ HTTPS POST)
เซิร์ฟเวอร์จะสร้างข้อความยืนยันและส่งทาง SMS ไปยังหมายเลขโทรศัพท์ที่คุณระบุ ดูทำการยืนยันทาง SMS ในเซิร์ฟเวอร์
4. รับข้อความยืนยัน
เมื่อได้รับข้อความยืนยันในอุปกรณ์ของผู้ใช้ บริการ Play จะประกาศ SmsRetriever.SMS_RETRIEVED_ACTION
Intent ไปยังแอปของคุณอย่างชัดเจน ซึ่งมีข้อความของข้อความ ใช้ BroadcastReceiver
เพื่อรับข้อความยืนยันนี้
ในตัวแฮนเดิล onReceive
ของ BroadcastReceiver
ให้รับข้อความยืนยัน (และที่อยู่ผู้ส่ง หากต้องการ) จากข้อมูลเสริมของ Intent ดังนี้
/**
* BroadcastReceiver to wait for SMS messages. This can be registered either
* in the AndroidManifest or at runtime. Should filter 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
นี้กับตัวกรอง Intent
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>
5. ส่งรหัสแบบใช้ครั้งเดียวจากข้อความยืนยันไปยังเซิร์ฟเวอร์
เมื่อคุณมีข้อความยืนยันแล้ว ให้ใช้นิพจน์ทั่วไปหรือตรรกะอื่นๆ เพื่อรับรหัสแบบครั้งเดียวจากข้อความ รูปแบบของรหัสแบบครั้งเดียวจะขึ้นอยู่กับวิธีที่คุณติดตั้งใช้งานในเซิร์ฟเวอร์
สุดท้าย ให้ส่งรหัสที่สามารถใช้งานได้เพียงครั้งเดียวไปยังเซิร์ฟเวอร์ผ่านการเชื่อมต่อที่ปลอดภัย เมื่อเซิร์ฟเวอร์ได้รับรหัสแบบครั้งเดียว ก็จะบันทึกว่าหมายเลขโทรศัพท์ได้รับการยืนยันแล้ว