Cloud API

Platform WhatsApp Business > Cloud API > Panduan

Bermigrasi dari Cloud API ke On-Premises API

Kami akan menghentikan On-Premises API. Lihat Proses Penghentian On-Premises API dokumen untuk detailnya, dan untuk mempelajari cara bermigrasi ke Cloud API generasi berikutnya.

Dokumen ini menjelaskan cara memigrasikan nomor telepon bisnis dari Cloud API ke On-Premises API. Untuk bermigrasi dari On-Premises API ke Cloud API, lihat Bermigrasi dari On-Premises API ke Cloud API.

Perhatikan bahwa memigrasikan nomor telepon bisnis dari satu API ke API lainnya tidak sama dengan memigrasikan nomor dari satu Akun WhatsApp Business (WABA) ke WABA lainnya.

Migrasi TIDAK memengaruhi:

  • nama tampilan, status verifikasi, atau peringkat kualitas nomor telepon bisnis
  • templat yang digunakan oleh nomor telepon bisnis, atau statusnya
  • WABA pemilik, status Akun Bisnis Resminya, atau batas pengiriman pesannya

Namun, untuk mendukung migrasi, Anda harus mengetahui perbedaan API dan mengambil tindakan yang sesuai untuk mengatasinya sebelum melakukan langkah-langkah migrasi yang dijelaskan dalam dokumen ini.

Praktik Terbaik

Setelah memastikan bahwa aplikasi Anda dapat menangani semua perbedaan API, sebaiknya Anda memigrasikan nomor telepon bisnis bervolume rendah terlebih dahulu dan memverifikasi bahwa semua fungsi yang ingin Anda tawarkan dengan On-Premises API berfungsi dengan benar. Setelah memverifikasi bahwa semuanya berfungsi dengan baik, migrasikan nomor tambahan.

Kami juga menyarankan Anda melakukan migrasi ketika lalu lintas deployment On-Premises API Anda rendah.

Perbedaan API

Pastikan aplikasi Anda mampu menangani perbedaan ini sebelum memulai proses migrasi.

Webhooks

Struktur payload webhooks Cloud API dan Business Management API berbeda dari struktur payload On-Premises API. Sebaiknya Anda membuat endpoint webhook baru yang dapat menangani webhook On-Premises API secara eksklusif.

Lihat dokumen berikut untuk membantu Anda memahami perbedaan payload:

Setelah migrasi ke On-Premises API selesai, webhooks Cloud API nomor telepon bisnis tidak akan lagi dikirimkan dan pengiriman webhooks On-Premises API akan dimulai.

Media

ID Media untuk media apa pun yang diunggah ke Cloud API tidak dapat digunakan saat mengirim pesan dengan On-Premises API, jadi Anda harus mengunggah ulang media menggunakan On-Premises API untuk membuat ID media baru, atau menggunakan URL media jika media di-hosting di server publik. Lihat Mengirim Pesan Media.

Kode Kesalahan

Kode kesalahan Cloud API dan Business Management API berbeda dari kode kesalahan On-Premises API. Lihat dokumen berikut:

Pesan Push-To-Talk

On-Premises mengidentifikasi pesan push-to-talk (PTT) di webhooks dengan mengatur messages.type ke voice, tetapi Cloud API mengidentifikasi pesan PTT dengan mengatur messages.audio.voice ke true.

Waktu Henti

Waktu henti dimulai segera setelah Anda melakukan langkah pendaftaran (langkah 3) dan hanya berlangsung beberapa detik. Selama waktu ini, pesan yang dikirim ke nomor dari pengguna WhatsApp akan gagal terkirim tanpa pemberitahuan.

Kami sangat menganjurkan Anda untuk menjadwalkan migrasi pada saat nomor tersebut mempunyai aktivitas rendah, untuk meminimalkan dampak waktu henti.

Langkah 1: Integrasikan On-Premises API

Karena Anda memigrasikan nomor telepon bisnis ke API di Tempat, pastikan bahwa aplikasi Anda dapat berhasil menggunakan klien API di Tempat Anda dan bahwa Webhooks Akun WhatsApp Business yang terkait dengan nomor telepon bisnis telah dikonfigurasi dengan benar.

Langkah 2: Bersiap untuk Migrasi

Kami sarankan Anda berhenti mengirim pesan saat menyelesaikan migrasi.

Klien API di Tempat WhatsApp Business memiliki persyaratan jaringan tertentu untuk terhubung ke server WhatsApp. Untuk memastikan bahwa Anda siap, periksa Menyiapkan dan Melakukan Debug Jaringan.

Langkah 3: Daftarkan Klien API

Daftarkan nomor telepon bisnis di klien API di Tempat Anda. Untuk melakukannya, panggil endpoint /account:

POST /v1/account

{
    "cc": "COUNTRY_CODE",
    "phone_number": "PHONE_NUMBER_WITHOUT_COUNTRY_CODE",
    "method": "sms" or "voice",
    "cert": "VERIFIED_NAME_CERT_IN_BASE64",
    "pin": "EXISTING_6_DIGIT_PIN" # required if two-step verification is enabled
}

Tergantung pada tanggapan yang diterima, prosedur pendaftaran dapat dianggap selesai atau memerlukan satu langkah lagi untuk diselesaikan. Jika berhasil, Anda akan menerima salah satu kode status HTTP berikut. Ikuti petunjuk yang sesuai dengan tanggapan yang Anda terima:

  • 201 Created — Akun sudah ada. Anda sudah terdaftar, sehingga tidak perlu melakukan hal lain.
  • 202 Accepted — Akun tidak ada. Tergantung pada metode yang dipilih dalam permintaan, periksa SMS atau nomor suara Anda untuk kode pendaftaran. Tanggapan ini akan menyertakan muatan yang diberikan, berisi nama vname yang didekode dari parameter cert untuk Anda gunakan dalam mengonfirmasi nama tampilan yang ditetapkan sudah benar. Jika benar, lanjutkan ke Menyelesaikan Pendaftaran Akun Anda untuk menyelesaikan pendaftaran.

Lihat semua kolom yang tersedia untuk endpoint ini di sini.

Setelah pendaftaran selesai, klien API di Tempat akan menjadi yang menerima pesan.

Langkah 4: Atur Partisi (Shard)

Setelah klien terdaftar, Anda dapat mengatur partisi, jika perlu.

Langkah 5: Mulai Mengirim Pesan

Anda siap untuk mengirim pesan kepada pelanggan Anda. Lihat panduan Kirim Pesan untuk informasinya.