Panduan Penggunaan MaxChat API
Diunggah oleh
Sibghatullah MujaddidPanduan Penggunaan MaxChat API
Diunggah oleh
Sibghatullah MujaddidSelamat pagi,
Terima kasih sudah tertarik dengan platform MaxChat. Ada beberapa hal yang perlu
diperhatikan dalam penggunaan layanan MaxChat API, antara lain:
I. KEAMANAN
1. Untuk keamanan akun MaxChat, setelah login, mohon untuk
segera UPDATE PASSWORD dengan menekan tombol kunci sebelah
kanan User Id.
2. Mohon tidak menggunakan akun WhatsApp pribadi. Sangat disarankan
untuk menggunakan akun berbeda dengan yang digunakansehari-hari.
3. Data WhatsApp anda sepenuhnya ada di tangan anda. MaxChat API tetap
membutuhkan device aktif yang perlu di-pairing terlebih dahulu seperti
WhatsApp web.
II. PENGIRIMAN PESAN
1. Gunakanlah API secara wajar dan sangat tidak disarankan untuk
spamming, atau mengirim ke nomor-nomor tidak dikenal. Karena ada
kemungkinan user akan melaporkan sebagai spam, dan WhatsApp akan
memblokir nomor pengirim di kemudian hari.
2. Jika memang harus digunakan untuk broadcast, gunakanlah sewajarnya
dan beri jeda dari satu broadcast ke broadcast berikutnya. Dan usahakan
tidak mengirimkan ke terlalu banyak nomor dalam sekali broadcast.
3. Untuk pengiriman ke nomor yang tidak ada di daftar kontak, lebih baik
gunakanlah push API: api/messages/push. Proses lebih lama untuk
memastikan bahwa nomor tujuan terdaftar, dan kemudian pesan akan
dikirimkan.
III. AKSES DOKUMENTASI API via Swagger
Untuk Authorization gunakan Token yang ada di Admin Panel MaxChat, tambahkan Value
dengan awalan Bearer kemudian kode Token yang ada di Admin Panel MaxChat.
Contoh : Bearer IjkHJH8jkhJKhIHoHiIOH89d
IV. KONEKTIVITAS
1. Jika API akan digunakan 24 jam, disarankan mengganti device smartphone
dengan emulator yang diinstal WhatsApp.
2. Lebih baik kontak disimpan terlebih dahulu, bisa di handphone atau melalui
google contact, untuk mempercepat proses deteksi kontak dan pengiriman
pesan.
3. Untuk layanan saat ini hanya berupa API saja, tidak berbentuk aplikasi.
Untuk menguji coba, bisa mengirimkan pesan melalui menu TEST di admin
panel.
4. Jika ada gangguan misalkan pesan tidak terkirim, bisa merestart instance
melalui menu 'WhatsApp Session' dengan icon mata.
5. Jangan menggunakan WhatsApp Web, karena API akan otomatis non aktif
karena tidak bisa mengakses melalui WhatsApp Web.
V. CONTOH
1. File 'MaxChat.postman_collection.json'
Dokumentasi API yang bisa dibuka dengan
Postman, [Link]
2. File 'sample_send.php'
Contoh pengiriman pesan baik ke nomor yang ada di kontak maupun tidak
ada (metode push)
3. File 'sample_webhook.php'
Contoh webhook sederhana, berupa chatbot yang membalas pesan user
dengan pesan yang sama
4. File '[Link]'
Fungi-fungsi pembantu untuk menangkap data dari webhook dan
mengirimkan pesan, digunakan oleh ke-dua contoh di atas
5. Update global variabel
Untuk menggunakan contoh, update global
variabel $GLOBALS["API_URL"] dan $GLOBALS["TOKEN"] pada file
[Link], sesuai yang ada di admin panel
[Link]
1. Untuk penggunaan webhook, aktifkan dan set url di admin panel terlebih
dahulu.
2. MaxChat akan mengirimkan message (POST) ke url webhook ketika:
oAda message baru yang diterima oleh WhatsApp
oPerubahan status message, dari sent -> delivered -> read
3. Payload webhook yg dikirimkan ke url webhook memilikistruktur/field
berikut:
otime: waktu dg tipe data integer
otype: jenis data yg dikirim, yaitu: 'message'
oevent: jenis event data, yaitu:
'new': ketika ada message baru
'change:status': ketika ada perubahan status message
odata: message yang diterima/terupdate
Jika ada kesulitan atau kendala dalam penggunaan, bisa menghubungi email
ini atau menghubungi no WA 0897 0516 650. Selamat mencoba dan semoga
sukses! :)