如要自動驗證電話號碼,您必須同時導入用戶端和 驗證流程的伺服器部分。本文件說明如何 在 Android 應用程式中實作用戶端部分。
如要在 Android 應用程式中啟動電話號碼驗證流程,請將 將電話號碼傳送至您的驗證伺服器,然後呼叫 SMS Retriever API 即可開始 監聽含有應用程式的一次性代碼的簡訊。之後 收到訊息後,你必須將一次性代碼傳回至你的伺服器以完成作業 進行驗證
事前準備
如要讓應用程式做好準備,請完成下列各節的步驟。
應用程式必要條件
請確認應用程式的版本檔案使用下列的值:
- 19 以上版本的 minSdkVersion
- 28 以上版本的 compileSdkVersion
設定應用程式
在專案層級的 build.gradle 檔案中,加入 Google 的 Maven 存放區
和 Maven 中央存放區
請在 buildscript
和 allprojects
區段中執行:
buildscript {
repositories {
google()
mavenCentral()
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
新增 Google Play 服務依附元件
新增至模組 Gradle 版本檔案的 SMS Retriever API
通常為 app/build.gradle
:
dependencies {
implementation 'com.google.android.gms:play-services-auth:21.2.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. 啟動簡訊擷取程式
當您準備好驗證使用者的電話號碼時,請取得
SmsRetrieverClient
物件、呼叫 startSmsRetriever
,然後附加成功和
失敗接聽程式:
// 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
// ...
}
});
簡訊擷取工作最多將監聽 5 分鐘的 SMS 訊息 ,其中包含用於識別應用程式的不重複字串。
3. 將電話號碼傳送至您的伺服器
取得使用者的電話號碼並開始收聽簡訊後 訊息,將使用者的電話號碼傳送至您的驗證伺服器 方法 (通常來自 HTTPS POST 要求)。
您的伺服器產生驗證訊息,並以 SMS 簡訊傳送至手機 指定的編號請參閱「在伺服器上執行簡訊驗證」一文。
4. 接收驗證訊息
當使用者的裝置收到驗證訊息時,Play 服務
明確向應用程式廣播 SmsRetriever.SMS_RETRIEVED_ACTION
意圖。
,其中包含訊息文字。使用「BroadcastReceiver
」接收
這則驗證郵件
在 BroadcastReceiver
的 onReceive
處理常式中,取得
來自 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
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. 將驗證郵件中的動態驗證碼傳送到你的伺服器
取得驗證訊息的文字後,請使用規則運算式 或其他邏輯,以便從訊息中取得一次性程式碼。 一次性程式碼,取決於您在伺服器中實作程式碼的方式。
最後,透過安全連線將一次性代碼傳送至你的伺服器。時間 您的伺服器收到動態驗證碼後,就會記下電話號碼 已通過驗證。