API اور ویب ہُکس

ڈائلر API اور webhooks: پروڈکشن کے لیے تیار، صرف روڈ میپ کا خیال نہیں۔

25+ REST اینڈ پوائنٹس، ریئل ٹائم ویب ہُکس، JWT تصدیق اور انٹرایکٹو دستاویزات۔ UI میں استعمال ہونے والی ہر خصوصیت API کے ذریعے بھی دستیاب ہے۔

API دستاویزات دیکھیں مفت ٹرائل شروع کریں

14 دن کا مفت ٹرائل · AI وائس ایجنٹ آزمانے کے لیے مفت AI کریڈٹ · کارڈ کی ضرورت نہیں

BroadNet کا تیار کردہ — ٹیلی کام میں 22 سال 11 زبانیں، لہجوں کی سمجھ کے ساتھ BYOC — آپ کے کیریئرز، کوئی پابندی نہیں تعمیل میں معاون (TCPA، GDPR، TDRA)

مختصر جواب

DialerBee API کیا ہے؟ DialerBee پروڈکشن کے لیے تیار REST API فراہم کرتا ہے جس کے 25+ اینڈ پوائنٹس کیمپینز، کانٹیکٹس، کالز، ایجنٹس، تعمیل، ریکارڈنگز، رپورٹس اور ویب ہُکس کا احاطہ کرتے ہیں۔ تصدیق JWT بیئرر ٹوکنز سے ہوتی ہے جن کی میعاد 24 گھنٹے ہے۔ 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 پر دستیاب ہیں۔

مسئلہ

زیادہ تر ڈائلر APIs بعد میں سوچی گئی چیز ہوتے ہیں

آپ نے کالز کرنے کے لیے ڈائلر خریدا۔ اب آپ کو اسے اپنے CRM سے جوڑنا ہے، ڈیٹا اپنے ویئر ہاؤس میں بھیجنا ہے، کال ایونٹس سے ورک فلوز چلانے ہیں اور حسبِ ضرورت ڈیش بورڈز بنانے ہیں۔ آپ وینڈر کی API دستاویزات دیکھتے ہیں اور ملتا ہے... 2019 کی ایک PDF جس میں 6 غیر دستاویزی اینڈ پوائنٹس ہیں، کوئی ویب ہُک نہیں، اور ایک SOAP انٹرفیس۔

زیادہ تر آؤٹ باؤنڈ ٹیموں کی یہی حقیقت ہے۔ کالز کرنے کے لیے ڈائلر ٹھیک کام کرتا ہے، لیکن جیسے ہی آپ کو ضرورت پڑتی ہے اس کے اوپر کچھ بنانے کی — ڈسپوزیشنز کو Salesforce سے ہم آہنگ کرنا، Zendesk میں خودکار ٹکٹ بنانا، اینالیٹکس کو اپنے BI ٹول میں بھیجنا، یا حسبِ ضرورت ایجنٹ انٹرفیس بنانا — آپ CSV ایکسپورٹس اور دستی عمل میں پھنس جاتے ہیں۔

DialerBee کو API-first بنایا گیا ہے۔ UI کی ہر خصوصیت اسی REST API پر چلتی ہے جسے آپ اپنے سسٹمز سے کال کر سکتے ہیں۔ API کوئی اضافی جوڑ نہیں — یہ وہ بنیاد ہے جس پر پورا پلیٹ فارم چلتا ہے۔

عام وینڈر اینڈ پوائنٹس

غیر دستاویزی، کوئی ویب ہُک نہیں

SOAP

پرانا پروٹوکول

بہت سے ڈائلرز اب بھی XML/SOAP استعمال کرتے ہیں

CSV

صرف ایکسپورٹ والا انٹیگریشن

دستی فائل منتقلی، ریئل ٹائم نہیں

یہ کیسے کام کرتا ہے

API-first ڈیزائن کے لحاظ سے

DialerBee کا API REST اصولوں پر چلتا ہے، JSON پے لوڈز، معیاری HTTP طریقوں اور RFC 7807 ایرر ریسپانسز کے ساتھ۔ تصدیق لاگ اِن اینڈ پوائنٹ سے حاصل کردہ JWT بیئرر ٹوکنز سے ہوتی ہے، جن کی میعاد 24 گھنٹے ہے اور ٹوکن ریفریش کی سہولت موجود ہے۔ ہر API ریسپانس میں ریٹ لمٹ ہیڈرز شامل ہوتے ہیں تاکہ آپ کا انٹیگریشن خود اپنی رفتار مناسب طریقے سے کم کر سکے۔

مرحلہ 01

تصدیق کریں

اسناد کے ساتھ /v1/login پر POST کریں۔ 24 گھنٹے کے لیے کارآمد JWT بیئرر ٹوکن حاصل کریں۔ طویل چلنے والے انٹیگریشنز کے لیے ٹوکن ریفریش استعمال کریں۔

مرحلہ 02

اینڈ پوائنٹس کال کریں

کیمپینز، کانٹیکٹس، کالز، ایجنٹس، تعمیل، ریکارڈنگز اور رپورٹس کے لیے 25+ RESTful اینڈ پوائنٹس۔ JSON اندر، JSON باہر۔

مرحلہ 03

ویب ہُکس وصول کریں

ریئل ٹائم ایونٹس وصول کرنے کے لیے ویب ہُک URLs رجسٹر کریں۔ ہر پے لوڈ HMAC-SHA256 سے دستخط شدہ ہوتا ہے تاکہ آپ اس کی صداقت کی تصدیق کر سکیں۔

مرحلہ 04

ایررز سنبھالیں

ہر ایرر کے لیے RFC 7807 Problem Details۔ ہر ریسپانس میں ریٹ لمٹ ہیڈرز۔ retry-after رہنمائی کے ساتھ 429 اسٹیٹس۔

تقابلی جائزہ

DialerBee API بمقابلہ عام ڈائلر APIs

صلاحیت	عام ڈائلر API	DialerBee API
اینڈ پوائنٹس	5-10، جزوی طور پر دستاویزی	25+، OpenAPI اسپیک کے ساتھ مکمل دستاویزی
پروٹوکول	SOAP/XML یا ملکیتی	JSON کے ساتھ REST، RFC 7807 ایررز
Authentication	API کی (کبھی ختم نہیں ہوتی)	24 گھنٹے کی میعاد والا JWT + ٹوکن ریفریش
ریئل ٹائم ایونٹس	پولنگ یا کچھ نہیں	ری ٹرائی کے ساتھ HMAC-SHA256 دستخط شدہ ویب ہُکس
پیجینیشن	آفسیٹ پر مبنی یا کچھ نہیں	next_cursor + has_more کے ساتھ کرسر پر مبنی
ریٹ لمٹنگ	غیر دستاویزی	2,000 درخواستیں/منٹ، ہر ریسپانس میں ہیڈرز کے ساتھ
دستاویزات	PDF یا پرانی وکی	لائیو انٹرایکٹو Swagger دستاویزات
ملٹی ٹیننٹ	صرف سنگل ٹیننٹ	ہر اینڈ پوائنٹ پر فی ٹیننٹ اسکوپنگ

اینڈ پوائنٹ ریفرنس

10 API گروپس۔ 25+ اینڈ پوائنٹس۔

API گروپ	اینڈ پوائنٹس	آپ کیا کر سکتے ہیں
Authentication	POST /login, POST /refresh	JWT بیئرر ٹوکنز حاصل اور ریفریش کریں
کیمپینز	CRUD + شروع/موقوف	کیمپینز بنائیں، ترتیب دیں، شروع کریں، موقوف کریں اور منظم کریں
کانٹیکٹس	اپ لوڈ، فہرست، تلاش	بلک CSV اپ لوڈ، تلاش، فلٹر اور کانٹیکٹ لسٹس کا انتظام
کالز	ہسٹری، لائیو گنتی، کال شروع کرنا	کال ہسٹری تلاش کریں، لائیو کالز کی گنتی حاصل کریں، کالز شروع کریں
ایجنٹس	اسٹیٹ، SIP رجسٹریشن	ایجنٹ کی دستیابی کا انتظام کریں، SIP رجسٹریشن اسٹیٹس کی نگرانی کریں
تعمیل اور DNC	ڈائل سے پہلے کی جانچ، DNC لسٹس	نمبروں کو DNC رجسٹریز سے جانچیں، سپریشن لسٹس کا انتظام کریں
ریکارڈنگز	فہرست، دستخط شدہ پلے بیک URLs	ریکارڈنگز کی فہرست دیکھیں، محدود وقت کے دستخط شدہ پلے بیک URLs بنائیں
رپورٹس	ایکسپورٹ (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 APIs کے لیے RFC 7807 Problem Details
ویب ہُک سائننگ	HMAC-SHA256 دستخط کی تصدیق
ویب ہُک ری ٹرائیز	ایکسپونینشل بیک آف (کُل زیادہ سے زیادہ 2 گھنٹے 35 منٹ)
ریکارڈنگ URLs	MinIO کے ذریعے 1 گھنٹے کی میعاد والے دستخط شدہ URLs
DNC رجسٹریز	متحدہ عرب امارات (TDRA)، سعودی عرب (CST)، مصر (NTRA)، اردن (TRC)
SDKs	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 اسٹیٹس ملے گا۔

کیا SDKs دستیاب ہیں؟

JavaScript اور Python SDKs تیاری کے مراحل میں ہیں۔ اس دوران API JSON پے لوڈز کے ساتھ معیاری REST اصولوں پر چلتا ہے، اس لیے کسی بھی زبان کا کوئی بھی HTTP کلائنٹ کام کرتا ہے۔ انٹرایکٹو دستاویزات میں ہر اینڈ پوائنٹ کے لیے curl مثالیں شامل ہیں۔

جانیں کہ آپ کس چیز کو سبسکرائب کر سکتے ہیں

ہر ایونٹ آپ کے کچھ بنانے سے پہلے دستاویزی ہے

پلیٹ فارم کال پر ہونے والی ہر اہم چیز کے لیے ایک ایونٹ شائع کرتا ہے، اور ہر ایونٹ اپنے پے لوڈ کی ساخت کے ساتھ درج ہے — تاکہ ہینڈلر لکھنے سے پہلے آپ جانتے ہوں کہ ویب ہُک میں کیا ہوگا، بجائے اس کے کہ جو پہلے پہنچے اسی سے اسکیما معلوم کریں۔

کال کا لائف سائیکل، کیمپین کی حالت، ایجنٹ کی سرگرمی، ڈسپوزیشن، ریکارڈنگ کی دستیابی، تعمیل کے فیصلے اور میسج کی ترسیل — ہر ایک اپنے ایونٹس شائع کرتا ہے۔ جن ایونٹس کی آپ کے انٹیگریشن کو ضرورت ہے انہیں سبسکرائب کریں اور باقی کو نظرانداز کریں — تین مطلوبہ ایونٹس کے لیے آپ کو ایونٹس کا پورا سیلاب لینے کی ضرورت نہیں۔

انٹیگریٹ کرنے کے لیے تیار ہیں؟

لائیو API دستاویزات دیکھیں یا ڈیمو بک کر کے API رسائی حاصل کریں۔ اپنا پہلا انٹیگریشن ہفتوں نہیں، گھنٹوں میں بنائیں۔

API دستاویزات دیکھیں ڈیمو بُک کریں مفت ٹرائل شروع کریں

14 دن کا مفت ٹرائل · مفت AI کریڈٹ · کارڈ کے بغیر · قیمتیں دیکھیں