Nomor Telepon Terverifikasi Sebelumnya

Dokumen ini menjelaskan cara menawarkan nomor telepon bisnis yang terverifikasi sebelumnya ke klien akhir bisnis Anda di alur Pendaftaran Tersemat yang baru. Nomor telepon bisnis yang terverifikasi sebelumnya adalah nomor telepon bisnis yang telah Anda verifikasi, sehingga klien akhir tidak perlu menghubungi Anda untuk mendapatkan kata sandi sekali pakai.

Perhatikan bahwa nomor telepon bisnis yang terverifikasi sebelumnya diwakili oleh objek Nomor Telepon Terverifikasi Sebelumnya WhatsApp Business, yang bersifat sementara. Ketika klien akhir memilih salah satu nomor ini dan menyelesaikan alur Pendaftaran Tersemat yang baru, objek sementara akan digantikan oleh objek Nomor Telepon WhatsApp Business dan Anda harus mendapatkan ID objek baru untuk mendaftarkan nomor tersebut.

Persyaratan

• Bisnis Anda harus menjadi Mitra Solusi yang disetujui.
• Pengguna aplikasi harus menjadi admin bisnis pada akun bisnis tempat nomor telepon bisnis yang terverifikasi sebelumnya ditambahkan.
• Token akses Pengguna Sistem atau token akses Pengguna.
• Izin business_management.
• Nomor telepon bisnis harus valid.

Batasan

• Hanya tersedia dengan alur Pendaftaran Tersemat yang baru. Lihat dokumen Alur Menyematkan Pendaftaran untuk mempelajari cara mengaktifkan alur baru.
• Anda bertanggung jawab untuk melacak siapa yang telah mengeklaim nomor telepon bisnis yang terverifikasi sebelumnya.
• Jika nomor telepon bisnis yang terverifikasi sebelumnya tidak diklaim oleh klien akhir di alur Pendaftaran Tersemat dalam 90 hari sejak verifikasi, nomor tersebut akan kembali ke status belum terverifikasi dan harus diverifikasi lagi agar statusnya dipulihkan selama 90 hari berikutnya.
• Nomor telepon bisnis yang terverifikasi sebelumnya yang tidak diklaim tidak dapat diverifikasi ulang hingga 45 hari sebelum dijadwalkan untuk kembali ke status belum terverifikasi. Waktu ini ditunjukkan oleh verification_expiry_time kolom.
• Jika Anda menambahkan nomor telepon ke kelompok nomor telepon bisnis yang terverifikasi sebelumnya (Langkah 1), tetapi tidak memverifikasinya dalam waktu 90 hari (Langkah 3), nomor tersebut akan dihapus dari kelompok nomor tersebut dan Anda harus menambahkannya lagi.

Membuat Nomor Telepon Terverifikasi Sebelumnya

Ikuti langkah-langkah berikut untuk membuat nomor telepon bisnis yang terverifikasi sebelumnya, menampilkannya di Pendaftaran Tersemat, dan mendaftarkannya setelah diklaim oleh klien akhir.

Langkah 1: Buat nomor telepon bisnis yang terverifikasi sebelumnya

Gunakan endpoint Akun Bisnis > Tambahkan Nomor Telepon untuk membuat nomor telepon bisnis yang terverifikasi sebelumnya di bisnis Anda. Endpoint ini akan menambahkan nomor tersebut ke kelompok nomor Anda.

Sintaksis Permintaan

POST /<BUSINESS_ACCOUNT_ID>/add_phone_numbers
  ?phone_number=<PHONE_NUMBER>

Tanggapan

Setelah berhasil, API akan menampilkan ID Nomor Telepon Terverifikasi Sebelumnya di WhatsApp Business. Simpan nilai ini untuk digunakan di permintaan berikutnya.

{
  "id": "<WHATSAPP_BUSINESS_PRE_VERIFIED_PHONE_NUMBER_ID>"
}

Contoh Permintaan

curl -X POST 'https://graph.facebook.com/v20.0/506914307656634/add_phone_numbers?phone_number=15550783881' \
-H 'Authorization: Bearer EAAJB...'

Contoh Tanggapan

{
  "id": "106540352242922"
}

Lihat referensi endpoint Akun Bisnis > Tambahkan Nomor Telepon untuk format nomor telepon dan parameter kueri yang didukung.

Langkah 2: Minta kode verifikasi

Gunakan endpoint Nomor Telepon WhatsApp Business yang Terverifikasi Sebelumnya > Minta Kode untuk meminta kata sandi sekali pakai melalui SMS atau pesan suara untuk nomor telepon bisnis yang terverifikasi sebelumnya yang baru dibuat.

Sintaksis Permintaan

POST /<WHATSAPP_BUSINESS_PRE_VERIFIED_PHONE_NUMBER_ID>/request_code
  ?code_method=<CODE_METHOD>
  &language=<LANGUAGE>

Tanggapan

Setelah berhasil, API akan menampilkan true.

{
  "success": <SUCCESS>
}

Selain itu, kami akan mengirimkan SMS atau pesan suara yang berisi kata sandi sekali pakai ke nomor telepon. Simpan kata sandi sekali pakai untuk digunakan di permintaan berikutnya.

Sintaksis SMS Kata Sandi Sekali Pakai

WhatsApp code <CODE>

Sintaksis Pesan Suara Kata Sandi Sekali Pakai

Diulang tiga kali.

Verification code is <CODE>

Contoh Permintaan

curl -X POST 'https://graph.facebook.com/v20.0/106540352242922/request_code?code_method=SMS&language=en_US' \
-H 'Authorization: Bearer EAAJB...'

Contoh Tanggapan

{
  "success": true
}

Contoh Pesan SMS Kata Sandi Sekali Pakai

WhatsApp code 123-456

Contoh Pesan Suara Kata Sandi Sekali Pakai

Diulang tiga kali.

Verification code is 123456

Lihat referensi endpoint Nomor Telepon WhatsApp Business yang Terverifikasi Sebelumnya > Minta Kode untuk metode kode, bahasa, dan parameter kueri yang didukung.

Langkah 3: Verifikasi Nomor

Gunakan endpoint Nomor Telepon WhatsApp Business yang Terverifikasi Sebelumnya > Verifikasikan Kode untuk memeriksa nomor telepon bisnis menggunakan kata sandi sekali pakai.

Sintaksis Permintaan

POST /<WHATSAPP_BUSINESS_PRE_VERIFIED_PHONE_NUMBER_ID>/verify_code
  ?code=<CODE>

Tanggapan

Jika berhasil, API akan menampilkan true dan nomor telepon bisnis akan mengatur code_verification_status ke VERIFIED selama 90 hari.

{
  "success": <SUCCESS>
}

Contoh Permintaan

curl -X POST 'https://graph.facebook.com/v20.0/106540352242922/verify_code?code=123456' \
-H 'Authorization: Bearer EAAJB...'

Contoh Tanggapan

{
  "success": true
}

Lihat referensi endpoint Nomor Telepon WhatsApp Business yang Terverifikasi Sebelumnya > Verifikasikan Kode untuk parameter kueri yang didukung.

Setelah Anda memiliki nomor telepon bisnis yang terverifikasi sebelumnya dengan status terverifikasi (atau satu set nomor tersebut), tampilkan nomor di alur Pendaftaran Tersemat baru.

Menampilkan nomor yang terverifikasi sebelumnya dalam Pendaftaran Tersemat

Anda dapat menampilkan nomor telepon bisnis yang terverifikasi sebelumnya dalam alur Pendaftaran Tersemat baru melalui data formulir yang telah diisi sebelumnya. Untuk melakukannya, tambahkan objek preVerifiedPhone dengan properti ids ke objek setup dan tetapkan ID nomor telepon bisnis Anda yang terverifikasi sebelumnya sebagai array string ke properti ids:

{
  scope: '<SCOPE>',
  extras: {
    feature: '<FEATURE>',
    setup: {
      preVerifiedPhone: {
        ids: [<IDS>]
      }
    }
  }
}

Contoh:

{
  scope: 'business_management,whatsapp_business_management',
  extras: {
    feature: 'whatsapp_embedded_signup',
    version: 2,
    setup: {
	business: {
	  name: 'Acme Inc.',
	  email: 'johndoe@acme.com',
	  phone: {
	    code: 1,
	    number: '6505551234'
        },
	  website: 'https://www.acme.com',
        address: {
          streetAddress1: '1 Acme Way',
          city: 'Acme Town',
          state: 'CA',
          zipPostal: '94000',
          country: 'US'
        },
        timezone: 'UTC-08:00'
      },
      phone: {
        displayName: 'Acme Inc.',
        category: 'ENTERTAIN',
        description: 'Gears and widgets'
      },
      preVerifiedPhone: {
        ids: ['106540352242922','105954558954427']
      }
    }
  }
}

Perhatikan bahwa jika nomor telepon bisnis yang terverifikasi sebelumnya dengan status VERIFIED tidak diklaim dalam waktu 90 hari sejak verifikasi, statusnya akan diatur ke UNVERIFIED, tetapi tetap akan muncul di alur Pendaftaran Tersemat baru. Jika klien akhir mencoba untuk mengeklaim nomor yang belum terverifikasi, mereka harus menyelesaikan verifikasi sendiri, yang berarti mereka harus meminta kata sandi sekali pakai dari Anda.

Untuk mencegah pengalaman pengguna yang buruk ini, kami sarankan Anda untuk melacak saat Anda memverifikasi nomor dan memverifikasi ulang nomor tersebut sebelum kembali ke status belum terverifikasi.

Jika Anda tidak yakin kapan terakhir kali Anda memverifikasi nomor telepon bisnis yang terverifikasi sebelumnya yang Anda dapatkan, lakukan kueri endpoint Nomor Telepon WhatsApp Business yang Terverifikasi Sebelumnya dan baca kolom code_verification_time serta verification_expiry_time yang menunjukkan waktu verifikasi terkini dan waktu kedaluwarsa verifikasi.

Menentukan apakah suatu nomor telah diklaim melalui Pendaftaran Tersemat

Lihat Mendapatkan ID nomor telepon yang diklaim.

Mendapatkan ID Nomor Telepon yang Diklaim

Lakukan GET pada endpoint Akun WhatsApp Business > Nomor Telepon, yang menampilkan semua Nomor Telepon WhatsApp Business pada akun WhatsApp Business.

Parse untuk properti display_phone_number di setiap objek yang ditampilkan dalam set hasil. Jika objek memiliki nomor telepon tampilan (misalnya: 16505551234) sebagai nilai display_phone_number, nomor itu telah diklaim. Salin nilai properti id objek, karena ini adalah ID untuk objek Nomor Telepon WhatsApp Business baru yang sekarang mewakili nomor ini (ID lama tidak akan berfungsi lagi).

Atau, Anda dapat menggunakan endpoint yang sama dengan perluasan field untuk meminta kolom display_phone_number dan menentukan nomor telepon tampilan. Contoh:

GET /102290129340398/phone_numbers?display_phone_number=16505551234

Jika tindakan ini menampilkan objek Nomor Telepon WhatsApp Business dengan nomor telepon tampilan itu, nomor tersebut telah diklaim dan Anda harus menyalin id objek.

Mendapatkan Nomor Telepon Bisnis Terverifikasi Sebelumnya

Gunakan endpoint Akun Bisnis > Nomor Terverifikasi Sebelumnya untuk mendapatkan daftar semua objek Nomor Telepon WhatsApp Business yang Terverifikasi Sebelumnya, terlepas dari status verifikasinya, di kelompok nomor telepon bisnis yang terverifikasi sebelumnya dari akun bisnis Anda:

GET /<BUSINESS_ACCOUNT_ID>/preverified_numbers

Hasil secara otomatis diurutkan menurut urutan waktu pembuatan. Anda juga dapat menggunakan perluasan kolom untuk meminta kolom code_verification_status agar API hanya menampilkan nomor telepon bisnis yang terverifikasi sebelumnya dengan status verifikasi yang ditunjukkan:

GET /<BUSINESS_ACCOUNT_ID>/preverified_numbers?code_verification_status=VERIFIED

Berbagi dan Batal Berbagi Nomor Terverifikasi Sebelumnya

Kirim permintaan POST ke endpoint Bisnis > Bagikan Nomor yang Telah Terverifikasi Sebelumnya untuk membagikan nomor telepon bisnis yang terverifikasi sebelumnya dengan mitra bisnis, atau permintaan HAPUS ke endpoint yang sama untuk membatalkan pembagiannya.

Nomor telepon bisnis yang terverifikasi sebelumnya yang dibagikan dapat ditampilkan dalam alur Pendaftaran Tersemat oleh mitra bisnis.

Jika Anda berbagi nomor dengan beberapa mitra bisnis, sebaiknya Anda menyarankan mitra Anda untuk mendapatkan daftar nomor yang terverifikasi sebelumnya yang dibagikan sebelum menampilkannya di Pendaftaran Tersemat. Hal ini mengurangi kemungkinan mitra mencoba menampilkan nomor yang telah diklaim (nomor yang diklaim tidak muncul dalam alur, tetapi mitra mungkin tidak mengetahui hal ini dan bertanya-tanya mengapa nomor tersebut tidak muncul).

Sintaksis Permintaan Berbagi

POST /<BUSINESS_ID>/share_preverified_numbers
  ?partner_business_id=<PARTNER_BUSINESS_ID>
  &preverified_id=<PREVERIFIED_ID>

Sintaksis Permintaan Batal Berbagi

DELETE /<BUSINESS_ID>/share_preverified_numbers
  ?partner_business_id=<PARTNER_BUSINESS_ID>
  &preverified_id=<PREVERIFIED_ID>

Tanggapan

Jika berhasil, API akan menampilkan nilai true. Jika berbagi, beri tahu mitra bisnis Anda tentang nomor terverifikasi sebelumnya yang baru saja dibagikan dan berikan ID nomor tersebut kepada mereka. Jika batal berbagi, nomor tersebut tidak akan muncul lagi dalam implementasi Pendaftaran Tersemat mitra.

{
  "success": <SUCCESS>
}

Contoh Permintaan Berbagi

curl -X POST 'https://graph.facebook.com/v17.0/share_preverified_numbers?partner_business_id=506914307656634&preverified_id=1706193509821738' \
-H 'Authorization: Bearer EAAH0...'

Contoh Permintaan Batal Berbagi

curl -X DELETE 'https://graph.facebook.com/v17.0/share_preverified_numbers?partner_business_id=506914307656634&preverified_id=1706193509821738' \
-H 'Authorization: Bearer EAAH0...'

Contoh Tanggapan

{
  "success": true
}

Mendaftarkan Nomor Terverifikasi Sebelumnya secara Terprogram

Anda dapat melewati pemilihan nomor telepon Pendaftaran Tersemat secara keseluruhan dan mendaftarkan nomor telepon bisnis yang terverifikasi sebelumnya pada Akun WhatsApp Business klien akhir yang terpasang secara terprogram. Untuk melakukannya, ikuti langkah-langkah pada dokumen Mendaftarkan Nomor Telepon, tetapi gunakan ID nomor telepon bisnis yang terverifikasi sebelumnya pada Langkah 1, lalu lompat ke Langkah 4.

Sintaksis Permintaan

Gunakan permintaan ini untuk membuat Nomor Telepon WhatsApp Business di Akun WhatsApp Business dengan menggunakan ID nomor telepon bisnis yang terverifikasi sebelumnya. Langkah ini menggantikan Langkah 1.

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/phone_numbers

Isi Postingan

{
  "preverified_id": "<PREVERIFIED_ID>",
  "country_dial_code": "<COUNTRY_DIAL_CODE>",
  "display_phone_number": "<DISPLAY_PHONE_NUMBER>",
  "verified_name": "<VERIFIED_NAME>"
}

Properti

Sintaksis Tanggapan

Jika berhasil, API akan merespons dengan ID Nomor Telepon WhatsApp Business. Gunakan ID ini untuk mendaftarkan nomor (Langkah 4 dalam dokumen Mendaftarkan Nomor Telepon).

{
  "id": "<ID>"
}

Properti Tanggapan

Contoh Permintaan

curl 'https://graph.facebook.com/v20.0/506914307656634/phone_numbers' \
-H 'Content-Type: text/plain' \
-H 'Authorization: Bearer EAAH7...' \
-d '
{
  "preverified_id": "6635066806614622",
  "country_dial_code": "1",
  "display_phone_number": "5550783881",
  "verified_name": "Lucky Shrub"
}'

Contoh Tanggapan

{
  "id": "108692048990658"
}