एपीआई और वेबहुक
उत्पादन के लिए तैयार एपीआई। यह रोडमैप स्लाइड नहीं है।
25 से अधिक REST एंडपॉइंट, रीयल-टाइम वेबहुक, JWT प्रमाणीकरण और इंटरैक्टिव दस्तावेज़ीकरण। UI में उपयोग की जाने वाली प्रत्येक सुविधा API के माध्यम से उपलब्ध है।
त्वरित जवाब
DialerBee API क्या है? DialerBee एक प्रोडक्शन-रेडी REST API प्रदान करता है जिसमें 25 से अधिक एंडपॉइंट्स हैं जो कैंपेन, कॉन्टैक्ट्स, कॉल्स, एजेंट्स, कंप्लायंस, रिकॉर्डिंग, रिपोर्ट्स और वेबहुक्स को कवर करते हैं। प्रमाणीकरण के लिए 24 घंटे की वैधता वाले JWT बियरर टोकन का उपयोग किया जाता है। API कर्सर-आधारित पेजिंग का समर्थन करता है, RFC 7807 त्रुटि प्रतिक्रियाएँ देता है, और प्रति टेनेंट 2,000 अनुरोध/मिनट की सीमा लागू करता है। रीयल-टाइम वेबहुक्स HMAC-SHA256 हस्ताक्षर सत्यापन और एक्सपोनेंशियल रिट्राई बैकऑफ़ के साथ इवेंट्स (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked, आदि) डिलीवर करते हैं। इंटरैक्टिव API दस्तावेज़ dialer.broadnet.me/admin/api-docs.html पर उपलब्ध है।
समस्या
अधिकांश डायलर एपीआई हैं एक बाद का विचार
आपने कॉल करने के लिए एक डायलर खरीदा। अब आपको इसे अपने CRM के साथ एकीकृत करना है, डेटा को अपने डेटाबेस में भेजना है, कॉल इवेंट से वर्कफ़्लो ट्रिगर करना है और कस्टम डैशबोर्ड बनाना है। आपने विक्रेता के API दस्तावेज़ की जाँच की और पाया... 2019 की एक PDF फ़ाइल जिसमें 6 अज्ञात एंडपॉइंट, कोई वेबहुक नहीं और एक SOAP इंटरफ़ेस है।
अधिकांश आउटबाउंड टीमों के लिए यही वास्तविकता है। कॉल करने के लिए डायलर ठीक काम करता है, लेकिन जैसे ही आपको इसकी आवश्यकता होती है... इसके ऊपर निर्माण करें — Salesforce में डेटा सिंक करना, Zendesk में ऑटोमेटिक टिकट बनाना, अपने BI टूल में एनालिटिक्स भेजना, या कस्टम एजेंट इंटरफ़ेस बनाना — इन सभी कामों के लिए आपको CSV एक्सपोर्ट और मैन्युअल प्रक्रियाओं का सहारा लेना पड़ता है।
DialerBee को API-फर्स्ट दृष्टिकोण से बनाया गया है। UI में मौजूद हर फ़ीचर उसी REST API द्वारा समर्थित है जिसे आप अपने सिस्टम से कॉल कर सकते हैं। API कोई अतिरिक्त सुविधा नहीं है — यह संपूर्ण प्लेटफ़ॉर्म का आधार है।
यह काम किस प्रकार करता है
एपीआई-प्रथम डिजाइन द्वारा
DialerBee का API JSON पेलोड, मानक HTTP विधियों और RFC 7807 त्रुटि प्रतिक्रियाओं के साथ REST नियमों का पालन करता है। प्रमाणीकरण के लिए लॉगिन एंडपॉइंट के माध्यम से प्राप्त JWT बियरर टोकन का उपयोग किया जाता है, जिनकी वैधता 24 घंटे की होती है और टोकन रीफ़्रेश करने की सुविधा भी उपलब्ध है। प्रत्येक API प्रतिक्रिया में रेट-लिमिट हेडर शामिल होते हैं ताकि आपका एकीकरण सुचारू रूप से स्वयं-नियंत्रित हो सके।
प्रमाणित
क्रेडेंशियल्स के साथ /v1/login पर POST रिक्वेस्ट भेजें। 24 घंटे के लिए मान्य JWT बियरर टोकन प्राप्त करें। लंबे समय तक चलने वाले इंटीग्रेशन के लिए टोकन रिफ्रेश का उपयोग करें।
कॉल एंडपॉइंट्स
कैंपेन, कॉन्टैक्ट, कॉल, एजेंट, कंप्लायंस, रिकॉर्डिंग और रिपोर्ट के लिए 25+ RESTful एंडपॉइंट। JSON इनपुट, JSON आउटपुट।
वेबहुक प्राप्त करें
रीयल-टाइम इवेंट प्राप्त करने के लिए वेबहुक यूआरएल पंजीकृत करें। प्रत्येक पेलोड HMAC-SHA256 से हस्ताक्षरित होता है, जिससे आप प्रामाणिकता सत्यापित कर सकते हैं।
त्रुटियों को संभालें
RFC 7807 के अनुसार प्रत्येक त्रुटि का समस्या विवरण। प्रत्येक प्रतिक्रिया में दर सीमा हेडर। पुनः प्रयास करने के निर्देश के साथ 429 स्थिति।
आमने-सामने तुलना
DialerBee API बनाम विशिष्ट डायलर एपीआई
| क्षमता | विशिष्ट डायलर एपीआई | डायलरबी एपीआई |
|---|---|---|
| अंतिमबिंदुओं | 5-10, आंशिक रूप से प्रलेखित | 25+ ओपनएपीआई विनिर्देश के साथ पूरी तरह से प्रलेखित |
| शिष्टाचार | SOAP/XML या स्वामित्व | JSON के साथ REST, RFC 7807 त्रुटियाँ |
| प्रमाणीकरण | एपीआई कुंजी (कभी समाप्त नहीं होती) | 24 घंटे की वैधता वाला JWT + टोकन रीफ्रेश |
| वास्तविक समय की घटनाएँ | मतदान हो या न हो | HMAC-SHA256 हस्ताक्षरित वेबहुक जिसमें पुनः प्रयास की सुविधा है |
| पृष्ठ पर अंक लगाना | ऑफसेट-आधारित या कोई नहीं | कर्सर-आधारित, next_cursor + has_more के साथ |
| दर सीमित करना | गैर-दस्तावेजी | प्रत्येक प्रतिक्रिया में हेडर के साथ 2,000 अनुरोध/मिनट |
| प्रलेखन | पीडीएफ या अप्रचलित विकी | लाइव इंटरैक्टिव स्वैगर डॉक्स |
| बहु किरायेदार | केवल एक किरायेदार के लिए | प्रत्येक एंडपॉइंट पर प्रति-किरायेदार स्कोपिंग |
एंडपॉइंट संदर्भ
10 एपीआई समूह। 25+ एंडपॉइंट।
| एपीआई समूह | अंतिमबिंदुओं |
|---|---|
| प्रमाणीकरण | POST /login, POST /refresh |
| अभियान | CRUD + प्रारंभ/विराम |
| संपर्क | अपलोड करें, सूची बनाएं, खोजें |
| कॉल | इतिहास, जीवन गणना, उत्पत्ति |
| एजेंटों | राज्य, एसआईपी पंजीकरण |
| अनुपालन एवं डीएनसी | प्री-डायल चेक, डीएनसी सूचियाँ |
| रिकॉर्डिंग | हस्ताक्षरित प्लेबैक यूआरएल की सूची |
| रिपोर्टों | निर्यात करें (CSV, JSON, PDF) |
| वेबहुक | सदस्यता लें, प्रबंधित करें, सत्यापित करें |
| प्रणाली | स्वास्थ्य, संस्करण |
त्वरित शुरुआत
प्रमाणीकरण करें और डायल करना शुरू करें 3 एपीआई कॉल में
डाक /v1/लॉगिन
सामग्री प्रकार: अनुप्रयोग/जेसन
{
"ईमेल": "admin@yourcompany.com",
"पासवर्ड": "••••••••"
}
→ प्रतिक्रिया: { "टोकन": "eyJhbG...", "में समाप्त होना": 86400 }डाक /v1/अभियान
प्राधिकरण: धारक eyJhbG...
{
"नाम": "Q3 कलेक्शंस",
"तरीका": "प्रगतिशील",
"amd_enabled": true,
"अनुपालन_प्रोफ़ाइल": "यूएई-टीडीआरए"
}डाक /v1/अभियान/{id}/संपर्क
सामग्री प्रकार: मल्टीपार्ट/फॉर्म-डेटा
→ फ़ोन, नाम और कस्टम फ़ील्ड सहित CSV फ़ाइल अपलोड करें
डाक /v1/campaigns/{id}/start
→ अभियान अब डायल कर रहा हैवेबहुक
वास्तविक समय की घटनाएँ आपके सिस्टम पर डिलीवर किया गया
वेबहुक आपके सिस्टम को वास्तविक समय में इवेंट डिलीवर करते हैं — इसके लिए पोलिंग की आवश्यकता नहीं होती। प्रत्येक वेबहुक पेलोड पर हस्ताक्षर किए जाते हैं। एचएमएसी-SHA256 ताकि आप यह सत्यापित कर सकें कि यह DialerBee से आया है और इसमें कोई छेड़छाड़ नहीं की गई है। यदि आपका एंडपॉइंट डाउन है, तो वेबहुक 2 घंटे 35 मिनट तक एक्सपोनेंशियल बैकऑफ़ के साथ पुनः प्रयास करते हैं, जिससे यह सुनिश्चित होता है कि आप कोई भी इवेंट मिस न करें।
कॉल शुरू हो गई एक नई आउटबाउंड कॉल शुरू की गई है
कॉल का उत्तर दिया गया प्राप्तकर्ता ने इसे उठाया — एएमडी वर्गीकरण शामिल है
कॉल समाप्त हो गई कॉल अवधि, स्थिति और रिकॉर्डिंग यूआरएल के साथ पूरी हुई।
कॉल.एएमडी_परिणाम एएमडी वर्गीकरण परिणाम: मानव या मशीन, विश्वास स्कोर के साथ
एजेंट.स्टेट_चेंज एजेंट उपलब्ध, ऑन-कॉल, समापन या ऑफ़लाइन हो गया।
स्वभाव.सेट एजेंट ने परिणाम और टिप्पणियों सहित एक निपटान रिपोर्ट प्रस्तुत की।
अनुपालन.अवरुद्ध नियमों के विवरण के साथ अनुपालन इंजन द्वारा एक कॉल को ब्लॉक कर दिया गया था।
अभियान शुरू हुआ अभियान शुरू हो गया है।
अभियान.स्थगित अभियान पर्यवेक्षक या सिस्टम द्वारा रोक दिया गया
रिकॉर्डिंग तैयार कॉल रिकॉर्डिंग प्रोसेस हो चुकी है और प्लेबैक के लिए तैयार है।
संपर्क.डीएनसी_जोड़ा गया एक संपर्क को डीएनसी की प्रतिबंध सूची में जोड़ा गया है।
कॉलबैक.शेड्यूल्ड एजेंट ने संपर्क के लिए कॉल बैक शेड्यूल किया
उपयोग के मामले
कुछ भी बनाओ डायलरबी के ऊपर
सीआरएम सिंक
वेबहुक या एपीआई पोलिंग के माध्यम से डिस्पोजिशन, कॉल परिणाम और रिकॉर्डिंग लिंक को Salesforce, HubSpot, Zoho या किसी भी CRM में भेजें।
बीआई और डेटा वेयरहाउस
कॉल डेटा को अपने डेटा वेयरहाउस में एक्सपोर्ट करें। लुककर, टैब्लू, पॉवर बीआई या मेटाबेस में डैशबोर्ड बनाएं और निर्धारित समय पर रिपोर्ट एक्सपोर्ट करें।
कस्टम वर्कफ़्लो
कॉल इवेंट्स पर अपने सिस्टम में कार्रवाई शुरू करें — स्वचालित रूप से सपोर्ट टिकट बनाएं, लीड स्कोर अपडेट करें, स्लैक नोटिफिकेशन भेजें।
क्लिक-टू-कॉल
अपने CRM, हेल्पडेस्क या कस्टम एप्लिकेशन से क्लिक-टू-कॉल सुविधा जोड़ने के लिए कॉल ओरिजिनेशन एंडपॉइंट का उपयोग करें।
संपर्क सिंक
अपनी संपर्क सूचियों को अपने विश्वसनीय स्रोत के साथ सिंक्रनाइज़ रखें। CSV फ़ाइल अपलोड करें या API के माध्यम से व्यक्तिगत संपर्क भेजें।
अनुपालन स्वचालन
कॉल करने से पहले डीएनसी स्थिति की जांच करें, दमन सूचियों का प्रबंधन करें और अनुपालन ऑडिट लॉग को प्रोग्रामेटिक रूप से निर्यात करें।
हुड के नीचे
उन डेवलपर्स के लिए बनाया गया है जो उत्पाद लॉन्च करते हैं।
| शिष्टाचार | केवल HTTPS (TLS 1.2+) |
| प्रारूप | JSON अनुरोध और प्रतिक्रिया निकाय |
| प्रमाणीकरण | रिफ्रेश सुविधा के साथ JWT बियरर टोकन (24 घंटे की वैधता के साथ) |
| संस्करण | वेबहुक में /v1 URL पथ + स्कीमा_संस्करण |
| पृष्ठ पर अंक लगाना | कर्सर-आधारित, जिसमें next_cursor और has_more शामिल हैं। |
| दर सीमित करना | हेडर सहित प्रति किरायेदार 2,000 अनुरोध/मिनट |
| त्रुटि प्रारूप | HTTP API के लिए RFC 7807 समस्या विवरण |
| वेबहुक हस्ताक्षर | HMAC-SHA256 हस्ताक्षर सत्यापन |
| वेबहुक पुनः प्रयास | घातीय बैकऑफ़ (अधिकतम 2 घंटे 35 मिनट कुल) |
| रिकॉर्डिंग यूआरएल | MinIO के माध्यम से 1 घंटे की समय सीमा के साथ हस्ताक्षरित URL |
| डीएनसी रजिस्ट्रियां | यूएई (टीडीआरए), केएसए (सीआईटीसी), मिस्र (एनटीआरए), जॉर्डन (टीआरसी) |
| एसडीके | जावास्क्रिप्ट और पायथन (जल्द ही उपलब्ध होंगे) |
संबंधित विशेषताएं
व्हाइट-लेबल प्लेटफ़ॉर्म
किरायेदारों की उपलब्धता, ब्रांडिंग और बिलिंग के लिए पार्टनर एपीआई।
विश्लेषण और रिपोर्टिंग
एपीआई के माध्यम से रिपोर्ट डेटा को अपने बीआई टूल में निर्यात करें।
अपना सामान खुद लेकर आएं
एडमिन पैनल और एपीआई के माध्यम से एसआईपी ट्रंक का प्रबंधन।
एकीकरण
सीआरएम, मैसेजिंग और अन्य के लिए पहले से निर्मित कनेक्टर।
एपीआई के बारे में अक्सर पूछे जाने वाले प्रश्न
क्या एपीआई सभी प्लानों पर उपलब्ध है?
मुझे एपीआई संबंधी दस्तावेज़ कहाँ मिल सकते हैं?
वेबहुक प्रमाणीकरण कैसे काम करता है?
अगर मेरा वेबहुक एंडपॉइंट डाउन हो जाए तो क्या होगा?
क्या मैं API का उपयोग करके एक कस्टम एजेंट इंटरफ़ेस बना सकता हूँ?
क्या एपीआई मल्टी-टेनेंट है?
दर सीमा क्या है?
क्या SDK उपलब्ध हैं?
एकीकरण के लिए तैयार हैं?
लाइव API दस्तावेज़ देखें या डेमो बुक करें और API एक्सेस प्राप्त करें। अपना पहला इंटीग्रेशन हफ़्तों में नहीं, घंटों में बनाएं।