Android で Firebase の電話番号の確認エラーを処理する

Firebase PNV ライブラリの呼び出しが失敗すると、ライブラリは FirebasePhoneNumberVerificationException を報告します。このページでは、例外が返す可能性のあるすべてのエラーコード、各エラーコードが発生するタイミング、アプリがそれに対して行うべき処理について説明します。

このページでは、Android で Firebase Phone Number Verification を使ってみるの説明に沿って Firebase PNV を統合していることを前提としています。

エラーの報告方法

• 非同期メソッド（getVerificationSupportInfo()、getVerifiedPhoneNumber()、カスタムフロー メソッド）は Task を返します。失敗すると、Task は FirebasePhoneNumberVerificationException で失敗し、addOnFailureListener で受信されます。

• enableTestSession() は同期です。FirebasePhoneNumberVerificationException を直接スローします。

例外の errorCode を読み、何が問題だったかを確認します。Firebase PNV コードは、FirebasePnvStatusCodes クラスの定数です。Google Play 開発者サービスでエラーが発生した場合、errorCode は NETWORK_ERROR などの CommonStatusCodes 値になることもあります。

サポートされていないデバイスまたは SIM はエラーではありません。getVerificationSupportInfo() が成功し、その SIM の isSupported() が false として報告され、getReason() でその理由が示されます。サポートされていないデバイスと SIM を参照してください。

エラーコード

テスト セッションのセットアップ

これらのエラーは、enableTestSession() によって同期的にスローされます。

検証

これらのエラーが発生すると、getVerifiedPhoneNumber() によって返される Task が失敗します。

サポート チェック

getVerificationSupportInfo() によって返される Task は、チェック自体を実行できない場合にのみ失敗します。この場合、errorCode は Google Play 開発者サービスの CommonStatusCodes 値または CARRIER_NOT_SUPPORTED です。デバイスをサポート対象外として扱い、SMS などの別の確認方法にフォールバックします。

テスト セッションが有効になっている間、getVerificationSupportInfo() は Firebase PNV バックエンドに接続せず、テストトークンの有効期限が切れている場合でも、テスト SIM を常にサポート対象として報告します。

カスタムフロー

getVerifiedPhoneNumber() ではなくカスタムフローを使用する場合:

• getDigitalCredentialPayload() は PREFLIGHT_CHECK_FAILED で失敗します。バックエンドがテストトークンを拒否した場合は INVALID_TEST_NUMBER_ID で失敗します。
• exchangeCredentialResponseForPhoneNumber() が INVALID_DIGITAL_CREDENTIAL_RESPONSE で失敗するか、バックエンドがテストトークンを拒否した場合は INVALID_TEST_NUMBER_ID で失敗します。
• 認証情報マネージャーへの独自の呼び出しで GetCredentialException がスローされ、直接処理されます。

サポートされていないデバイスと SIM

SIM の isSupported() が false の場合、getReason() は次の VerificationSupportStatus 値のいずれかを返します。

いずれの場合も、その SIM には SMS などの別の確認方法を使用してください。

例

次の例では、getVerifiedPhoneNumber() を呼び出すときに一般的なアプリが区別する必要があるエラーを処理しています。

import android.util.Log
// Credential Manager is included with the Firebase PNV library.
import androidx.credentials.exceptions.GetCredentialCancellationException
import com.google.firebase.pnv.FirebasePhoneNumberVerification
import com.google.firebase.pnv.FirebasePhoneNumberVerificationException
import com.google.firebase.pnv.FirebasePnvStatusCodes

private const val TAG = "PhoneVerification"

// In your Activity:
private fun verifyPhoneNumber() {
    FirebasePhoneNumberVerification.getInstance()
        .getVerifiedPhoneNumber(this)
        .addOnSuccessListener { result ->
            // Send result.getToken() to your backend.
        }
        .addOnFailureListener { e -> handleFpnvError(e) }
}

private fun handleFpnvError(e: Exception) {
    if (e !is FirebasePhoneNumberVerificationException) {
        Log.w(TAG, "Firebase PNV failed", e)
        showSmsVerification()
        return
    }
    when (e.errorCode) {
        FirebasePnvStatusCodes.CREDENTIAL_MANAGER_ERROR -> {
            if (e.cause is GetCredentialCancellationException) {
                // The user dismissed the consent screen.
            }
            showSmsVerification()
        }
        FirebasePnvStatusCodes.INVALID_TEST_NUMBER_ID -> {
            // Test mode only: generate a new test token.
            Log.e(TAG, "Firebase PNV test token rejected", e)
        }
        FirebasePnvStatusCodes.ACTIVITY_CONTEXT_REQUIRED -> {
            // App bug: pass an Activity to getVerifiedPhoneNumber().
            Log.e(TAG, "Firebase PNV needs an Activity context", e)
        }
        else -> {
            // Carrier not supported, network errors, and other failures.
            Log.w(TAG, "Firebase PNV failed with error code ${e.errorCode}", e)
            showSmsVerification()
        }
    }
}

この例では、showSmsVerification() はアプリの既存の電話番号確認フローです。

次のステップ

• 各クラスと定数の詳細については、Firebase PNV API リファレンスをご覧ください。
• サーバーでトークンを検証するには、Firebase PNV トークンを検証するをご覧ください。