{"info":{"_postman_id":"0bdb1c4c-e1af-4907-ab71-958d22f601a2","name":"postman-wahide","description":"

postman-wahide API Collection

Koleksi ini merupakan dokumentasi lengkap seluruh endpoint REST API untuk platform postman-wahide — sebuah platform WhatsApp Gateway & Business Messaging yang mencakup manajemen pengguna, pengiriman pesan WhatsApp, kampanye broadcast, manajemen kontak, keuangan, konten, notifikasi, dan layanan pendukung lainnya.

🔧 Variabel Koleksi

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variabel	Deskripsi
	Base URL server API (contoh: `https://api.example.com`)
	Secret key untuk autentikasi endpoint cronjob (dikirim via header `X-Cron-Secret`)

🔐 Autentikasi

Sebagian besar endpoint memerlukan autentikasi. Gunakan salah satu metode berikut:

Bearer Token (JWT): Diperoleh setelah login via POST /api/v1/auth/login. Sertakan di header: Authorization: Bearer
\n
API Key: Diperoleh via POST /api/v1/auth/token. Sertakan di header: Authorization: Bearer
\n
Cron Secret: Khusus endpoint cronjob, sertakan header X-Cron-Secret:
\n

Endpoint publik (health check, login, register, public plans, public posts, public settings) tidak memerlukan autentikasi.

📁 Struktur Modul

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Folder	Deskripsi
`00-health`	Health check & readiness probe untuk monitoring dan Kubernetes
`01-iam`	Identity & Access Management: autentikasi, manajemen pengguna, agen, dan alamat
`02-subscription`	Manajemen paket langganan dan plan untuk tenant
`03-whatsapp`	Manajemen perangkat WhatsApp dan pengiriman pesan
`04-campaign`	Pembuatan dan pengelolaan kampanye broadcast WhatsApp
`05-contact`	Manajemen kontak dan tag audiens
`06-finance`	Keuangan: billing, invoice, voucher, webhook pembayaran, dan laporan
`07-content`	Manajemen konten: artikel/post, pengaturan publik, dan penyimpanan file
`08-support`	Sistem tiket dukungan pelanggan
`09-notification`	Sistem notifikasi dan broadcast ke pengguna
`10-cronjob`	Endpoint scheduled job untuk pemeliharaan sistem otomatis

🚀 Cara Memulai

Set variabel sesuai environment (development/staging/production).
\n
Lakukan login via POST /api/v1/auth/login untuk mendapatkan token JWT.
\n
Set token JWT ke variabel environment atau gunakan langsung di header Authorization.
\n
Untuk endpoint cronjob, pastikan sudah diset dengan nilai yang benar.
\n

📌 Catatan Umum

Semua request dan response menggunakan format JSON (Content-Type: application/json), kecuali upload file.
\n
Pagination menggunakan query parameter page dan page_size.
\n
Path parameter dinamis ditandai dengan huruf kapital, contoh: USER_ID, DEVICE_ID, TICKET_ID.
\n
Endpoint admin hanya dapat diakses oleh pengguna dengan role admin atau superadmin.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"postman-wahide API Collection","slug":"postman-wahide-api-collection"}],"owner":"26294023","collectionId":"0bdb1c4c-e1af-4907-ab71-958d22f601a2","publishedId":"2sBYAuSqz3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-30T08:52:32.000Z"},"item":[{"name":"03-whatsapp","item":[{"name":"devices","item":[{"name":"list-tenant-devices","id":"fde6ab49-0d03-480b-a1ea-ccd966d9681b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/v1/wa/devices","urlObject":{"path":["api","v1","wa","devices"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"fde6ab49-0d03-480b-a1ea-ccd966d9681b"},{"name":"create-device-slot","id":"20b8831f-59dd-4f3b-b143-1e2d865fad78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"push_name\": \"Wahide Customer Service 1\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/wa/devices","urlObject":{"path":["api","v1","wa","devices"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"20b8831f-59dd-4f3b-b143-1e2d865fad78"},{"name":"pair-device-qr-code","id":"f5903a4d-aff7-4464-a6c5-7c804d2e96cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/api/v1/wa/devices/DEVICE_ID/pair","urlObject":{"path":["api","v1","wa","devices","DEVICE_ID","pair"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f5903a4d-aff7-4464-a6c5-7c804d2e96cc"},{"name":"disconnect-device","id":"6228227a-5019-4b1c-b9d5-84dba090b938","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/api/v1/wa/devices/DEVICE_ID/disconnect","urlObject":{"path":["api","v1","wa","devices","DEVICE_ID","disconnect"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6228227a-5019-4b1c-b9d5-84dba090b938"},{"name":"delete-device-slot","id":"cff81336-ffed-4a91-b15f-0211c01de6e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/api/v1/wa/devices/DEVICE_ID","urlObject":{"path":["api","v1","wa","devices","DEVICE_ID"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"cff81336-ffed-4a91-b15f-0211c01de6e8"}],"id":"55e14f38-e9da-4ce4-acd5-c87deda9c23d","description":"

devices

Sub-folder ini mengelola slot perangkat WhatsApp yang terhubung ke platform. Setiap perangkat merepresentasikan satu nomor WhatsApp yang dapat digunakan untuk mengirim dan menerima pesan.

📋 Daftar Endpoint

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path	Fungsi
`POST`	`/api/v1/wa/devices`	Create Device Slot — Membuat slot perangkat WhatsApp baru (belum terhubung ke nomor).
`GET`	`/api/v1/wa/devices`	List Tenant Devices — Menampilkan daftar semua perangkat WhatsApp milik tenant beserta status koneksinya.
`POST`	`/api/v1/wa/devices/{DEVICE_ID}/pair`	Pair Device via QR Code — Memulai proses pairing perangkat dengan mengembalikan QR Code yang harus dipindai di aplikasi WhatsApp.
`POST`	`/api/v1/wa/devices/{DEVICE_ID}/disconnect`	Disconnect Device — Memutuskan koneksi perangkat WhatsApp dari platform.
`DELETE`	`/api/v1/wa/devices/{DEVICE_ID}`	Delete Device Slot — Menghapus slot perangkat secara permanen.

🔐 Autentikasi

Semua endpoint memerlukan Bearer Token (JWT atau API Key) di header Authorization.

📌 Catatan

Ganti DEVICE_ID pada path dengan ID perangkat yang valid.
Alur pairing: buat slot → panggil endpoint pair → pindai QR Code di WhatsApp → perangkat terhubung.
Jumlah slot perangkat yang dapat dibuat dibatasi oleh paket langganan aktif tenant.
Status perangkat dapat berupa: CONNECTED, DISCONNECTED, PAIRING, BANNED.

\n","_postman_id":"55e14f38-e9da-4ce4-acd5-c87deda9c23d"},{"name":"messages","item":[{"name":"send-instant-text-message","id":"01ebfee7-43de-4445-8827-9970e719baf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"device_id\": \"DEVICE_ID\",\n \"phone\": \"6281234567890\",\n \"message\": \"Halo! Ini adalah pesan verifikasi dari Wahide Gateway.\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/wa/messages/send","urlObject":{"path":["api","v1","wa","messages","send"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"01ebfee7-43de-4445-8827-9970e719baf2"},{"name":"send-media-message","id":"59bcb786-c697-4262-a4e2-c1a73ed11d11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"device_id\": \"DEVICE_ID\",\n \"phone\": \"6281234567890\",\n \"message\": \"Berikut adalah invoice langganan Anda.\",\n \"media_url\": \"https://pub-r2.wahide.com/media/invoice_1001.pdf\",\n \"file_name\": \"invoice_1001.pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/wa/messages/send","urlObject":{"path":["api","v1","wa","messages","send"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"59bcb786-c697-4262-a4e2-c1a73ed11d11"},{"name":"meta-cloud-api-compatible-send","id":"327aa387-9124-4f1f-b698-d7295ac86298","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"messaging_product\": \"whatsapp\",\n \"recipient_type\": \"individual\",\n \"to\": \"6281234567890\",\n \"type\": \"text\",\n \"text\": {\n \"preview_url\": false,\n \"body\": \"Pesan kompatibel dengan format Meta WhatsApp Cloud API\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/v18.0/DEVICE_ID/messages","urlObject":{"path":["api","v1","v18.0","DEVICE_ID","messages"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"327aa387-9124-4f1f-b698-d7295ac86298"}],"id":"12a2bef7-45fe-4d04-85fa-8db165b5864c","description":"

messages

Sub-folder ini mengelola pengiriman pesan WhatsApp secara langsung (instant messaging). Mendukung pengiriman pesan teks, pesan media (gambar, dokumen, audio, video), serta kompatibel dengan format Meta Cloud API.

📋 Daftar Endpoint

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path	Fungsi
`POST`	`/api/v1/wa/messages/send`	Send Instant Text Message — Mengirim pesan teks WhatsApp secara langsung ke nomor tujuan menggunakan perangkat yang terhubung.
`POST`	`/api/v1/v18.0/{DEVICE_ID}/messages`	Meta Cloud API Compatible Send — Mengirim pesan dengan format request yang kompatibel dengan Meta Cloud API WhatsApp Business (v18.0).
`POST`	`/api/v1/wa/messages/send`	Send Media Message — Mengirim pesan media (gambar, dokumen, audio, video) ke nomor tujuan.

🔐 Autentikasi

Semua endpoint memerlukan Bearer Token (JWT atau API Key) di header Authorization.

📌 Catatan

Ganti DEVICE_ID pada path endpoint Meta Cloud API dengan ID perangkat yang valid.
Perangkat yang digunakan untuk mengirim pesan harus dalam status CONNECTED.
Endpoint Meta Cloud API Compatible dirancang untuk memudahkan migrasi dari Meta Cloud API — format request dan response mengikuti standar Meta.
Nomor tujuan harus dalam format internasional tanpa tanda + (contoh: 628123456789).

\n","_postman_id":"12a2bef7-45fe-4d04-85fa-8db165b5864c"}],"id":"64bdddbc-7492-4f01-aa23-eebd3f4ebc93","description":"

03-whatsapp

Modul WhatsApp Gateway mengelola perangkat WhatsApp yang terhubung ke platform dan pengiriman pesan WhatsApp secara langsung (instant messaging). Modul ini mendukung pairing perangkat via QR Code, manajemen slot perangkat, serta pengiriman pesan teks dan media.

📁 Sub-folder

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Sub-folder	Deskripsi
`devices`	Manajemen slot perangkat WhatsApp: buat, list, pair via QR, disconnect, dan hapus
`messages`	Pengiriman pesan WhatsApp: teks, media, dan kompatibel dengan Meta Cloud API

🔐 Autentikasi

Semua endpoint di modul ini memerlukan Bearer Token (JWT atau API Key) di header Authorization.

📌 Catatan

Setiap tenant memiliki kuota slot perangkat sesuai paket langganan aktif.
Proses pairing perangkat dilakukan dengan memindai QR Code yang dikembalikan oleh endpoint pair-device-qr-code.
Endpoint meta-cloud-api-compatible-send dirancang kompatibel dengan format request Meta Cloud API WhatsApp Business, memudahkan migrasi dari Meta Cloud API.

\n","_postman_id":"64bdddbc-7492-4f01-aa23-eebd3f4ebc93"},{"name":"04-campaign","item":[{"name":"list-campaigns","id":"f486c814-7141-4cf6-8f63-092cd63638f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/v1/campaigns?page=1&page_size=20","urlObject":{"path":["api","v1","campaigns"],"host":[""],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"20"}],"variable":[]}},"response":[],"_postman_id":"f486c814-7141-4cf6-8f63-092cd63638f1"},{"name":"create-broadcast-campaign","id":"4d2e0813-fd09-49ca-a367-c8eaa866fabc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"device_id\": \"DEVICE_ID\",\n \"tag_id\": \"TAG_ID\",\n \"name\": \"Flash Sale Akhir Bulan\",\n \"message\": \"Halo {name}, dapatkan diskon 50% untuk langganan Wahide hari ini! Gunakan voucher: {voucher_code}\",\n \"media_url\": \"https://pub-r2.wahide.com/promo.jpg\",\n \"min_delay\": 5,\n \"max_delay\": 15\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1/campaigns","urlObject":{"path":["api","v1","campaigns"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4d2e0813-fd09-49ca-a367-c8eaa866fabc"},{"name":"start-campaign-dispatch","id":"f54cc658-5fe1-41b1-a2c1-8ee565421ba0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/api/v1/campaigns/CAMPAIGN_ID/start","urlObject":{"path":["api","v1","campaigns","CAMPAIGN_ID","start"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f54cc658-5fe1-41b1-a2c1-8ee565421ba0"},{"name":"list-message-audit-logs","id":"b6305174-1178-45f6-b8f4-4434feeabdd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/v1/campaigns/logs?page=1&page_size=50&status=SENT","urlObject":{"path":["api","v1","campaigns","logs"],"host":[""],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"50"},{"key":"status","value":"SENT"}],"variable":[]}},"response":[],"_postman_id":"b6305174-1178-45f6-b8f4-4434feeabdd4"}],"id":"8ecfca6e-10ff-4c08-836c-c980a64555d4","description":"

04-campaign

Modul Campaign mengelola kampanye broadcast WhatsApp — memungkinkan tenant untuk membuat kampanye pesan massal, mengirimkannya ke daftar kontak, memantau status pengiriman, dan melihat log audit pesan.

📋 Daftar Endpoint

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path	Fungsi
`POST`	`/api/v1/campaigns`	Create Broadcast Campaign — Membuat kampanye broadcast baru dengan template pesan dan daftar target penerima.
`GET`	`/api/v1/campaigns?page=1&page_size=20`	List Campaigns — Menampilkan daftar semua kampanye milik tenant dengan pagination.
`GET`	`/api/v1/campaigns/logs?page=1&page_size=50&status=SENT`	List Message Audit Logs — Menampilkan log audit pengiriman pesan kampanye, dapat difilter berdasarkan status (`SENT`, `FAILED`, `PENDING`, dsb).
`POST`	`/api/v1/campaigns/{CAMPAIGN_ID}/start`	Start Campaign Dispatch — Memulai proses pengiriman pesan untuk kampanye yang sudah dibuat.

🔐 Autentikasi

Semua endpoint memerlukan Bearer Token (JWT atau API Key) di header Authorization.

📌 Catatan

Kampanye harus dibuat terlebih dahulu sebelum dapat di-dispatch.
Ganti CAMPAIGN_ID pada path dengan ID kampanye yang valid.
Filter log berdasarkan status: SENT, FAILED, PENDING, QUEUED.
Kuota pengiriman pesan bergantung pada paket langganan aktif tenant.

\n","_postman_id":"8ecfca6e-10ff-4c08-836c-c980a64555d4"}],"variable":[{"key":"baseUrl","value":""},{"key":"cronSecret","value":""}]}