API और वेबहुक

डायलर API और वेबहुक: प्रोडक्शन-रेडी, रोडमैप स्लाइड नहीं।

25+ REST एंडपॉइंट, रियल-टाइम वेबहुक, JWT ऑथेंटिकेशन और इंटरैक्टिव डॉक्यूमेंटेशन। UI में इस्तेमाल होने वाली हर सुविधा API के ज़रिए उपलब्ध है।

API डॉक्यूमेंटेशन देखें फ़्री ट्रायल शुरू करें

14 दिन का फ्री ट्रायल · AI वॉइस एजेंट आज़माने के लिए फ्री AI क्रेडिट · कार्ड की ज़रूरत नहीं

BroadNet द्वारा निर्मित — टेलीकॉम में 22 साल 11 भाषाएँ, बोलियों की समझ के साथ BYOC — आपके कैरियर, कोई लॉक-इन नहीं अनुपालन में सहायक (TCPA, GDPR, TDRA)

संक्षिप्त उत्तर

DialerBee API क्या है? DialerBee प्रोडक्शन के लिए तैयार REST API देता है, जिसमें कैंपेन, कॉन्टैक्ट, कॉल, एजेंट, अनुपालन, रिकॉर्डिंग, रिपोर्ट और वेबहुक को कवर करने वाले 25+ एंडपॉइंट हैं। ऑथेंटिकेशन 24 घंटे की वैधता वाले JWT बियरर टोकन से होता है। API कर्सर-आधारित पेजिनेशन का समर्थन करता है, RFC 7807 त्रुटि रिस्पॉन्स लौटाता है और प्रति टेनेंट 2,000 अनुरोध/मिनट की सीमा लागू करता है। रियल-टाइम वेबहुक इवेंट (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked आदि) HMAC-SHA256 सिग्नेचर सत्यापन और एक्सपोनेंशियल रीट्राई बैकऑफ़ के साथ भेजते हैं। इंटरैक्टिव API डॉक्यूमेंटेशन app.dialerbee.com/admin/api-docs.html पर उपलब्ध है।

समस्या

ज़्यादातर डायलर API बाद में जोड़ा गया ख़याल होते हैं

आपने कॉल करने के लिए डायलर ख़रीदा। अब आपको इसे अपने CRM से जोड़ना है, डेटा को अपने वेयरहाउस में भेजना है, कॉल इवेंट से वर्कफ़्लो ट्रिगर करने हैं और कस्टम डैशबोर्ड बनाने हैं। आप वेंडर का API डॉक्यूमेंटेशन देखते हैं और पाते हैं... 2019 की एक PDF, 6 बिना डॉक्यूमेंटेशन वाले एंडपॉइंट, कोई वेबहुक नहीं और एक SOAP इंटरफ़ेस।

ज़्यादातर आउटबाउंड टीमों की यही हकीकत है। डायलर कॉल करने के लिए ठीक चलता है, लेकिन जैसे ही आपको इसके ऊपर कुछ बनाना हो — Salesforce में डिस्पोज़िशन सिंक करना, Zendesk में अपने आप टिकट बनाना, अपने BI टूल में एनालिटिक्स भेजना या कस्टम एजेंट इंटरफ़ेस बनाना — आप CSV एक्सपोर्ट और मैनुअल प्रक्रियाओं में फँस जाते हैं।

DialerBee को API-फ़र्स्ट तरीके से बनाया गया है। UI की हर सुविधा उसी REST API पर चलती है जिसे आप अपने सिस्टम से कॉल कर सकते हैं। API कोई अलग से जोड़ा गया हिस्सा नहीं है — यह वह नींव है जिस पर पूरा प्लेटफ़ॉर्म चलता है।

सामान्य वेंडर एंडपॉइंट

बिना डॉक्यूमेंटेशन, कोई वेबहुक नहीं

SOAP

पुराना प्रोटोकॉल

कई डायलर अब भी XML/SOAP इस्तेमाल करते हैं

CSV

सिर्फ़ एक्सपोर्ट वाला इंटीग्रेशन

मैनुअल फ़ाइल ट्रांसफ़र, रियल-टाइम नहीं

यह कैसे काम करता है

API-फ़र्स्ट डिज़ाइन से ही

DialerBee का API REST परंपराओं का पालन करता है — JSON पेलोड, मानक HTTP मेथड और RFC 7807 त्रुटि रिस्पॉन्स। ऑथेंटिकेशन लॉगिन एंडपॉइंट से मिलने वाले JWT बियरर टोकन से होता है, जिनकी वैधता 24 घंटे है और टोकन रिफ़्रेश समर्थित है। हर API रिस्पॉन्स में रेट-लिमिट हेडर होते हैं, ताकि आपका इंटीग्रेशन ख़ुद को सहजता से धीमा कर सके।

चरण 01

ऑथेंटिकेट करें

क्रेडेंशियल के साथ /v1/login पर POST करें। 24 घंटे के लिए वैध JWT बियरर टोकन पाएँ। लंबे समय तक चलने वाले इंटीग्रेशन के लिए टोकन रिफ़्रेश का उपयोग करें।

चरण 02

एंडपॉइंट कॉल करें

कैंपेन, कॉन्टैक्ट, कॉल, एजेंट, अनुपालन, रिकॉर्डिंग और रिपोर्ट के लिए 25+ RESTful एंडपॉइंट। JSON इनपुट, JSON आउटपुट।

चरण 03

वेबहुक प्राप्त करें

रियल-टाइम इवेंट पाने के लिए वेबहुक URL रजिस्टर करें। हर पेलोड HMAC-SHA256 से साइन होता है, ताकि आप उसकी प्रामाणिकता सत्यापित कर सकें।

चरण 04

त्रुटियाँ संभालें

हर त्रुटि के लिए RFC 7807 Problem Details। हर रिस्पॉन्स में रेट-लिमिट हेडर। retry-after मार्गदर्शन के साथ 429 स्टेटस।

आमने-सामने तुलना

DialerBee API बनाम सामान्य डायलर API

क्षमता	सामान्य डायलर API	DialerBee API
एंडपॉइंट	5-10, आंशिक रूप से डॉक्यूमेंटेड	OpenAPI स्पेसिफ़िकेशन के साथ 25+ पूरी तरह डॉक्यूमेंटेड
प्रोटोकॉल	SOAP/XML या प्रोप्राइटरी	JSON के साथ REST, RFC 7807 त्रुटियाँ
Authentication	API key (कभी एक्सपायर नहीं होती)	24 घंटे की वैधता वाला JWT + टोकन रिफ़्रेश
रियल-टाइम इवेंट	पोलिंग या कुछ नहीं	रीट्राई के साथ HMAC-SHA256 साइन किए गए वेबहुक
पेजिनेशन	ऑफ़सेट-आधारित या कुछ नहीं	next_cursor + has_more के साथ कर्सर-आधारित
रेट लिमिटिंग	डॉक्यूमेंटेड नहीं	हर रिस्पॉन्स में हेडर के साथ 2,000 अनुरोध/मिनट
दस्तावेज़ीकरण	PDF या पुरानी विकी	लाइव इंटरैक्टिव Swagger डॉक्स
मल्टी-टेनेंट	सिर्फ़ सिंगल टेनेंट	हर एंडपॉइंट पर टेनेंट-स्तरीय स्कोपिंग

एंडपॉइंट संदर्भ

10 API समूह। 25+ एंडपॉइंट।

API समूह	एंडपॉइंट	आप क्या कर सकते हैं
Authentication	POST /login, POST /refresh	JWT बियरर टोकन प्राप्त और रिफ़्रेश करें
कैंपेन	CRUD + start/pause	कैंपेन बनाएँ, कॉन्फ़िगर करें, शुरू करें, रोकें और प्रबंधित करें
कॉन्टैक्ट	अपलोड, सूची, खोज	बल्क CSV अपलोड, खोज, फ़िल्टर और कॉन्टैक्ट सूचियाँ प्रबंधित करें
कॉल	इतिहास, लाइव गिनती, कॉल शुरू करना	कॉल इतिहास देखें, लाइव कॉल गिनती पाएँ, कॉल शुरू करें
एजेंट	स्टेट, SIP रजिस्ट्रेशन	एजेंट की उपलब्धता प्रबंधित करें, SIP रजिस्ट्रेशन स्टेटस की निगरानी करें
अनुपालन और DNC	डायल से पहले जाँच, DNC सूचियाँ	नंबरों को DNC रजिस्ट्री से जाँचें, सप्रेशन सूचियाँ प्रबंधित करें
रिकॉर्डिंग	सूची, साइन किए गए प्लेबैक URL	रिकॉर्डिंग की सूची देखें, सीमित समय वाले साइन किए गए प्लेबैक URL बनाएँ
रिपोर्ट	एक्सपोर्ट (CSV, JSON, PDF)	कैंपेन, एजेंट और अनुपालन रिपोर्ट कई फ़ॉर्मेट में एक्सपोर्ट करें
वेबहुक	सब्सक्राइब, प्रबंधन, सत्यापन	वेबहुक एंडपॉइंट रजिस्टर करें, सब्सक्रिप्शन प्रबंधित करें, सिग्नेचर सत्यापित करें
सिस्टम	हेल्थ, वर्ज़न	प्लेटफ़ॉर्म हेल्थ चेक और API वर्ज़न जानकारी

पूरा इंटरैक्टिव API डॉक्यूमेंटेशन देखें

क्विक स्टार्ट

ऑथेंटिकेट करें और डायलिंग शुरू करें सिर्फ़ 3 API कॉल में

चरण 1 ऑथेंटिकेट करें

POST /v1/login
Content-Type: application/json

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

→ Response: { "token": "eyJhbG...", "expires_in": 86400 }

चरण 2 कैंपेन बनाएँ

POST /v1/campaigns
Authorization: Bearer eyJhbG...

{
  "name": "Q3 Collections",
  "mode": "progressive",
  "amd_enabled": true,
  "compliance_profile": "uae-tdra"
}

चरण 3 कॉन्टैक्ट अपलोड करें और शुरू करें

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

वेबहुक

रियल-टाइम इवेंट आपके सिस्टम तक पहुँचाए गए

वेबहुक इवेंट को रियल टाइम में आपके सिस्टम तक पहुँचाते हैं — पोलिंग की ज़रूरत नहीं। हर वेबहुक पेलोड इससे साइन होता है: HMAC-SHA256 ताकि आप सत्यापित कर सकें कि यह DialerBee से आया है और इसमें छेड़छाड़ नहीं हुई। अगर आपका एंडपॉइंट डाउन है, तो वेबहुक एक्सपोनेंशियल बैकऑफ़ के साथ 2 घंटे 35 मिनट तक दोबारा कोशिश करते हैं, ताकि कोई इवेंट छूटे नहीं।

call.started

एक नई आउटबाउंड कॉल शुरू की गई है

call.answered

प्राप्तकर्ता ने कॉल उठाई — AMD वर्गीकरण सहित

call.ended

कॉल पूरी हुई — अवधि, डिस्पोज़िशन और रिकॉर्डिंग URL के साथ

call.amd_result

AMD वर्गीकरण परिणाम: इंसान या मशीन, कॉन्फ़िडेंस स्कोर के साथ

agent.state_change

एजेंट उपलब्ध, कॉल पर, रैप-अप में या ऑफ़लाइन हुआ

disposition.set

एजेंट ने परिणाम और नोट्स के साथ डिस्पोज़िशन सबमिट किया

compliance.blocked

अनुपालन इंजन ने नियम विवरण के साथ एक कॉल रोकी

campaign.started

कैंपेन ने डायलिंग शुरू की

campaign.paused

सुपरवाइज़र या सिस्टम ने कैंपेन रोका

recording.ready

कॉल रिकॉर्डिंग प्रोसेस हो चुकी है और प्लेबैक के लिए तैयार है

contact.dnc_added

एक कॉन्टैक्ट को DNC सप्रेशन सूची में जोड़ा गया

callback.scheduled

एजेंट ने किसी कॉन्टैक्ट के लिए कॉलबैक शेड्यूल किया

उपयोग के मामले

कुछ भी बनाएँ DialerBee के ऊपर

CRM सिंक

वेबहुक या API पोलिंग के ज़रिए डिस्पोज़िशन, कॉल परिणाम और रिकॉर्डिंग लिंक Salesforce, HubSpot, Zoho या किसी भी CRM में भेजें।

BI और डेटा वेयरहाउस

कॉल डेटा को अपने वेयरहाउस में एक्सपोर्ट करें। शेड्यूल्ड रिपोर्ट एक्सपोर्ट के साथ Looker, Tableau, Power BI या Metabase में डैशबोर्ड बनाएँ।

कस्टम वर्कफ़्लो

कॉल इवेंट पर अपने सिस्टम में कार्रवाइयाँ ट्रिगर करें — अपने आप सपोर्ट टिकट बनाएँ, लीड स्कोर अपडेट करें, Slack नोटिफ़िकेशन भेजें।

क्लिक-टू-कॉल

कॉल ओरिजिनेशन एंडपॉइंट से अपने CRM, हेल्पडेस्क या कस्टम ऐप्लिकेशन में क्लिक-टू-कॉल जोड़ें।

कॉन्टैक्ट सिंक

कॉन्टैक्ट सूचियों को अपने मुख्य डेटा स्रोत के साथ सिंक रखें। CSV से अपलोड करें या API से अलग-अलग कॉन्टैक्ट भेजें।

अनुपालन ऑटोमेशन

कॉल से पहले DNC स्टेटस जाँचें, सप्रेशन सूचियाँ प्रबंधित करें और अनुपालन ऑडिट लॉग प्रोग्रामेटिक रूप से एक्सपोर्ट करें।

अंदर की बात

काम पूरा करके शिप करने वाले डेवलपर्स के लिए बना

प्रोटोकॉल	सिर्फ़ HTTPS (TLS 1.2+)
फ़ॉर्मेट	JSON अनुरोध और रिस्पॉन्स बॉडी
Authentication	रिफ़्रेश के साथ JWT बियरर टोकन (24 घंटे की वैधता)
वर्ज़निंग	/v1 URL पाथ + वेबहुक में schema_version
पेजिनेशन	next_cursor और has_more के साथ कर्सर-आधारित
रेट लिमिटिंग	हेडर के साथ प्रति टेनेंट 2,000 अनुरोध/मिनट
त्रुटि फ़ॉर्मेट	HTTP API के लिए RFC 7807 Problem Details
वेबहुक साइनिंग	HMAC-SHA256 सिग्नेचर सत्यापन
वेबहुक रीट्राई	एक्सपोनेंशियल बैकऑफ़ (कुल अधिकतम 2h 35m)
रिकॉर्डिंग URL	MinIO के ज़रिए 1 घंटे की वैधता वाले साइन किए गए URL
DNC रजिस्ट्री	UAE (TDRA), KSA (CST), मिस्र (NTRA), जॉर्डन (TRC)
SDK	JavaScript और Python (जल्द आ रहे हैं)

API के बारे में अक्सर पूछे जाने वाले सवाल

क्या API सभी प्लान में उपलब्ध है?

REST API एक्सेस सभी प्लान में उपलब्ध है। Starter प्लान में API का दायरा सीमित है (कुछ एंडपॉइंट केवल पढ़ने के लिए)। Professional और Enterprise प्लान में राइट ऑपरेशन, वेबहुक और ऊँची रेट लिमिट के साथ पूरा API एक्सेस शामिल है।

API डॉक्यूमेंटेशन कहाँ मिलेगा?

इंटरैक्टिव API डॉक्यूमेंटेशन app.dialerbee.com/admin/api-docs.html पर उपलब्ध है। इसमें एंडपॉइंट विवरण, अनुरोध/रिस्पॉन्स उदाहरण, ऑथेंटिकेशन गाइड और एक लाइव API एक्सप्लोरर है जहाँ आप सीधे कॉल टेस्ट कर सकते हैं।

वेबहुक ऑथेंटिकेशन कैसे काम करता है?

हर वेबहुक पेलोड के X-Signature हेडर में एक HMAC-SHA256 सिग्नेचर होता है। आपके एंडपॉइंट को अपने वेबहुक सीक्रेट से रॉ अनुरोध बॉडी का HMAC निकालकर उसकी तुलना सिग्नेचर से करनी चाहिए। इससे सत्यापित होता है कि पेलोड DialerBee से आया है और रास्ते में बदला नहीं गया।

अगर मेरा वेबहुक एंडपॉइंट डाउन हो तो क्या होगा?

DialerBee विफल वेबहुक डिलीवरी को एक्सपोनेंशियल बैकऑफ़ के साथ दोबारा भेजता है। रीट्राई कुल 2 घंटे 35 मिनट तक चलते हैं। सभी रीट्राई ख़त्म होने के बाद इवेंट को अनडिलीवर्ड के रूप में लॉग किया जाता है और यह आपके वेबहुक डैशबोर्ड में दिखता है।

क्या मैं API से कस्टम एजेंट इंटरफ़ेस बना सकता हूँ?

हाँ। API एजेंट से जुड़े सभी एंडपॉइंट उपलब्ध कराता है: स्टेट मैनेजमेंट, कॉल कंट्रोल, डिस्पोज़िशन सबमिशन, कॉन्टैक्ट लुकअप और रिकॉर्डिंग प्लेबैक। रियल-टाइम अपडेट के लिए WebSocket इवेंट के साथ मिलाकर आप पूरी तरह कस्टम एजेंट अनुभव बना सकते हैं।

क्या API मल्टी-टेनेंट है?

हाँ। हर API कॉल ऑथेंटिकेटेड टेनेंट तक सीमित रहती है। पार्टनर/रीसेलर अकाउंट पार्टनर API के ज़रिए कई टेनेंट प्रबंधित कर सकते हैं, जिसमें टेनेंट प्रोविज़निंग, कॉन्फ़िगरेशन और बिलिंग प्रबंधन शामिल हैं।

रेट लिमिट क्या है?

प्रति टेनेंट प्रति मिनट 2,000 अनुरोध। हर रिस्पॉन्स में X-RateLimit-Limit, X-RateLimit-Remaining और X-RateLimit-Reset हेडर होते हैं। सीमा पार करने पर आपको Retry-After हेडर के साथ 429 स्टेटस मिलेगा।

क्या SDK उपलब्ध हैं?

JavaScript और Python SDK विकास में हैं। तब तक API JSON पेलोड के साथ मानक REST परंपराओं का उपयोग करता है, इसलिए किसी भी भाषा का कोई भी HTTP क्लाइंट काम करता है। इंटरैक्टिव डॉक्यूमेंटेशन में हर एंडपॉइंट के लिए curl उदाहरण हैं।

जानें कि आप किन इवेंट को सब्सक्राइब कर सकते हैं

हर इवेंट आपके बनाने से पहले डॉक्यूमेंटेड है

प्लेटफ़ॉर्म कॉल पर होने वाली हर अहम चीज़ के लिए एक इवेंट प्रकाशित करता है, और हर इवेंट उसके पेलोड ढाँचे के साथ सूचीबद्ध है — ताकि हैंडलर लिखने से पहले ही आपको पता हो कि वेबहुक में क्या होगा, न कि जो पहले आए उससे स्कीमा का अंदाज़ा लगाना पड़े।

कॉल लाइफ़साइकल, कैंपेन स्टेट, एजेंट गतिविधि, डिस्पोज़िशन, रिकॉर्डिंग की उपलब्धता, अनुपालन फ़ैसले और मैसेजिंग डिलीवरी — हर एक अपने इवेंट प्रकाशित करता है। जिन इवेंट की आपके इंटीग्रेशन को ज़रूरत है उन्हें सब्सक्राइब करें और बाकी को छोड़ दें — अपनी ज़रूरत के तीन इवेंट पाने के लिए आपको पूरा इवेंट-सैलाब लेने की बाध्यता नहीं है।

इंटीग्रेट करने के लिए तैयार हैं?

लाइव API डॉक्स देखें या डेमो बुक करके API एक्सेस पाएँ। अपना पहला इंटीग्रेशन हफ़्तों में नहीं, घंटों में बनाएँ।

API डॉक्यूमेंटेशन देखें डेमो बुक करें फ़्री ट्रायल शुरू करें

14 दिन का फ्री ट्रायल · फ्री AI क्रेडिट · कोई कार्ड नहीं · प्राइसिंग देखें