İçeriğe geç

API ve Webhook'lar

Çağrı sistemi API ve webhook'ları: üretime hazır, yol haritası slaydı değil.

25+ REST uç noktası, gerçek zamanlı webhook'lar, JWT kimlik doğrulaması ve etkileşimli dokümantasyon. Arayüzde kullandığınız her özellik API üzerinden de kullanılabilir.

14 günlük ücretsiz deneme · yapay zeka sesli asistanı denemek için ücretsiz yapay zeka kredisi · kart gerekmez

BroadNet tarafından geliştirildi — Telekomda 22 yıl 11 dil, lehçelere duyarlı BYOC — kendi operatörleriniz, bağımlılık yok Uyumluluğu destekleyen kontroller (TCPA, GDPR, TDRA)

Kısa yanıt

DialerBee API nedir? DialerBee; kampanyaları, kişileri, aramaları, temsilcileri, uyumluluğu, kayıtları, raporları ve webhook'ları kapsayan 25+ uç noktalı, üretime hazır bir REST API sunar. Kimlik doğrulama, 24 saat geçerli JWT bearer token'ları kullanır. API, imleç tabanlı sayfalamayı destekler, RFC 7807 hata yanıtları döndürür ve kiracı başına dakikada 2.000 istek sınırı uygular. Gerçek zamanlı webhook'lar olayları (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked vb.) HMAC-SHA256 imza doğrulaması ve üstel yeniden deneme aralığıyla iletir. Etkileşimli API dokümantasyonuna app.dialerbee.com/admin/api-docs.html adresinden ulaşılabilir.

Sorun

Çoğu dialer API'si sonradan akla gelmiş bir ektir

Arama yapmak için bir dialer satın aldınız. Şimdi onu CRM'inizle entegre etmeniz, verileri veri ambarınıza aktarmanız, çağrı olaylarından iş akışları tetiklemeniz ve özel panolar oluşturmanız gerekiyor. Sağlayıcının API dokümantasyonuna bakıyorsunuz ve karşınıza... 6 belgelenmemiş uç nokta içeren, webhook'u olmayan ve SOAP arayüzü kullanan 2019 tarihli bir PDF çıkıyor.

Çoğu giden arama ekibinin gerçeği budur. Dialer arama yapmak için gayet iyi çalışır, ancak üzerine bir şeyler inşa etmeniz gerektiği anda — çağrı sonuçlarını Salesforce ile senkronize etmek, Zendesk'te otomatik destek talebi oluşturmak, analitiği BI aracınıza aktarmak veya özel bir temsilci arayüzü geliştirmek — CSV dışa aktarımlarına ve manuel süreçlere mahkûm kalırsınız.

DialerBee API öncelikli olarak geliştirildi. Arayüzdeki her özelliğin arkasında, kendi sistemlerinizden çağırabileceğiniz aynı REST API vardır. API sonradan eklenmiş bir parça değil, tüm platformun üzerinde çalıştığı temeldir.

6
Tipik sağlayıcı uç noktası
belgelenmemiş, webhook yok
SOAP
Eski protokol
birçok dialer hâlâ XML/SOAP kullanıyor
CSV
Yalnızca dışa aktarmaya dayalı entegrasyon
manuel dosya aktarımı, gerçek zamanlı değil

Nasıl çalışır

Tasarımı gereği API öncelikli

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, bir giriş uç noktası üzerinden alınan, 24 saat geçerli ve yenilenebilen JWT bearer token'ları kullanır. Her API yanıtı hız sınırı başlıkları içerir; böylece entegrasyonunuz istek hızını sorunsuz şekilde kendisi ayarlayabilir.

Adım 01

Kimlik doğrulayın

Kimlik bilgileriyle /v1/login adresine POST isteği gönderin. 24 saat geçerli bir JWT bearer token alın. Uzun süre çalışan entegrasyonlar için token yenilemeyi kullanın.

Adım 02

Uç noktaları çağırın

Kampanyalar, kişiler, aramalar, temsilciler, uyumluluk, kayıtlar ve raporlar için 25+ RESTful uç nokta. JSON girer, JSON çıkar.

Adım 03

Webhook'ları alın

Gerçek zamanlı olayları almak için webhook URL'leri kaydedin. Her yük HMAC-SHA256 ile imzalanır; böylece gerçekliğini doğrulayabilirsiniz.

Adım 04

Hataları yönetin

Her hata için RFC 7807 Problem Details. Her yanıtta hız sınırı başlıkları. Yeniden deneme (retry-after) yönlendirmesiyle 429 durum kodu.

Yan Yana Karşılaştırma

DialerBee API ile tipik dialer API'lerinin karşılaştırması

Yetenek Tipik Dialer API'si DialerBee API
Uç noktalar 5-10, kısmen belgelenmiş 25+, OpenAPI spesifikasyonuyla tamamen belgelenmiş
Protokol SOAP/XML veya tescilli JSON ile REST, RFC 7807 hataları
Kimlik Doğrulama API anahtarı (süresi hiç dolmaz) 24 saat geçerli JWT + token yenileme
Gerçek zamanlı olaylar Yoklama (polling) veya hiç yok Yeniden denemeli, HMAC-SHA256 imzalı webhook'lar
Sayfalama Ofset tabanlı veya hiç yok next_cursor + has_more ile imleç tabanlı
Hız sınırlama Belgelenmemiş Her yanıtta başlıklarla dakikada 2.000 istek
Belgeleme PDF veya güncelliğini yitirmiş wiki Canlı, etkileşimli Swagger dokümantasyonu
Çok kiracılı yapı Yalnızca tek kiracı Her uç noktada kiracı bazında kapsam

Uç Nokta Referansı

10 API grubu. 25+ uç nokta.

API Grubu Uç noktalar
Kimlik Doğrulama POST /login, POST /refresh
Kampanyalar CRUD + başlat/duraklat
Kişiler Yükleme, listeleme, arama
Aramalar Geçmiş, canlı sayılar, arama başlatma
Temsilci Durum, SIP kaydı
Uyumluluk ve DNC Arama öncesi kontroller, DNC listeleri
Ses kayıtları Listeleme, imzalı oynatma URL'leri
Raporlar Dışa aktarma (CSV, JSON, PDF)
Webhook'lar Abone olma, yönetme, doğrulama
Sistem Sağlık durumu, sürüm

Hızlı Başlangıç

Kimlik doğrulayın ve aramaya başlayın — yalnızca 3 API çağrısıyla

1. Adım Kimlik doğrulayın
POST /v1/login
Content-Type: application/json

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

→ Response: { "token": "eyJhbG...", "expires_in": 86400 }
2. Adım Kampanya oluşturun
POST /v1/campaigns
Authorization: Bearer eyJhbG...

{
  "name": "Q3 Collections",
  "mode": "progressive",
  "amd_enabled": true,
  "compliance_profile": "uae-tdra"
}
3. Adım Kişileri yükleyin ve başlatın
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'lar

Gerçek zamanlı olaylar sistemlerinize iletilir

Webhook'lar olayları sistemlerinize gerçek zamanlı iletir — yoklama gerekmez. Her webhook yükü HMAC-SHA256 ile imzalanır; böylece DialerBee'den geldiğini ve değiştirilmediğini doğrulayabilirsiniz. Uç noktanız erişilemez durumdaysa webhook'lar 2 saat 35 dakikaya kadar üstel aralıklarla yeniden denenir ve hiçbir olayı kaçırmamanız sağlanır.

call.started

Yeni bir giden arama başlatıldı

call.answered

Alıcı yanıtladı — AMD sınıflandırması dahil

call.ended

Arama süre, sonuç kodu ve kayıt URL'siyle tamamlandı

call.amd_result

AMD sınıflandırma sonucu: güven puanıyla birlikte insan veya makine

agent.state_change

Temsilci müsait, görüşmede, arama sonrası işlemde veya çevrimdışı duruma geçti

disposition.set

Temsilci sonuç ve notlarla bir sonuç kodu gönderdi

compliance.blocked

Bir arama, kural ayrıntılarıyla birlikte uyumluluk motoru tarafından engellendi

campaign.started

Kampanya aramaya başladı

campaign.paused

Kampanya süpervizör veya sistem tarafından duraklatıldı

recording.ready

Arama kaydı işlendi ve oynatmaya hazır

contact.dnc_added

Bir kişi DNC engelleme listesine eklendi

callback.scheduled

Temsilci bir kişi için geri arama planladı

Teknik altyapı

Ürün çıkaran geliştiriciler için tasarlandı

Protokol Yalnızca HTTPS (TLS 1.2+)
Format JSON istek ve yanıt gövdeleri
Kimlik Doğrulama Yenilenebilen JWT Bearer token'ları (24 saat geçerli)
Sürümleme /v1 URL yolu + webhook'larda schema_version
Sayfalama next_cursor ve has_more ile imleç tabanlı
Hız sınırlama Başlıklarla birlikte kiracı başına dakikada 2.000 istek
Hata formatı HTTP API'leri için RFC 7807 Problem Details
Webhook imzalama HMAC-SHA256 imza doğrulaması
Webhook yeniden denemeleri Üstel geri çekilme (toplamda en fazla 2 sa 35 dk)
Kayıt URL'leri MinIO üzerinden 1 saat geçerli imzalı URL'ler
DNC kayıtları BAE (TDRA), KSA (CST), Mısır (NTRA), Ürdün (TRC)
SDK'lar JavaScript ve Python (yakında)

API hakkında sık sorulan sorular

API tüm planlarda kullanılabilir mi?
REST API erişimi tüm planlarda mevcuttur. Starter planlarda API kapsamı sınırlıdır (bazı uç noktalar salt okunurdur). Professional ve Enterprise planlar, yazma işlemleri, webhook'lar ve daha yüksek hız sınırlarıyla tam API erişimi içerir.
API dokümantasyonunu nerede bulabilirim?
Etkileşimli API dokümantasyonuna app.dialerbee.com/admin/api-docs.html adresinden ulaşılabilir. Uç nokta açıklamaları, istek/yanıt örnekleri, kimlik doğrulama kılavuzları ve aramaları doğrudan test edebileceğiniz canlı bir API gezgini içerir.
Webhook kimlik doğrulaması nasıl çalışır?
Her webhook yükü, X-Signature başlığında bir HMAC-SHA256 imzası içerir. Uç noktanız, webhook gizli anahtarınızı kullanarak ham istek gövdesinin HMAC değerini hesaplamalı ve imzayla karşılaştırmalıdır. Bu, yükün DialerBee'den geldiğini ve aktarım sırasında değiştirilmediğini doğrular.
Webhook uç noktam çalışmıyorsa ne olur?
DialerBee başarısız webhook teslimatlarını üstel geri çekilmeyle yeniden dener. Yeniden denemeler toplamda 2 saat 35 dakikaya kadar sürer. Tüm denemeler tükendikten sonra olay teslim edilmemiş olarak kaydedilir ve webhook panonuzda görünür.
API ile özel bir temsilci arayüzü geliştirebilir miyim?
Evet. API, temsilciyle ilgili tüm uç noktaları sunar: durum yönetimi, arama kontrolü, sonuç kodu gönderimi, kişi sorgulama ve kayıt oynatma. Gerçek zamanlı güncellemeler için WebSocket olaylarıyla birlikte tamamen özel bir temsilci deneyimi oluşturabilirsiniz.
API çok kiracılı mı?
Evet. Her API çağrısı kimliği doğrulanmış kiracıyla sınırlıdır. İş ortağı/bayi hesapları, Partner API aracılığıyla kiracı oluşturma, yapılandırma ve faturalama yönetimi dahil olmak üzere birden fazla kiracıyı yönetebilir.
Hız sınırı nedir?
Kiracı başına dakikada 2.000 istek. Her yanıt X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıklarını içerir. Sınırı aşarsanız Retry-After başlığıyla birlikte 429 durum kodu alırsınız.
SDK'lar mevcut mu?
JavaScript ve Python SDK'ları geliştirme aşamasındadır. Bu arada API, JSON yükleriyle standart REST kurallarını kullandığından herhangi bir dildeki herhangi bir HTTP istemcisi çalışır. Etkileşimli dokümantasyon her uç nokta için curl örnekleri içerir.

Nelere abone olabileceğinizi bilin

Her olay, siz geliştirmeye başlamadan belgelenmiştir

Platform, bir aramada önemli olan her şey için bir olay yayınlar ve her biri yük yapısıyla birlikte kataloglanır — böylece şemayı ilk gelen veriden keşfetmek yerine, işleyiciyi yazmadan önce bir webhook'un ne içereceğini bilirsiniz.

Arama yaşam döngüsü, kampanya durumu, temsilci etkinliği, sonuç kodu, kayıt hazır olma durumu, uyumluluk kararları ve mesaj teslimatı kendi olaylarını yayınlar. Entegrasyonunuzun ilgilendiği olaylara abone olun, gerisini yok sayın — ihtiyacınız olan üç olay için tüm olay akışını tüketmek zorunda değilsiniz.

Entegrasyona hazır mısınız?

Canlı API dokümantasyonunu inceleyin veya bir demo ayırtıp API erişimi alın. İlk entegrasyonunuzu haftalar değil saatler içinde oluşturun.

14 günlük ücretsiz deneme · ücretsiz yapay zeka kredisi · kart gerekmez · fiyatları inceleyin

Tüm siteyi İngilizce görüntüle →