Mencadangkan dan Memulihkan

/v1/settings/backup dan /v1/settings/restore

Gunakan endpoint /v1/settings/backup dan /v1/settings/restore untuk memudahkan perpindahan ke lingkungan atau server yang berbeda dan memulihkan ke status kerja yang diketahui. Kami merekomendasikan agar Anda sesekali mencadangkan sehingga jika klien atau server API WhatsApp Business Anda mati, Anda dapat dengan mudah mengaktifkannya kembali.

Klien API WhatsApp Business mendukung pencadangan dan pemulihan semua informasi yang diperlukan termasuk pengaturan dan pendaftaran aplikasi.

Pembaruan Keamanan

Di v2.31.4 WhatsApp memperbaiki endpoint pencadangan dan pemulihan agar konsisten dengan model keamanan fungsi pencadangan dan pemulihan klien WhatsApp lainnya (yaitu, aplikasi telepon). Dengan perubahan ini, kode keamanan baru dibuat antara akun WhatsApp Business Anda dan kontaknya setelah operasi pemulihan berhasil.

Setelah akun WhatsApp Business pulih dari cadangan, klien pelanggan akan menerima pemberitahuan "Kode keamanan Anda dengan {Akun Bisnis} diubah. Ketuk untuk mempelajari lebih lanjut." jika mereka telah mengaktifkan pengaturan "notifikasi keamanan". Semua perilaku pencadangan/pemulihan lainnya tetap sama seperti sebelumnya.

Sebelum Memulai

Anda harus menggunakan akun admin untuk mengakses cadangan dan memulihkan pengaturan.

Mencadangkan

Kemampuan untuk mencadangkan/mengekspor hanya berjalan setelah Klien API WhatsApp Business telah terdaftar dan berjalan. Cadangan tidak akan mencadangkan pesan atau panggilan balik, dan mengambil snapshot mesin virtual dan memulihkannya tidak akan berfungsi.

Contoh

Untuk mencadangkan, gunakan endpoint /v1/settings/backup dengan kolom password.

POST /v1/settings/backup
{
    "password": "PASSWORD"
}

{
    "settings": {
       "data": "ENCRYPTED_BACKUP_DATA"
    }
}

Parameter

Parameter permintaan:

Parameter tanggapan:

Memulihkan

Pulihkan dapat digunakan untuk menyiapkan versi baru Klien API WhatsApp Business di mesin baru atau memulihkan aplikasi ke status kerja yang diketahui pada mesin yang sama dengan informasi dan pengaturan enkripsi yang sama dari penyiapan sebelumnya.

Untuk menyiapkan aplikasi di komputer baru, Coreapp harus berjalan, tetapi tidak terdaftar. Setelah impor berhasil, Coreapp secara otomatis menginisialisasi dirinya sendiri dan mulai melayani permintaan. Jika mesin memiliki aplikasi yang sudah ada dan Anda melakukan pemulihan, aplikasi akan berhenti dan Anda harus memulainya lagi dengan perintah docker restart.

Saat memulihkan penyiapan multikoneksi, Anda perlu melakukan pemulihan di atas jenis penyiapan yang sama dengan yang Anda pulihkan. Contoh: jika Anda mencadangkan penyiapan dengan dua pecahan berjalan, Anda harus menjalankan dua pecahan untuk pemulihan.

Contoh

Untuk memulihkan pengaturan, gunakan endpoint /v1/settings/restore dengan kolom password dan data.

POST /v1/settings/restore
{
    "password": "your-password",
    "data": "your-encrypted-backup-data"
}

Klien API WhatsApp Business dimatikan setelah impor. Dalam penerapan tertentu (mis., AWS) aplikasi dimulai ulang secara otomatis. Jika tidak, Anda harus memulai ulang layanan menggunakan perintah docker restart.

Permintaan yang berhasil akan memberikan Kode Status HTTP 200 OK dan antara null atau {}. Jika Anda menemui kesalahan, lihat Pesan Kesalahan dan Status.

Parameter