NgirimWA Docs
API

Kelola Perangkat

Cek status, hubungkan via QR, dan putuskan koneksi device WhatsApp via API.

Tiga endpoint untuk mengelola koneksi WhatsApp device terkait API Key Anda. Device ID otomatis terbaca dari API Key โ€” Anda tidak perlu mengirim device_id.

Base URL

https://dash.ngirimwa.com/api/v1

Headers (semua endpoint)

x-api-key: API_KEY_ANDA

Cek Status Perangkat

Periksa apakah device WhatsApp Anda terhubung. Selalu cek status sebelum kirim untuk menghindari error "Device not connected".

Endpoint

GET /devices/status

Respon Sukses

{
  "success": true,
  "message": "Device status",
  "data": {
    "status": "connected",
    "user": {
      "id": "628123456789:1@s.whatsapp.net"
    }
  }
}

Nilai status

StatusArti
connectedโœ… Siap mengirim
connecting๐Ÿ”„ Sedang scan/handshake โ€” tunggu beberapa detik
disconnectedโŒ Belum scan QR atau koneksi putus

cURL

curl -X GET https://dash.ngirimwa.com/api/v1/devices/status \
  -H "x-api-key: API_KEY_ANDA"

Hubungkan Perangkat (Dapatkan QR Code)

Hasilkan QR code untuk login WhatsApp. Endpoint ini menunggu sampai QR siap (timeout 30 detik) lalu mengembalikan base64 PNG.

Endpoint

POST /devices/connect

Respon Sukses

{
  "success": true,
  "message": "QR Code generated",
  "data": {
    "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
  }
}

Render qr_code di frontend Anda. User scan dari WhatsApp ponsel mereka. Setelah scan, status berubah ke connected dan QR tidak berlaku lagi.

cURL

curl -X POST https://dash.ngirimwa.com/api/v1/devices/connect \
  -H "x-api-key: API_KEY_ANDA"

Catatan: Lebih praktis, hubungkan device langsung dari Dashboard โ†’ Perangkat โ†’ Semua Perangkat. Endpoint ini berguna bila Anda mengintegrasikan onboarding di aplikasi Anda sendiri.


Putuskan Perangkat

Logout WhatsApp dari NgirimWA. Session di server dihapus; semua API call setelah ini akan gagal dengan Device not connected sampai device dihubungkan ulang.

Endpoint

DELETE /devices/disconnect

Respon Sukses

{
  "success": true,
  "message": "Device disconnected successfully"
}

cURL

curl -X DELETE https://dash.ngirimwa.com/api/v1/devices/disconnect \
  -H "x-api-key: API_KEY_ANDA"

Hati-hati: Pemutusan ini bersifat permanen sampai login ulang via QR. Tidak ada konfirmasi atau undo.

On this page