Langsung ke konten

API & Webhook

API dan webhook dialer: siap produksi, bukan sekadar slide roadmap.

25+ endpoint REST, webhook real-time, autentikasi JWT, dan dokumentasi interaktif. Setiap fitur yang Anda gunakan di UI tersedia melalui API.

Uji coba gratis 14 hari · kredit AI gratis untuk mencoba agen suara AI · tanpa kartu

Dibangun oleh BroadNet — 22 tahun di industri telekomunikasi 11 bahasa, memahami dialek BYOC — carrier Anda, tanpa keterikatan Mendukung kepatuhan (TCPA, GDPR, TDRA)

Jawaban singkat

Apa itu DialerBee API? DialerBee menyediakan REST API siap produksi dengan 25+ endpoint yang mencakup kampanye, kontak, panggilan, agen, kepatuhan, rekaman, laporan, dan webhook. Autentikasi menggunakan token bearer JWT dengan masa berlaku 24 jam. API mendukung paginasi berbasis kursor, mengembalikan respons error RFC 7807, dan menerapkan batas 2,000 permintaan/menit per tenant. Webhook real-time mengirimkan event (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked, dll.) dengan verifikasi tanda tangan HMAC-SHA256 dan percobaan ulang dengan exponential backoff. Dokumentasi API interaktif tersedia di app.dialerbee.com/admin/api-docs.html.

Masalah

Sebagian besar API dialer hanya dibuat belakangan

Anda membeli dialer untuk melakukan panggilan. Kini Anda perlu mengintegrasikannya dengan CRM, mengirim data ke data warehouse, memicu alur kerja dari event panggilan, dan membangun dashboard kustom. Anda membuka dokumentasi API vendor dan menemukan... PDF dari tahun 2019 dengan 6 endpoint tanpa dokumentasi, tanpa webhook, dan antarmuka SOAP.

Inilah kenyataan bagi sebagian besar tim outbound. Dialer berfungsi baik untuk melakukan panggilan, tetapi begitu Anda perlu membangun sesuatu di atasnya — menyinkronkan disposisi ke Salesforce, membuat tiket otomatis di Zendesk, mengirim analitik ke tool BI, atau membangun antarmuka agen kustom — Anda terjebak dengan ekspor CSV dan proses manual.

DialerBee dibangun dengan pendekatan API-first. Setiap fitur di UI didukung oleh REST API yang sama yang dapat Anda panggil dari sistem Anda sendiri. API ini bukan tambahan — API adalah fondasi tempat seluruh platform berjalan.

6
Endpoint vendor pada umumnya
tanpa dokumentasi, tanpa webhook
SOAP
Protokol lama
banyak dialer masih memakai XML/SOAP
CSV
Integrasi hanya lewat ekspor
transfer file manual, tidak real-time

Cara Kerjanya

API-first sejak dirancang

API DialerBee mengikuti konvensi REST dengan payload JSON, metode HTTP standar, dan respons error RFC 7807. Autentikasi menggunakan token bearer JWT yang diperoleh melalui endpoint login, dengan masa berlaku 24 jam dan dukungan refresh token. Setiap respons API menyertakan header rate limit agar integrasi Anda dapat mengatur lajunya sendiri dengan mulus.

Langkah 01

Autentikasi

Kirim POST ke /v1/login dengan kredensial. Terima token bearer JWT yang berlaku 24 jam. Gunakan refresh token untuk integrasi yang berjalan lama.

Langkah 02

Panggil Endpoint

25+ endpoint RESTful untuk kampanye, kontak, panggilan, agen, kepatuhan, rekaman, dan laporan. Input JSON, output JSON.

Langkah 03

Terima Webhook

Daftarkan URL webhook untuk menerima event real-time. Setiap payload ditandatangani dengan HMAC-SHA256 sehingga Anda dapat memverifikasi keasliannya.

Langkah 04

Tangani Error

RFC 7807 Problem Details untuk setiap error. Header rate limit di setiap respons. Status 429 dengan panduan retry-after.

Perbandingan Berdampingan

DialerBee API vs API dialer pada umumnya

Kemampuan API Dialer pada Umumnya DialerBee API
Endpoint 5-10, terdokumentasi sebagian 25+ terdokumentasi lengkap dengan spesifikasi OpenAPI
Protokol SOAP/XML atau proprietary REST dengan JSON, error RFC 7807
Authentication API key (tidak pernah kedaluwarsa) JWT dengan masa berlaku 24 jam + refresh token
Event real-time Polling atau tidak ada Webhook bertanda tangan HMAC-SHA256 dengan retry
Paginasi Berbasis offset atau tidak ada Berbasis kursor dengan next_cursor + has_more
Rate limiting Tidak terdokumentasi 2,000 req/menit dengan header di setiap respons
Dokumentasi PDF atau wiki usang Dokumentasi Swagger interaktif langsung
Multi-tenant Hanya single tenant Pembatasan per tenant di setiap endpoint

Referensi Endpoint

10 grup API. 25+ endpoint.

Grup API Endpoint
Authentication POST /login, POST /refresh
Kampanye CRUD + mulai/jeda
Kontak Unggah, daftar, cari
Panggilan Riwayat, jumlah langsung, originate
Agen Status, registrasi SIP
Kepatuhan & DNC Pemeriksaan pra-panggilan, daftar DNC
Rekaman Daftar, URL pemutaran bertanda tangan
Laporan Ekspor (CSV, JSON, PDF)
Webhook Berlangganan, kelola, verifikasi
Sistem Kesehatan, versi

Mulai Cepat

Autentikasi dan mulai memanggil dalam 3 panggilan API

Langkah 1 Autentikasi
POST /v1/login
Content-Type: application/json

{
  "email": "admin@yourcompany.com",
  "password": "••••••••"
}

→ Response: { "token": "eyJhbG...", "expires_in": 86400 }
Langkah 2 Buat kampanye
POST /v1/campaigns
Authorization: Bearer eyJhbG...

{
  "name": "Q3 Collections",
  "mode": "progressive",
  "amd_enabled": true,
  "compliance_profile": "uae-tdra"
}
Langkah 3 Unggah kontak dan mulai
POST /v1/campaigns/{id}/contacts
Content-Type: multipart/form-data

→ Upload CSV with phone, name, and custom fields

POST /v1/campaigns/{id}/start
→ Campaign is now dialing

Webhook

Event real-time dikirim ke sistem Anda

Webhook mengirimkan event ke sistem Anda secara real-time — tanpa perlu polling. Setiap payload webhook ditandatangani dengan HMAC-SHA256 sehingga Anda dapat memverifikasi bahwa payload berasal dari DialerBee dan tidak dimanipulasi. Jika endpoint Anda sedang down, webhook akan dicoba ulang dengan exponential backoff hingga 2 jam 35 menit, sehingga Anda tidak pernah melewatkan satu event pun.

call.started

Panggilan outbound baru telah dimulai

call.answered

Penerima mengangkat telepon — termasuk klasifikasi AMD

call.ended

Panggilan selesai dengan durasi, disposisi, dan URL rekaman

call.amd_result

Hasil klasifikasi AMD: manusia atau mesin, dengan skor keyakinan

agent.state_change

Agen berstatus tersedia, sedang menelepon, wrap-up, atau offline

disposition.set

Agen mengirim disposisi beserta hasil dan catatan

compliance.blocked

Panggilan diblokir oleh mesin kepatuhan beserta detail aturannya

campaign.started

Kampanye mulai melakukan panggilan

campaign.paused

Kampanye dijeda oleh supervisor atau sistem

recording.ready

Rekaman panggilan telah diproses dan siap diputar

contact.dnc_added

Kontak ditambahkan ke daftar supresi DNC

callback.scheduled

Agen menjadwalkan panggilan balik untuk kontak

Di balik layar

Dibuat untuk developer yang terbiasa merilis

Protokol Hanya HTTPS (TLS 1.2+)
Format Body request dan response JSON
Authentication Token Bearer JWT (masa berlaku 24 jam) dengan refresh
Versioning Path URL /v1 + schema_version di webhook
Paginasi Berbasis kursor dengan next_cursor dan has_more
Rate limiting 2,000 permintaan/menit per tenant dengan header
Format error RFC 7807 Problem Details for HTTP APIs
Penandatanganan webhook Verifikasi tanda tangan HMAC-SHA256
Retry webhook Exponential backoff (total maksimal 2j 35m)
URL rekaman URL bertanda tangan dengan masa berlaku 1 jam via MinIO
Registri DNC UEA (TDRA), Arab Saudi (CST), Mesir (NTRA), Yordania (TRC)
SDK JavaScript dan Python (segera hadir)

Pertanyaan umum seputar API

Apakah API tersedia di semua paket?
Akses REST API tersedia di semua paket. Paket Starter memiliki cakupan API terbatas (hanya-baca untuk beberapa endpoint). Paket Professional dan Enterprise mencakup akses API penuh dengan operasi tulis, webhook, dan rate limit yang lebih tinggi.
Di mana saya dapat menemukan dokumentasi API?
Dokumentasi API interaktif tersedia di app.dialerbee.com/admin/api-docs.html. Isinya mencakup deskripsi endpoint, contoh request/response, panduan autentikasi, dan API explorer langsung tempat Anda dapat menguji panggilan secara langsung.
Bagaimana cara kerja autentikasi webhook?
Setiap payload webhook menyertakan tanda tangan HMAC-SHA256 di header X-Signature. Endpoint Anda perlu menghitung HMAC dari body request mentah menggunakan webhook secret Anda, lalu membandingkannya dengan tanda tangan tersebut. Ini memverifikasi bahwa payload berasal dari DialerBee dan tidak diubah selama transit.
Apa yang terjadi jika endpoint webhook saya sedang down?
DialerBee mencoba ulang pengiriman webhook yang gagal dengan exponential backoff. Percobaan ulang berlangsung hingga total 2 jam 35 menit. Setelah semua percobaan habis, event dicatat sebagai tidak terkirim dan terlihat di dashboard webhook Anda.
Bisakah saya menggunakan API untuk membangun antarmuka agen kustom?
Ya. API menyediakan semua endpoint terkait agen: manajemen status, kontrol panggilan, pengiriman disposisi, pencarian kontak, dan pemutaran rekaman. Dipadukan dengan event WebSocket untuk pembaruan real-time, Anda dapat membangun pengalaman agen yang sepenuhnya kustom.
Apakah API mendukung multi-tenant?
Ya. Setiap panggilan API dibatasi pada tenant yang terautentikasi. Akun partner/reseller dapat mengelola banyak tenant melalui Partner API, termasuk provisioning tenant, konfigurasi, dan manajemen penagihan.
Berapa rate limit-nya?
2,000 permintaan per menit per tenant. Setiap respons menyertakan header X-RateLimit-Limit, X-RateLimit-Remaining, dan X-RateLimit-Reset. Jika Anda melampaui batas, Anda akan menerima status 429 dengan header Retry-After.
Apakah tersedia SDK?
SDK JavaScript dan Python sedang dikembangkan. Sementara itu, API menggunakan konvensi REST standar dengan payload JSON, sehingga HTTP client apa pun dalam bahasa pemrograman apa pun dapat digunakan. Dokumentasi interaktif menyertakan contoh curl untuk setiap endpoint.

Ketahui event apa saja yang bisa Anda langgani

Setiap event terdokumentasi sebelum Anda mulai membangun

Platform menerbitkan event untuk setiap hal penting dalam sebuah panggilan, dan masing-masing dikatalogkan beserta struktur payload-nya — sehingga Anda tahu isi webhook sebelum menulis handler, alih-alih menebak skema dari data yang pertama kali datang.

Siklus hidup panggilan, status kampanye, aktivitas agen, disposisi, ketersediaan rekaman, keputusan kepatuhan, dan status pengiriman pesan masing-masing menerbitkan event sendiri. Berlanggananlah pada event yang relevan bagi integrasi Anda dan abaikan sisanya — Anda tidak perlu menampung seluruh aliran event hanya untuk mendapatkan tiga event yang Anda butuhkan.

Siap berintegrasi?

Jelajahi dokumentasi API langsung atau pesan demo dan dapatkan akses API. Bangun integrasi pertama Anda dalam hitungan jam, bukan minggu.

Uji coba gratis 14 hari · kredit AI gratis · tanpa kartu · lihat harga

Lihat situs lengkap dalam bahasa Inggris →