Langsung ke konten utama

URL dasar

Nilai defaultnya adalah http://localhost:3000. Dengan APP_BASE_PATH=/gowa, semua rute berada di bawah /gowa, kecuali /health.

Autentikasi

Jika APP_BASIC_AUTH diatur, semua rute memerlukan HTTP Basic Auth, kecuali /health, /statics/*, webhook Chatwoot, dan endpoint OAuth MCP. Lihat Autentikasi.

Pemilihan perangkat

Sebagian besar rute beroperasi pada satu perangkat WhatsApp. Pilih perangkat melalui header X-Device-Id (ID slot atau JID), atau parameter kueri device_id. Jika server hanya memiliki satu perangkat, parameter ini boleh dihilangkan; jika lebih dari satu, parameter ini wajib disertakan. Lihat Multiperangkat.

Kelompok endpoint

Halaman endpoint pada tab ini dihasilkan dari spesifikasi OpenAPI GOWA. Kontrak yang menjadi acuan adalah docs/openapi.yaml di repositori server. Situs ini menggunakan salinan tersinkronisasi dalam openapi.yml, termasuk /send/interactive. Panduan interaktif menjelaskan batasan yang berlaku saat ini.

Permintaan

  • Body JSON: Content-Type: application/json.
  • Unggahan file: multipart/form-data.
  • Nomor telepon: angka dengan kode negara (628123456789) atau JID lengkap (...@s.whatsapp.net, ...@g.us).

Respons

code berisi SUCCESS atau kode error; results memuat data. Lihat Error.

Contoh

Nama kontak

GET /user/my/contacts mengembalikan nama tampilan yang diutamakan untuk setiap kontak. Pada GOWA cabang main setelah v9.9.0, panggil GET /user/my/contacts/detailed untuk mendapatkan full_name, first_name, push_name, dan business_name yang tersimpan sebagai field terpisah. GOWA menghilangkan nama kosong dan menyertakan lid pada JID nomor telepon jika perangkat memiliki pemetaannya. Hasilnya berisi kontak individu dari perangkat yang dipilih, diurutkan berdasarkan jid.

Antarmuka lainnya

  • WebSocket di /ws untuk event dasbor secara langsung.
  • MCP di /mcp untuk agen AI (Server MCP).
  • Webhook dikirim ke URL Anda (Webhook).