API और वेबहुक

उत्पादन के लिए तैयार API। यह रोडमैप स्लाइड नहीं है।

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

API दस्तावेज़ देखें फ़्री ट्रायल शुरू करें

14 दिन का निःशुल्क परीक्षण · क्रेडिट कार्ड की आवश्यकता नहीं

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

त्वरित उत्तर

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 कोई अतिरिक्त सुविधा नहीं है — यह संपूर्ण प्लेटफ़ॉर्म का आधार है।

विशिष्ट विक्रेता एंडपॉइंट

अज्ञात, कोई वेबहुक नहीं

साबुन

विरासत प्रोटोकॉल

कई डायलर अभी भी XML/SOAP का उपयोग करते हैं।

सीएसवी

केवल निर्यात एकीकरण

मैन्युअल फ़ाइल स्थानांतरण, कोई रीयल-टाइम सुविधा नहीं।

यह काम किस प्रकार करता है

API-प्रथम डिजाइन द्वारा

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

चरण 01

प्रमाणित

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

चरण 02

कॉल एंडपॉइंट्स

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

चरण 03

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

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

चरण 04

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

RFC 7807 के अनुसार प्रत्येक त्रुटि का समस्या विवरण। प्रत्येक प्रतिक्रिया में दर सीमा हेडर। पुनः प्रयास करने के निर्देश के साथ 429 स्थिति।

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

DialerBee API बनाम विशिष्ट डायलर एपीआई

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

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

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

API समूह	अंतिमबिंदुओं	आप क्या कर सकते हैं
प्रमाणीकरण	POST /login, POST /refresh	JWT बियरर टोकन प्राप्त करें और रीफ्रेश करें
अभियान	CRUD + प्रारंभ/विराम	कैंपेन बनाएं, कॉन्फ़िगर करें, शुरू करें, रोकें और प्रबंधित करें
संपर्क	अपलोड करें, सूची बनाएं, खोजें	बल्क सीएसवी अपलोड करें, खोजें, फ़िल्टर करें और संपर्क सूचियों का प्रबंधन करें
कॉल	इतिहास, जीवन गणना, उत्पत्ति	कॉल हिस्ट्री देखें, लाइव कॉल की संख्या जानें, कॉल शुरू करें
एजेंटों	राज्य, SIP पंजीकरण	एजेंट की उपलब्धता प्रबंधित करें, SIP पंजीकरण स्थिति की निगरानी करें
अनुपालन एवं DNC	प्री-डायल चेक, DNC सूचियाँ	DNC रजिस्ट्रियों के विरुद्ध संख्याओं की जाँच करें, दमन सूचियों का प्रबंधन करें
रिकॉर्डिंग	हस्ताक्षरित प्लेबैक यूआरएल की सूची	रिकॉर्डिंग की सूची बनाएं, समय-सीमित हस्ताक्षरित प्लेबैक यूआरएल जेनरेट करें
रिपोर्टों	निर्यात करें (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 }

चरण दो एक अभियान बनाएं

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

वेबहुक

वास्तविक समय की घटनाएँ आपके सिस्टम पर डिलीवर किया गया

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

call.started

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

call.answered

प्राप्तकर्ता ने इसे उठाया — AMD वर्गीकरण शामिल है

call.ended

कॉल अवधि, स्थिति और रिकॉर्डिंग यूआरएल के साथ पूरी हुई।

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 में भेजें।

बीआई और डेटा वेयरहाउस

कॉल डेटा को अपने डेटा वेयरहाउस में एक्सपोर्ट करें। लुककर, टैब्लू, पॉवर बीआई या मेटाबेस में डैशबोर्ड बनाएं और निर्धारित समय पर रिपोर्ट एक्सपोर्ट करें।

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

कॉल इवेंट्स पर अपने सिस्टम में कार्रवाई शुरू करें — स्वचालित रूप से सपोर्ट टिकट बनाएं, लीड स्कोर अपडेट करें, स्लैक नोटिफिकेशन भेजें।

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

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

संपर्क सिंक

अपनी संपर्क सूचियों को अपने विश्वसनीय स्रोत के साथ सिंक्रनाइज़ रखें। CSV फ़ाइल अपलोड करें या API के माध्यम से व्यक्तिगत संपर्क भेजें।

अनुपालन स्वचालन

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

हुड के नीचे

उन डेवलपर्स के लिए बनाया गया है जो उत्पाद लॉन्च करते हैं।

शिष्टाचार	केवल 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
DNC रजिस्ट्रियां	यूएई (TDRA), केएसए (CITC), मिस्र (NTRA), जॉर्डन (TRC)
एसडीके	जावास्क्रिप्ट और पायथन (जल्द ही उपलब्ध होंगे)

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

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

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

मुझे API दस्तावेज़ कहाँ मिल सकते हैं?

डायलर.ब्रॉडनेट.मी/एडमिन/एपीआई-डॉक.html पर इंटरैक्टिव API दस्तावेज़ उपलब्ध है। इसमें एंडपॉइंट विवरण, अनुरोध/प्रतिक्रिया के उदाहरण, प्रमाणीकरण मार्गदर्शिकाएँ और एक लाइव API एक्सप्लोरर शामिल है जहाँ आप सीधे कॉल का परीक्षण कर सकते हैं।

वेबहुक प्रमाणीकरण कैसे काम करता है?

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

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

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

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

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

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

जी हां। प्रत्येक API कॉल प्रमाणित टेनेंट तक ही सीमित होती है। पार्टनर/रीसेलर खाते पार्टनर API के माध्यम से कई टेनेंट का प्रबंधन कर सकते हैं, जिसमें टेनेंट प्रोविजनिंग, कॉन्फ़िगरेशन और बिलिंग प्रबंधन शामिल हैं।

दर सीमा क्या है?

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

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

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

जानें कि आप किसकी सदस्यता ले सकते हैं

हर आयोजन निर्माण से पहले दस्तावेज़ तैयार करें

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

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

एकीकरण के लिए तैयार हैं?

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

API दस्तावेज़ देखें डेमो बुक करें फ़्री ट्रायल शुरू करें

14 दिन का निःशुल्क परीक्षण · क्रेडिट कार्ड की आवश्यकता नहीं · मूल्य निर्धारण देखें