> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Referensi API

> URL dasar, autentikasi, pemilihan perangkat, format permintaan, dan struktur respons REST API GOWA.

## URL dasar

```text theme={null}
http://<host>:3000<APP_BASE_PATH>
```

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](https://gowa-docs.mintlify.site/id/api-reference/authentication.md).

## 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.

| Berdasarkan perangkat | Tidak berdasarkan perangkat |
| - | - |
| `/app/*` (except `/app/info` and `/app/metrics`), `/send/*`, `/message/*`, `/chat/*`, `/chats`, `/user/*`, `/group/*`, `/newsletter/*`, `/call/*` | `/devices*`, `/app/info`, `/app/metrics`, `/health`, `/mcp`, `/chatwoot/*` |

Lihat [Multiperangkat](https://gowa-docs.mintlify.site/id/concepts/multidevice.md).

## Kelompok endpoint

| Kelompok | Fungsi |
| - | - |
| Devices | Membuat, menampilkan daftar, login, logout, dan menghapus slot perangkat; webhook serta konfigurasi Chatwoot per perangkat. |
| App | Login (QR, kode penautan, passkey), logout, menyambungkan ulang, status, informasi server, serta metrik proses, memori, disk, dan perangkat. |
| Send | Teks, media, kontak, lokasi, tautan, polling, status kehadiran; penjadwalan; pengiriman interaktif langsung yang masih eksperimental. |
| Message | Memberi reaksi, mengedit, menarik, menghapus, membaca, memberi bintang, meneruskan, dan mengunduh media. |
| Chat | Menampilkan daftar chat dan pesan; menyematkan, mengarsipkan, mengatur timer pesan sementara, dan meminta riwayat. |
| User | Informasi profil, avatar, nama tampilan WhatsApp, privasi, kontak, grup, dan pemeriksaan nomor. |
| Group | Pembuatan grup, peserta, admin, permintaan bergabung, pengaturan, dan tautan undangan. |
| Newsletter | Mengikuti, berhenti mengikuti, informasi saluran, direktori, pesan, penghitung, pembaruan langsung, dan unduhan media. |
| Call | Menolak panggilan masuk. |

Halaman endpoint pada tab ini dihasilkan dari spesifikasi OpenAPI GOWA. Kontrak yang menjadi acuan adalah [`docs/openapi.yaml`](https://github.com/aldinokemal/go-whatsapp-web-multidevice/blob/main/docs/openapi.yaml) di repositori server. Situs ini menggunakan salinan tersinkronisasi dalam `openapi.yml`, termasuk `/send/interactive`. [Panduan interaktif](https://gowa-docs.mintlify.site/id/examples/interactive-messages.md) 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

```json theme={null}
{
  "code": "SUCCESS",
  "message": "Success",
  "results": {}
}
```

`code` berisi `SUCCESS` atau kode error; `results` memuat data. Lihat [Error](https://gowa-docs.mintlify.site/id/api-reference/errors.md).

## Contoh

```bash theme={null}
curl -u admin:changeme -X POST http://localhost:3000/send/message \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{"phone": "628123456789", "message": "Hello from GOWA"}'
```

## 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`.

```bash theme={null}
curl -u admin:changeme -H "X-Device-Id: my-device" \
  http://localhost:3000/user/my/contacts/detailed
```

## Antarmuka lainnya

* **[WebSocket](https://gowa-docs.mintlify.site/id/api-reference/websocket.md)** di `/ws` untuk event dasbor secara langsung.
* **MCP** di `/mcp` untuk agen AI ([Server MCP](https://gowa-docs.mintlify.site/id/integrations/mcp.md)).
* **Webhook** dikirim ke URL Anda ([Webhook](https://gowa-docs.mintlify.site/id/concepts/webhooks.md)).


## Related topics

- [Mulai Cepat](https://gowa-docs.mintlify.site/id/quickstart.md)
- [GOWA: WhatsApp REST API](https://gowa-docs.mintlify.site/id/index.md)
- [Autentikasi API](https://gowa-docs.mintlify.site/id/api-reference/authentication.md)
- [Referensi Konfigurasi](https://gowa-docs.mintlify.site/id/configuration.md)
- [Teruskan Pesan](https://gowa-docs.mintlify.site/id/api-reference/message/teruskan-pesan.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.