API ve Web Kancaları
Üretime hazır API. Bu bir yol haritası slaytı değil.
25'ten fazla REST uç noktası, gerçek zamanlı web kancaları, JWT kimlik doğrulaması ve etkileşimli dokümantasyon. Kullanıcı arayüzünde kullandığınız her özellik API aracılığıyla da kullanılabilir.
Hızlı cevap
DialerBee API nedir? DialerBee, kampanyalar, kişiler, aramalar, temsilciler, uyumluluk, kayıtlar, raporlar ve web kancaları kapsayan 25'ten fazla uç noktaya sahip, üretime hazır bir REST API sunar. Kimlik doğrulama, 24 saatlik geçerlilik süresine sahip JWT taşıyıcı token'ları kullanır. API, imleç tabanlı sayfalama desteği sunar, RFC 7807 hata yanıtları döndürür ve kiracı başına dakikada 2.000 istek sınırı uygular. Gerçek zamanlı web kancaları, HMAC-SHA256 imza doğrulaması ve üstel yeniden deneme geri çekilmesi ile olayları (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked, vb.) iletir. Etkileşimli API dokümantasyonuna dialer.broadnet.me/admin/api-docs.html adresinden ulaşılabilir.
Sorun
Çoğu arama API'si şöyledir: sonradan akla gelen bir düşünce
Arama yapmak için bir arama programı satın aldınız. Şimdi bunu CRM'inizle entegre etmeniz, verileri veri ambarınıza aktarmanız, arama olaylarından iş akışlarını tetiklemeniz ve özel gösterge panoları oluşturmanız gerekiyor. Satıcının API dokümantasyonunu kontrol ediyorsunuz ve... 2019'dan kalma, belgelenmemiş 6 uç noktası, web kancası olmayan ve SOAP arayüzü içeren bir PDF buluyorsunuz.
Bu, çoğu dış arama ekibi için gerçektir. Arama sistemi arama yapmak için sorunsuz çalışır, ancak bir şeye ihtiyacınız olduğu anda... onun üzerine inşa edin — Salesforce ile işlem kayıtlarını senkronize edin, Zendesk'te otomatik olarak bilet oluşturun, analizleri BI aracınıza aktarın veya özel bir temsilci arayüzü oluşturun — CSV dışa aktarımlarına ve manuel süreçlere bağlı kalıyorsunuz.
DialerBee, API öncelikli olarak geliştirilmiştir. Kullanıcı arayüzündeki her özellik, kendi sistemlerinizden çağırabileceğiniz aynı REST API tarafından desteklenmektedir. API, sonradan eklenen bir özellik değil, tüm platformun temelini oluşturmaktadır.
Nasıl Çalışır
API öncelikli tasarım gereği
DialerBee'nin API'si, JSON yükleri, standart HTTP yöntemleri ve RFC 7807 hata yanıtlarıyla REST kurallarına uyar. Kimlik doğrulama, 24 saatlik geçerlilik süresi ve token yenileme desteğiyle bir giriş uç noktası aracılığıyla elde edilen JWT taşıyıcı token'ları kullanır. Her API yanıtı, entegrasyonunuzun sorunsuz bir şekilde kendi kendini kısıtlayabilmesi için hız sınırlama başlıkları içerir.
Kimlik doğrulama
Kimlik bilgilerinizle /v1/login adresine POST isteği gönderin. 24 saat geçerli bir JWT taşıyıcı belirteci alın. Uzun süreli entegrasyonlar için belirteç yenileme özelliğini kullanın.
Çağrı Uç Noktaları
Kampanyalar, kişiler, aramalar, temsilciler, uyumluluk, kayıtlar ve raporlar için 25'ten fazla RESTful uç nokta. JSON girişi, JSON çıkışı.
Web kancalarını alın
Gerçek zamanlı olayları almak için webhook URL'lerini kaydedin. Her veri paketi HMAC-SHA256 ile imzalanır, böylece orijinalliğini doğrulayabilirsiniz.
Hataları Yönetme
RFC 7807'ye göre her hata için sorun detayları. Her yanıtta hız sınırlama başlıkları. Yeniden deneme talimatı içeren 429 durum kodu.
Yan Yana Karşılaştırma
DialerBee API'si ile karşılaştırma tipik arama API'leri
| Yetenek | Tipik Arama API'si | DialerBee API |
|---|---|---|
| Uç noktalar | 5-10, kısmen belgelenmiş | OpenAPI spesifikasyonuna uygun olarak tamamen belgelenmiş 25'ten fazla ürün. |
| Protokol | SOAP/XML veya tescilli | JSON ile REST, RFC 7807 hataları |
| Kimlik doğrulama | API anahtarı (süresi asla dolmaz) | 24 saat geçerlilik süresi olan JWT + token yenileme |
| Gerçek zamanlı olaylar | Anket yapılıp yapılmaması fark etmeksizin | HMAC-SHA256 ile imzalanmış ve yeniden deneme özelliğine sahip web kancaları |
| Sayfalama | Ofset tabanlı veya hiçbiri | next_cursor + has_more ile imleç tabanlı. |
| Hız sınırlama | Belgesiz | Her yanıtta başlıklar bulunan 2.000 istek/dakika |
| Dokümantasyon | PDF veya güncelliğini yitirmiş wiki | Canlı etkileşimli Swagger dokümanları |
| Çoklu kiracılı | Sadece tek kiracı | Her uç noktada kiracı bazında kapsam belirleme |
Uç Nokta Referansı
10 API grubu. 25'ten fazla uç nokta.
| API Grubu | Uç noktalar |
|---|---|
| Kimlik doğrulama | POST /giriş, POST /yenile |
| Kampanyalar | CRUD + başlat/duraklat |
| İletişim | Yükle, listele, ara |
| Çağrılar | Tarih, canlı sayılar, köken |
| Ajanlar | Eyalet, SIP kaydı |
| Uyumluluk ve DNC | Ön arama kontrolleri, DNC listeleri |
| Kayıtlar | Liste, imzalı oynatma URL'leri |
| Raporlar | Dışa Aktar (CSV, JSON, PDF) |
| Web kancaları | Abone ol, yönet, doğrula |
| Sistem | Sağlık, sürüm |
Hızlı Başlangıç
Kimlik doğrulamasını yapın ve aramaya başlayın. 3 API çağrısında
POSTALAMAK /v1/giriş
İçerik Türü: application/json
{
"e-posta": "admin@yourcompany.com",
"şifre": "••••••••"
}
→ Yanıt: { "jeton": "eyJhbG...", "süre_son_tarihinde": 86400 }POSTALAMAK /v1/kampanyalar
Yetkilendirme: Taşıyıcı eyJhbG...
{
"isim": "3. Çeyrek Koleksiyonları",
"mod": "ilerici",
"amd_etkin": true,
"uyumluluk_profili": "uae-tdra"
}POSTALAMAK /v1/kampanyalar/{id}/kişiler
İçerik Türü: multipart/form-data
→ Telefon numarası, isim ve özel alanlar içeren CSV dosyasını yükleyin
POSTALAMAK /v1/kampanyalar/{id}/başlangıç
→ Kampanya şu anda arama yapıyorWeb kancaları
Gerçek zamanlı olaylar sistemlerinize teslim edildi
Webhook'lar, sistemlerinize gerçek zamanlı olarak olaylar iletir; yoklama yapmaya gerek yoktur. Her webhook yükü imzalanmıştır. HMAC-SHA256 Böylece, bunun DialerBee'den geldiğini ve üzerinde herhangi bir değişiklik yapılmadığını doğrulayabilirsiniz. Uç noktanız çalışmıyorsa, web kancaları 2 saat 35 dakikaya kadar üstel geri çekilme ile yeniden deneme yapar ve hiçbir olayı kaçırmamanızı sağlar.
çağrı başladı Yeni bir giden arama başlatıldı.
çağrıya cevap verildi. Alıcı, AMD sınıflandırması da dahil olmak üzere ürünü teslim aldı.
çağrı sona erdi. Görüşme, süresi, sonucu ve kayıt URL'si ile tamamlandı.
çağrı.amd_sonucu AMD sınıflandırma sonucu: insan mı yoksa makine mi, güven skoru ile birlikte
ajan.durum_değişimi Temsilci müsait, nöbetçi, görüşmeyi sonlandıran veya çevrimdışı oldu.
eğilim.set Temsilci, sonuç ve notları içeren bir karar sundu.
uyumluluk.engellendi Uyumluluk kontrol sistemi tarafından kural ayrıntılarıyla birlikte bir çağrı engellendi.
kampanya başladı Kampanya telefon görüşmelerine başladı.
kampanya.duraklatıldı Kampanya, yönetici veya sistem tarafından durduruldu.
kayıt hazır. Çağrı kaydı işlendi ve oynatılmaya hazır.
iletişim.dnc_eklendi Bir kişi DNC engelleme listesine eklendi.
geri arama.planlandı Müşteri temsilcisi, ilgili kişi için geri arama planladı.
Kullanım Senaryoları
Her şeyi inşa edin DialerBee'nin üstünde
CRM Senkronizasyonu
Web kancaları veya API sorgulaması yoluyla işlem sonuçlarını, çağrı sonuçlarını ve kayıt bağlantılarını Salesforce, HubSpot, Zoho veya herhangi bir CRM'ye aktarın.
BI ve Veri Ambarı
Çağrı verilerini veri ambarınıza aktarın. Zamanlanmış rapor dışa aktarımlarıyla Looker, Tableau, Power BI veya Metabase'de gösterge panoları oluşturun.
Özel İş Akışları
Çağrı olaylarında sistemlerinizde eylemleri tetikleyin — otomatik olarak destek biletleri oluşturun, potansiyel müşteri puanlarını güncelleyin, Slack bildirimleri gönderin.
Tıkla-Ara
Çağrı başlatma uç noktasını kullanarak CRM, destek masası veya özel uygulamanızdan tıklayarak arama özelliğini ekleyebilirsiniz.
Kişi Senkronizasyonu
İletişim listelerinizi güvenilir veri kaynağınızla senkronize halde tutun. CSV dosyası üzerinden yükleyin veya API aracılığıyla tek tek kişileri gönderin.
Uyumluluk Otomasyonu
Arama öncesinde DNC durumunu sorgulayın, engelleme listelerini yönetin ve uyumluluk denetim kayıtlarını programatik olarak dışa aktarın.
Motor kaputunun altında
Ürünlerini piyasaya süren geliştiriciler için tasarlandı.
| Protokol | Yalnızca HTTPS (TLS 1.2+) |
| Biçim | JSON istek ve yanıt gövdeleri |
| Kimlik doğrulama | Yenileme özelliği bulunan JWT Taşıyıcı token'lar (24 saat geçerlilik süresi) |
| Sürümleme | /v1 URL yolu + schema_version web kancalarında |
| Sayfalama | next_cursor ve has_more ile imleç tabanlı. |
| Hız sınırlama | Başlıklar dahil olmak üzere kiracı başına dakikada 2.000 istek |
| Hata formatı | RFC 7807 HTTP API'leri için Sorun Ayrıntıları |
| Webhook imzalama | HMAC-SHA256 imza doğrulaması |
| Webhook yeniden denemeleri | Üstel geri çekilme (maksimum toplam 2 saat 35 dakika) |
| URL'leri kaydetmek | MinIO aracılığıyla 1 saat geçerlilik süresi olan imzalı URL'ler. |
| DNC kayıtları | BAE (TDRA), Suudi Arabistan (CITC), Mısır (NTRA), Ürdün (TRC) |
| SDK'lar | JavaScript ve Python (yakında) |
İlgili özellikler
Beyaz Etiket Platformu
Kiracı temini, markalama ve faturalandırma için iş ortağı API'si.
Analiz ve Raporlama
Rapor verilerini API aracılığıyla iş zekası araçlarınıza aktarın.
Kendi Taşıma Çantanızı Getirin
Yönetici paneli ve API aracılığıyla SIP trunk yönetimi.
Entegrasyonlar
CRM'ler, mesajlaşma ve daha fazlası için önceden oluşturulmuş bağlantı noktaları.
API ile ilgili sıkça sorulan sorular
API tüm planlarda mevcut mu?
API dokümantasyonunu nerede bulabilirim?
Webhook kimlik doğrulaması nasıl çalışır?
Webhook uç noktam çalışmazsa ne olur?
API'yi kullanarak özel bir temsilci arayüzü oluşturabilir miyim?
API çoklu kullanıcı desteğine sahip mi?
Oran sınırı nedir?
Kullanılabilir SDK'lar var mı?
Entegrasyona hazır mısınız?
Canlı API dokümanlarını inceleyin veya bir demo rezervasyonu yapın ve API erişimi edinin. İlk entegrasyonunuzu haftalar değil, saatler içinde oluşturun.