Menangani error verifikasi nomor telepon Firebase di Android

Jika panggilan ke library Firebase PNV gagal, library akan melaporkan FirebasePhoneNumberVerificationException. Halaman ini mencantumkan setiap kode error yang dapat dibawa oleh pengecualian, kapan setiap kode error terjadi, dan apa yang harus dilakukan aplikasi Anda terkait hal tersebut.

Halaman ini mengasumsikan bahwa Anda telah mengintegrasikan Firebase PNV seperti yang dijelaskan dalam Memulai Firebase Phone Number Verification di Android.

Cara error dilaporkan

• Metode asinkron (getVerificationSupportInfo(), getVerifiedPhoneNumber(), dan metode alur kustom) menampilkan Task. Jika gagal, Task akan gagal dengan FirebasePhoneNumberVerificationException, yang Anda terima di addOnFailureListener.

• enableTestSession() bersifat sinkron. Pengecualian FirebasePhoneNumberVerificationException akan langsung ditampilkan.

Baca errorCode pengecualian untuk mengetahui penyebab masalahnya. Kode Firebase PNV adalah konstanta dalam class FirebasePnvStatusCodes. Jika kegagalan berasal dari layanan Google Play, errorCode juga dapat berupa nilai CommonStatusCodes, seperti NETWORK_ERROR.

Perangkat atau SIM yang tidak didukung bukanlah error. getVerificationSupportInfo() berhasil dan melaporkan isSupported() sebagai false untuk SIM tersebut, dan getReason() memberi tahu Anda alasannya. Lihat Perangkat dan SIM yang tidak didukung.

Kode error

Penyiapan sesi pengujian

Error ini ditampilkan secara sinkron oleh enableTestSession().

Verifikasi

Error ini menggagalkan Task yang ditampilkan oleh getVerifiedPhoneNumber().

Pemeriksaan dukungan

Task yang ditampilkan oleh getVerificationSupportInfo() hanya gagal jika pemeriksaan itu sendiri tidak dapat dijalankan. Dalam hal ini, errorCode adalah nilai CommonStatusCodes layanan Google Play atau CARRIER_NOT_SUPPORTED. Perlakukan perangkat sebagai tidak didukung dan beralih ke metode verifikasi lain, seperti SMS.

Saat sesi pengujian diaktifkan, getVerificationSupportInfo() tidak akan menghubungi backend Firebase PNV dan selalu melaporkan SIM pengujian sebagai didukung, meskipun token pengujian telah habis masa berlakunya.

Alur kustom

Jika Anda menggunakan alur kustom, bukan getVerifiedPhoneNumber():

• getDigitalCredentialPayload() gagal dengan PREFLIGHT_CHECK_FAILED, atau dengan INVALID_TEST_NUMBER_ID jika backend menolak token pengujian Anda.
• exchangeCredentialResponseForPhoneNumber() gagal dengan INVALID_DIGITAL_CREDENTIAL_RESPONSE, atau dengan INVALID_TEST_NUMBER_ID jika backend menolak token pengujian Anda.
• Panggilan Anda sendiri ke Credential Manager menampilkan GetCredentialException, yang Anda tangani secara langsung.

Perangkat dan SIM yang tidak didukung

Jika isSupported() adalah false untuk SIM, getReason() akan menampilkan salah satu nilai VerificationSupportStatus berikut:

Dalam setiap kasus, gunakan metode verifikasi lain, seperti SMS, untuk SIM tersebut.

Contoh

Contoh berikut menangani error yang perlu dibedakan oleh aplikasi standar saat memanggil 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()
        }
    }
}

Dalam contoh ini, showSmsVerification() adalah alur verifikasi nomor telepon yang ada di aplikasi Anda.

Langkah berikutnya

• Untuk mengetahui detail tentang setiap class dan konstanta, lihat referensi API Firebase PNV.
• Untuk memverifikasi token di server Anda, lihat Memverifikasi token Firebase PNV.