API & Webhooks
API yang siap produksi. Bukan slide peta jalan.
25+ endpoint REST , webhook real-time, otentikasi JWT, dan dokumentasi interaktif. Setiap fitur yang Anda gunakan di UI tersedia melalui API .
Uji coba gratis 14 hari · tidak perlu kartu kredit
Jawaban singkat
Apa itu API DialerBee ? DialerBee menyediakan API REST siap produksi dengan lebih dari 25 endpoint yang mencakup kampanye, kontak, panggilan, agen, kepatuhan, rekaman, laporan, dan webhook. Otentikasi menggunakan token bearer JWT dengan masa berlaku 24 jam. API mendukung paginasi berbasis kursor, mengembalikan respons kesalahan RFC 7807, dan memberlakukan 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 penundaan percobaan ulang eksponensial. Dokumentasi API interaktif tersedia di dialer.broadnet.me/admin/api-docs.html.
Masalah
Sebagian besar API dialer adalah sebuah pemikiran tambahan
Anda membeli aplikasi panggilan untuk melakukan panggilan. Sekarang Anda perlu mengintegrasikannya dengan CRM Anda, mengirim data ke gudang data Anda, memicu alur kerja dari peristiwa panggilan, dan membangun dasbor khusus. Anda memeriksa dokumentasi API vendor dan menemukan... sebuah PDF dari tahun 2019 dengan 6 endpoint yang tidak terdokumentasi, tanpa webhook, dan antarmuka SOAP.
Inilah realita bagi sebagian besar tim outbound. Dialer berfungsi dengan baik untuk melakukan panggilan, tetapi saat Anda perlu... membangun di atasnya — Sinkronkan disposisi ke Salesforce, buat tiket otomatis di Zendesk, kirim analitik ke alat BI Anda, atau bangun antarmuka agen khusus — Anda masih terjebak dengan ekspor CSV dan proses manual.
DialerBee dibangun API -pertama. Setiap fitur di UI didukung oleh API REST yang sama yang dapat Anda panggil dari sistem Anda sendiri. API ini bukan sekadar tambahan—ini adalah fondasi tempat seluruh platform berjalan.
Cara Kerjanya
API -pertama sesuai desain
API DialerBee mengikuti konvensi REST dengan payload JSON, metode HTTP standar, dan respons kesalahan RFC 7807. Otentikasi menggunakan token bearer JWT yang diperoleh melalui endpoint login, dengan masa berlaku 24 jam dan dukungan pembaruan token. Setiap respons API menyertakan header pembatasan laju sehingga integrasi Anda dapat membatasi diri secara otomatis.
Otentikasi
Kirim permintaan POST ke /v1/login dengan kredensial. Terima token bearer JWT yang berlaku selama 24 jam. Gunakan token refresh untuk integrasi jangka panjang.
Titik Akhir Panggilan
25+ endpoint RESTful untuk kampanye, kontak, panggilan, agen, kepatuhan, rekaman, dan laporan. Input JSON, output JSON.
Menerima Webhook
Daftarkan URL webhook untuk menerima peristiwa secara real-time. Setiap payload ditandatangani dengan HMAC-SHA256 sehingga Anda dapat memverifikasi keasliannya.
Tangani Kesalahan
RFC 7807 Detail Masalah untuk setiap kesalahan. Header batas laju di setiap respons. Status 429 dengan panduan coba lagi setelahnya.
Perbandingan Berdampingan
API DialerBee vs API dialer tipikal
| Kemampuan | API Dialer Khas | API DialerBee |
|---|---|---|
| Titik akhir | 5-10, sebagian terdokumentasi | 25+ terdokumentasi lengkap dengan spesifikasi OpenAPI |
| Protokol | SOAP/XML atau milik pribadi | REST dengan JSON, kesalahan RFC 7807 |
| Autentikasi | Kunci API (tidak pernah kedaluwarsa) | JWT dengan masa berlaku 24 jam + pembaruan token |
| Peristiwa waktu nyata | Jajak pendapat atau tidak sama sekali | Webhook yang ditandatangani HMAC-SHA256 dengan fitur coba ulang. |
| Penomoran halaman | Berbasis offset atau tidak sama sekali | Berbasis kursor dengan next_cursor + has_more |
| Pembatasan laju | Tidak memiliki dokumen | 2.000 permintaan/menit dengan header di setiap respons |
| Dokumentasi | PDF atau wiki yang sudah usang | Dokumen Swagger interaktif langsung |
| tenant ganda | Hanya untuk satu tenant | Pembatasan cakupan per-tenant pada setiap titik akhir. |
Referensi Titik Akhir
10 grup API . 25+ titik akhir.
| Grup API | Titik akhir |
|---|---|
| Autentikasi | POST /login, POST /refresh |
| Kampanye | CRUD + mulai/jeda |
| Kontak | Unggah, daftar, cari |
| Panggilan | Sejarah, jumlah langsung, asal mula |
| Agen | Negara, pendaftaran SIP |
| Kepatuhan & DNC | Pemeriksaan pra-panggilan, daftar DNC |
| Rekaman | Daftar URL pemutaran yang ditandatangani |
| Laporan | Ekspor (CSV, JSON, PDF) |
| Webhooks | Berlangganan, kelola, verifikasi |
| Sistem | Kesehatan, versi |
Panduan Singkat
Lakukan otentikasi dan mulai melakukan panggilan. dalam 3 panggilan API
POST /v1/login
Content-Type: application/json
{
"email": "admin@yourcompany.com",
"password": "••••••••"
}
→ Response: { "token": "eyJhbG...", "expires_in": 86400 } POST /v1/campaigns
Authorization: Bearer eyJhbG...
{
"name": "Q3 Collections",
"mode": "progressive",
"amd_enabled": true,
"compliance_profile": "uae-tdra"
} 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 Webhooks
Peristiwa waktu nyata dikirim ke sistem Anda
Webhook mengirimkan peristiwa ke sistem Anda secara real-time — tanpa perlu polling. Setiap payload webhook ditandatangani dengan HMAC-SHA256 Sehingga Anda dapat memverifikasi bahwa itu berasal dari DialerBee dan tidak dimanipulasi. Jika endpoint Anda sedang down, webhook akan mencoba lagi dengan penundaan eksponensial hingga 2 jam 35 menit, memastikan Anda tidak pernah melewatkan suatu peristiwa.
call.started Panggilan keluar baru telah dimulai.
call.answered Penerima telah mengambilnya — termasuk klasifikasi AMD .
call.ended Panggilan selesai dengan durasi, hasil, dan URL rekaman.
call.amd_result Hasil klasifikasi AMD : manusia atau mesin, dengan skor kepercayaan.
agent.state_change Agen sedang tersedia, siaga, menyelesaikan tugas, atau offline.
disposition.set Agen menyerahkan laporan penyelesaian beserta hasil dan catatannya.
compliance.blocked Panggilan diblokir oleh mesin kepatuhan dengan detail aturan.
campaign.started Kampanye mulai melakukan panggilan
campaign.paused Kampanye dihentikan sementara oleh pengawas atau sistem.
recording.ready Rekaman panggilan telah diproses dan siap diputar.
contact.dnc_added Kontak telah ditambahkan ke daftar pemblokiran DNC
callback.scheduled Agen menjadwalkan panggilan balik untuk kontak tersebut.
Kasus Penggunaan
Bangun apa saja di atas DialerBee
Sinkronisasi CRM
Kirimkan status panggilan, hasil panggilan, dan tautan rekaman ke Salesforce, HubSpot, Zoho, atau CRM apa pun melalui webhook atau polling API .
BI & Gudang Data
Ekspor data panggilan ke gudang data Anda. Buat dasbor di Looker, Tableau, Power BI, atau Metabase dengan ekspor laporan terjadwal.
Alur Kerja Kustom
Picu tindakan dalam sistem Anda saat terjadi panggilan — buat tiket dukungan secara otomatis, perbarui skor prospek, kirim notifikasi Slack.
Klik untuk Menelepon
Gunakan titik akhir asal panggilan untuk menambahkan fitur klik-untuk-menelepon dari CRM , helpdesk, atau aplikasi kustom Anda.
Sinkronisasi Kontak
Jaga agar daftar kontak selalu sinkron dengan sumber data utama Anda. Unggah melalui CSV atau kirim kontak individual melalui API .
Otomatisasi Kepatuhan
Periksa status DNC sebelum melakukan panggilan, kelola daftar penolakan, dan ekspor log audit kepatuhan secara terprogram.
Di balik kap mesin
Dibuat untuk pengembang yang merilis produk.
| Protokol | Hanya HTTPS (TLS 1.2+) |
| Format | Isi permintaan dan respons JSON |
| Autentikasi | Token JWT Bearer (berlaku 24 jam) dengan pembaruan |
| Pembuatan versi | Jalur URL /v1 + schema_version di webhook |
| Penomoran halaman | Berbasis kursor dengan next_cursor dan has_more |
| Pembatasan laju | 2.000 permintaan/menit per tenant dengan header |
| Format kesalahan | RFC 7807 Detail Masalah untuk API HTTP |
| Penandatanganan webhook | Verifikasi tanda tangan HMAC-SHA256 |
| Percobaan ulang webhook | Pengurangan waktu secara eksponensial (maksimal total 2 jam 35 menit) |
| URL Rekaman | URL bertanda tangan dengan masa berlaku 1 jam melalui MinIO |
| Daftar DNC | UEA ( TDRA ), KSA ( CITC ), Mesir ( NTRA ), Yordania ( TRC ) |
| SDK | JavaScript dan Python (segera hadir) |
Fitur terkait
Pertanyaan yang sering diajukan tentang API
Apakah API tersedia di semua paket?
Di mana saya bisa menemukan dokumentasi API ?
Bagaimana cara kerja otentikasi webhook?
Apa yang terjadi jika endpoint webhook saya sedang down?
Bisakah saya menggunakan API untuk membangun antarmuka agen kustom?
Apakah API tersebut multi-tenant?
Berapa batas kecepatannya?
Apakah SDK tersedia?
Ketahui apa saja yang dapat Anda berlangganan.
Setiap acara adalah didokumentasikan sebelum Anda membangun
Platform ini menerbitkan sebuah event untuk semua hal penting dalam sebuah panggilan, dan setiap event dikatalogkan beserta bentuk payload-nya — sehingga Anda tahu apa yang akan terkandung dalam webhook sebelum Anda menulis handler, daripada menemukan skema dari apa pun yang tiba lebih dulu.
Siklus hidup panggilan, status kampanye, aktivitas agen, disposisi, ketersediaan rekaman, keputusan kepatuhan, dan pengiriman pesan masing-masing menerbitkan peristiwa mereka sendiri. Berlanggananlah peristiwa yang dibutuhkan integrasi Anda dan abaikan sisanya — Anda tidak wajib menerima begitu banyak data untuk mendapatkan tiga peristiwa yang Anda butuhkan.
Siap untuk diintegrasikan?
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 · tanpa kartu kredit · lihat harga