Dukungan

Dokumentasi API SMS Gateway

REST API sederhana berbasis HTTP untuk kirim SMS single & bulk, cek status delivery, kelola node/SIM, dan menerima webhook — siap dipanggil dari bahasa pemrograman apa pun.

Otentikasi & Base URL

Semua endpoint API memakai header X-API-Key. Kunci API dibuat otomatis untuk setiap tenant dan bisa dilihat di dashboard — simpan seperti layaknya password, jangan pernah menaruhnya di kode sisi klien yang publik. Ganti <BASE_URL_API> pada contoh di halaman ini dengan base URL API yang tertera di dashboard akun Anda.

Header

X-API-Key: <API_KEY_ANDA>

Kirim SMS — Single

Endpoint utama: POST /api/v1/sms/send dengan Content-Type application/json. Prioritas HIGH untuk OTP/transaksional (didahulukan), LOW untuk campaign/promosi.

curl — single

curl -X POST https://<BASE_URL_API>/api/v1/sms/send \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <API_KEY_ANDA>" \
  -d '{
    "destination_number": "0812987654321",
    "message": "{Halo|Hai|Selamat Pagi} {Bos|Gan}, pesan Anda sudah siap.",
    "priority": "HIGH"
  }'

Kirim SMS — Bulk / Massal

Untuk blast massal, kirim array messages dalam satu request. Setiap pesan tetap diproses individual: spintax dimutasi berbeda per nomor, nomor masuk blacklist otomatis ditolak, dan antrean dikirim bertahap dengan pacing aman per SIM.

curl — bulk

curl -X POST https://<BASE_URL_API>/api/v1/sms/send \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <API_KEY_ANDA>" \
  -d '{
    "priority": "LOW",
    "messages": [
      { "destination_number": "0812987654321", "message": "Promo hari ini" },
      { "destination_number": "085712345678", "message": "Diskon 50% khusus Anda" }
    ]
  }'

Cek Status Pesan

GET /api/v1/sms/status/:id mengembalikan status antrean (PENDING/QUEUED/SENT/FAILED) dan status delivery report (dr_status) dari operator hingga delivered.

curl — status

curl -H "X-API-Key: <API_KEY_ANDA>" \
  https://<BASE_URL_API>/api/v1/sms/status/<message_id>

Referensi Endpoint Lain

  • GET /api/v1/nodes — daftar node (HP Android) beserta telemetri baterai & status online.
  • GET /api/v1/nodes/:id — detail satu node dan SIM terpasang.
  • GET /api/v1/sims — daftar SIM: operator, kuota harian, sisa pulsa.
  • POST /api/v1/sims/:id/check-balance — trigger cek pulsa USSD untuk SIM.
  • POST /api/v1/blacklists — tambah nomor ke blacklist (unsubscribe).
  • DELETE /api/v1/blacklists/:phone — hapus nomor dari blacklist.

Webhook SMS Masuk

SMS yang diterima SIM node Anda diforward ke webhook URL yang Anda set di pengaturan tenant. Pengiriman webhook di-retry hingga 3x dengan backoff bila endpoint Anda sedang tidak tersedia — pastikan endpoint membalas 2xx dengan cepat.

Spintax & Personalisasi

Template pesan mendukung spintax nested: {Halo|Hai|Selamat Pagi} dipilih acak berbeda untuk setiap penerima. Pada campaign dashboard, kolom tambahan kontak (nama, kota, dst.) otomatis menjadi variabel {nama}, {kota} untuk personalisasi massal — placeholder tanpa nilai akan dibuang sehingga teks {nama} mentah tidak pernah terkirim.

Catatan Penting

  • Nomor tujuan dalam blacklist otomatis ditolak (HTTP 403) — gunakan ini untuk menghormati permintaan berhenti berlangganan.
  • Pacing per SIM dibatasi dan diberi jitter agar nomor Anda tetap sehat — jangan mengharapkan burst ribuan SMS per menit dari satu SIM.
  • SMS gagal kirim otomatis di-retry hingga 3x ke node/SIM lain sebelum status FAILED, lalu biaya layanannya di-refund penuh ke wallet.

Untuk Apa Saja API SMS Gateway Ini Dipakai

Endpoint di halaman ini menjadi fondasi berbagai kebutuhan bisnis: kirim OTP login dan verifikasi transaksi dengan prioritas HIGH, notifikasi pesanan dan status pengiriman untuk e-commerce, reminder jadwal untuk klinik dan sekolah, pengingat tagihan untuk lembaga keuangan, hingga blast campaign marketing ke ribuan kontak pelanggan via request bulk.

Karena arsitekturnya HTTP biasa dengan autentikasi header X-API-Key, tidak ada SDK khusus yang wajib dipasang. Backend PHP, Node.js, Python, Go, maupun script Google Apps Script memanggil endpoint yang persis sama — yang berbeda hanya cara bahasa tersebut membuat HTTP request.

Praktik Terbaik Integrasi dari Pengalaman Pengguna Kami

Simpan API key di sisi server — jangan pernah menaruhnya di kode frontend, aplikasi mobile, atau spreadsheet yang dibagikan publicly. Bila kunci bocor, segera lakukan rotasi dari dashboard agar kiriman tidak disalahgunakan pihak lain.

Untuk trafik OTP, selalu gunakan priority HIGH dan simpan message_id dari response untuk pelacakan; untuk campaign promosi gunakan LOW agar tidak mengganggu antrean transaksional. Terapkan retry di sisi aplikasi Anda hanya untuk kegagalan level HTTP (timeout, 5xx) — kegagalan pengiriman level operator sudah ditangani otomatis oleh sistem retry 3x kami.

  • Simpan API key hanya di server/backend, lakukan rotasi bila dicurigai bocor.
  • OTP dan notifikasi transaksional: priority HIGH. Campaign promo: LOW.
  • Catat message_id setiap kiriman untuk rekonsiliasi status dan audit.
  • Balas webhook dengan 2xx cepat — sistem me-retry hingga 3x dengan backoff.
  • Uji integrasi dengan volume kecil dulu sebelum go-live penuh.

Monitoring Kiriman dan Kesehatan Node

Endpoint nodes dan sims memberi Anda jendela monitoring tanpa harus membuka dashboard: status online tiap perangkat, telemetri baterai, sisa pulsa, sampai trigger cek pulsa USSD langsung dari sistem Anda. Banyak pengguna mengintegrasikan endpoint ini ke panel internal mereka agar tim ops tahu kapan harus mengisi pulsa atau mengecek perangkat.

Kombinasikan dengan polling status per message_id atau webhook push untuk membangun alur lengkap: kirim → pantau → tindak lanjuti. Pola ini membuat platform SMS gateway BYOD kami setara dengan provider cloud dalam hal observabilitas, namun dengan biaya per pesan yang jauh lebih rendah.