Dokumentasi API

Panduan lengkap untuk mengintegrasikan WhatsApp Gateway dengan aplikasi Anda

Pengenalan

WhatsApp Gateway API memungkinkan Anda untuk mengirim dan menerima pesan WhatsApp melalui aplikasi Anda. API ini menggunakan protokol REST dengan format JSON.

Base URL

https://your-domain.com/api

Format Response

Semua response API menggunakan format JSON dengan struktur berikut:

{ "success": true, "message": "Pesan berhasil dikirim", "data": { // Data response } }

Autentikasi

API menggunakan Bearer Token untuk autentikasi. Token dapat diperoleh melalui endpoint login.

Login

POST /auth/login
Parameter Type Required Deskripsi
email string Ya Email pengguna
password string Ya Password pengguna
curl -X POST https://your-domain.com/auth/login \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "password": "password123" }'

Menggunakan Token

Sertakan token dalam header Authorization untuk setiap request:

Authorization: Bearer YOUR_TOKEN_HERE

Manajemen Koneksi

Endpoint untuk mengelola koneksi WhatsApp Anda.

Membuat Koneksi

POST /connection/create
Parameter Type Required Deskripsi
name string Ya Nama koneksi
description string Tidak Deskripsi koneksi
webhook string Tidak URL webhook untuk menerima pesan

Status Koneksi

GET /connection/status/:connectionId
curl -X GET https://your-domain.com/connection/status/CONNECTION_ID \ -H "Authorization: Bearer YOUR_TOKEN"

Mengirim Pesan

Endpoint untuk mengirim berbagai jenis pesan WhatsApp.

Kirim Pesan Teks

POST /message/send
Parameter Type Required Deskripsi
connectionId string Ya ID koneksi WhatsApp
to string Ya Nomor tujuan (format: 628123456789)
message string Ya Isi pesan
curl -X POST https://your-domain.com/message/send \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_TOKEN" \ -d '{ "connectionId": "CONNECTION_ID", "to": "628123456789", "message": "Halo, ini pesan dari WhatsApp Gateway!" }'

Riwayat Pesan

GET /message/history

Parameter query yang tersedia:

  • connectionId - Filter berdasarkan koneksi
  • status - Filter berdasarkan status (success/failed)
  • page - Halaman (default: 1)
  • limit - Jumlah per halaman (default: 20)

Webhooks

Webhook memungkinkan Anda menerima notifikasi real-time ketika ada pesan masuk.

Format Webhook

Ketika ada pesan masuk, sistem akan mengirim POST request ke URL webhook Anda:

{ "connectionId": "CONNECTION_ID", "from": "628123456789", "message": "Pesan dari pengguna", "timestamp": "2024-01-01T12:00:00Z", "messageType": "text" }

Verifikasi Webhook

Pastikan endpoint webhook Anda mengembalikan status 200 untuk konfirmasi penerimaan.

Error Handling

API menggunakan kode status HTTP standar untuk menunjukkan keberhasilan atau kegagalan request.

Kode Status

Kode Status Deskripsi
200 OK Request berhasil
400 Bad Request Parameter tidak valid
401 Unauthorized Token tidak valid atau tidak ada
404 Not Found Resource tidak ditemukan
500 Internal Server Error Kesalahan server

Format Error Response

{ "success": false, "message": "Deskripsi error", "error": "Detail error (jika ada)" }