WHAPI
  • Apa itu Whatsapp API Gateway ?
  • Persiapan Instalasi WHAPI
    • Cara Install WHAPI
    • Setting file .env
    • Menjalankan aplikasi WHAPI
  • Mulai Aplikasi WHAPI
    • Mengisi License Aplikasi
    • Isi Biodata Diri
    • Masuk ke Aplikasi WHAPI
    • Mengenal Dashboard Aplikasi
    • Menambah dan Mengelola Perangkat
    • Menghubungkan Perangkat
    • Mengganti Perangkat & API Key
    • Notifikasi Webhook
    • Mengatur Notifikasi Telegram
    • Mengenal File Media
    • Log sistem aplikasi
    • Mengirim pesan ke grup
    • Broadcast pesan dengan Aplikasi
    • Maintenance dan update
    • Lupa Password Aplikasi
    • Uninstall & Refresh Lisensi
    • Custom homepage & routes login
    • Reboot device otomatis
    • Transfer device antar aplikasi
    • Menggunakan proxy pada aplikasi
    • Auto reply chatbot
    • Mengenal Ngrok
  • Penggunaan Webhook
    • Webhook status koneksi perangkat
    • Webhook pesan, dan status pesan
    • Webhook media, dan story
    • Webhook grup
  • Baileys VS whatsapp-web.js
  • Installasi WHAPI di Linux Ubuntu
  • Installasi WHAPI di Windows Server
  • Q&A
  • Dokumentasi API
  • WHAPI
  • Whatsapp Api
Powered by GitBook
On this page
  • Ready
  • Change State
  • Disconnected
  1. Penggunaan Webhook

Webhook status koneksi perangkat

Webhook ini berfungsi untuk mengirimkan status koneksi perangkat yang terhubung ke aplikasi. Ada 3 kategori webhook yang akan dikirim :

  • ready

  • change_state

  • disconnected

Ready

Event webhook dengan type ready artinya perangkat berhasil terhubung ke aplikasi dan siap digunakan mengkonsumsi API whatsapp.

{
  "type": "ready", // Tipe webhook yang dikirim
  "results": { // Kumpulan object dari event ready
    "apiKey": "xxxxx", // API Key yang mewakili device
    "message": "Device connected successfully" // Pesan koneksi berhasil
  }
}

Change State

Event webhook dengan type change_state akan dikirim ketika ada perubahan status koneksi pada aplikasi/device.

{
  "type": "change_state", // Tipe webhook yang dikirim
  "results": { // Kumpulan object dari event change_state
    "apiKey": "xxxxx", // API Key yang mewakili device
    "state": "SERVICE_SCAN" // Status perubahan koneksi
  }
}

Pada object state ada beberapa nilai :

State
Keterangan

SERVICE_SCAN

Aplikasi menunggu perangkat untuk di scan, buka aplikasi whatsapp pada perangkat hp/emulator Anda. Scan qrcode pada aplikasi.

SERVICE_OFF

Layanan mati

PAIRING

Perangkat sedang mencoba terhubung ke aplikasi

CONNECTED

Perangkat berhasil terhubung ke aplikasi

Disconnected

Event webhook dengan type disconnected akan dikirim ketika aplikasi dan perangkat terputus.

{
  "type": "disconnected", // Tipe webhook yang dikirim
  "results": { // Kumpulan object dari event disconnected
    "apiKey": "xxxxx", // API Key yang mewakili device
    "state": "SERVICE_OFF", // Status perubahan koneksi
    "reason": "connection_logout", // Penyebab perangkat terputus dengan aplikasi
    "reconnect": false // Boolean apakah aplikasi bisa reconnect lagi / tidak
  }
}

Pada object reason ada beberapa nilai :

Reason
Keterangan

bad_session

Sesi whatsapp telah kadaluarsa atau tidak valid

connection_closed

Koneksi ke whatsapp ke web tertutup

connection_lost

Koneksi whatsapp web hilang

connection_conflict

Koneksi aplikasi diganti

connection_logout

Koneksi ke whatsapp web logout, harus scan ulang

not_multidevice

Aplikasi whatsapp tidak mendukung multidevice

connection_reconnect

Whatsapp web sedang mencoba menghubungkan ulang

connection_timedout

Koneksi berakhir

connection_banned

Perangkat / no whatsapp dibanned

onnection_banned_temp

Whatsapp web sedang dibanned sementara

Untuk object reconnect, jika nilainya true, ketika Anda Service Start, akan langsung terhubung/connected, sebaliknya, jika false, Anda wajib scan ulang perangkat.

PreviousPenggunaan WebhookNextWebhook pesan, dan status pesan

Last updated 1 year ago