API اور ویب ہکس

پیداوار کے لیے تیار API۔ روڈ میپ سلائیڈ نہیں ہے۔

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

API دستاویزات دیکھیں API رسائی حاصل کریں۔

فوری جواب

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

مسئلہ

زیادہ تر ڈائلر APIs ہیں۔ ایک بعد کی سوچ

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

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

ڈائلر بی کو پہلے API بنایا گیا تھا۔ UI میں موجود ہر خصوصیت کو اسی REST API کی حمایت حاصل ہے جسے آپ اپنے سسٹم سے کال کر سکتے ہیں۔ API بولٹ آن نہیں ہے - یہ وہ بنیاد ہے جس پر پورا پلیٹ فارم چلتا ہے۔

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

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

صابن

میراثی پروٹوکول

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

CSV

صرف برآمدی انضمام

دستی فائل ٹرانسفر، کوئی ریئل ٹائم نہیں۔

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

API- پہلے ڈیزائن کی طرف سے

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

مرحلہ 01

تصدیق کریں۔

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

مرحلہ 02

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

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

مرحلہ 03

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

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

مرحلہ 04

غلطیوں کو ہینڈل کریں۔

ہر خرابی کے لیے RFC 7807 مسئلے کی تفصیلات۔ ہر جواب میں ریٹ کی حد ہیڈر۔ رہنمائی کے بعد دوبارہ کوشش کے ساتھ 429 اسٹیٹس۔

پہلو بہ پہلو موازنہ

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

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

اختتامی حوالہ

10 API گروپس۔ 25+ اختتامی پوائنٹس۔

API گروپ	اینڈ پوائنٹس	آپ کیا کر سکتے ہیں
تصدیق	پوسٹ/لاگ ان، پوسٹ/ریفریش	JWT بیئرر ٹوکن حاصل کریں اور ریفریش کریں۔
مہمات	CRUD + شروع/توقف	مہمات بنائیں، ترتیب دیں، شروع کریں، روکیں اور ان کا نظم کریں۔
رابطے	اپ لوڈ کریں، فہرست کریں، تلاش کریں۔	بلک CSV اپ لوڈ کریں، تلاش کریں، فلٹر کریں، اور رابطہ فہرستوں کا نظم کریں۔
کالز	تاریخ، زندہ شمار، ابتداء	کال کی سرگزشت کے بارے میں سوال کریں، لائیو کال کی گنتی حاصل کریں، کال شروع کریں۔
ایجنٹس	ریاست، ایس آئی پی رجسٹریشن	ایجنٹ کی دستیابی کا نظم کریں، SIP رجسٹریشن کی حیثیت کی نگرانی کریں۔
تعمیل اور DNC	پری ڈائل چیک، DNC فہرستیں۔	DNC رجسٹریوں کے خلاف نمبر چیک کریں، دبانے کی فہرستوں کا نظم کریں۔
ریکارڈنگز	فہرست، دستخط شدہ پلے بیک URLs	ریکارڈنگ کی فہرست بنائیں، وقت کے لیے محدود دستخط شدہ پلے بیک URLs بنائیں
رپورٹس	برآمد کریں (CSV, JSON, PDF)	متعدد فارمیٹس میں مہم، ایجنٹ اور تعمیل کی رپورٹیں برآمد کریں۔
ویب ہکس	سبسکرائب کریں، انتظام کریں، تصدیق کریں۔	ویب ہک اینڈ پوائنٹس رجسٹر کریں، سبسکرپشنز کا نظم کریں، دستخطوں کی تصدیق کریں۔
سسٹم	صحت، ورژن	پلیٹ فارم ہیلتھ چیکس اور API ورژن کی معلومات

مکمل انٹرایکٹو API دستاویزات دیکھیں

فوری آغاز

تصدیق کریں اور ڈائل کرنا شروع کریں۔ 3 API کالز میں

مرحلہ 1 تصدیق کریں۔

پوسٹ /v1/login
مواد کی قسم: درخواست/json

{
  "ای میل": "admin@yourcompany.com",
  "پاس ورڈ": "••••••••"
}

→ جواب: { "ٹوکن": "eyJhbG...", "ایکسپائر_میں": 86400 }

مرحلہ 2 ایک مہم بنائیں

پوسٹ /v1/ مہمات
اجازت: بیئرر eyJhbG...

{
  "نام": "Q3 کے مجموعے",
  "موڈ": "ترقی پسند",
  "amd_enabled": true,
  "تعمیل_پروفائل": "uae-tdra"
}

مرحلہ 3 رابطے اپ لوڈ کریں اور شروع کریں۔

پوسٹ /v1/compaigns/{id}/رابطے۔
مواد کی قسم: ملٹی پارٹ/فارم ڈیٹا

→ فون، نام، اور حسب ضرورت فیلڈز کے ساتھ CSV اپ لوڈ کریں۔

پوسٹ /v1/compaigns/{id}/start
→ مہم اب ڈائل ہو رہی ہے۔

ویب ہکس

ریئل ٹائم ایونٹس آپ کے سسٹمز تک پہنچایا

ویب ہکس آپ کے سسٹمز کو حقیقی وقت میں ایونٹس فراہم کرتے ہیں — پولنگ کی ضرورت نہیں ہے۔ ہر ویب ہک پے لوڈ کے ساتھ دستخط کیے گئے ہیں۔ HMAC-SHA256 تاکہ آپ تصدیق کر سکیں کہ یہ ڈائلر بی سے آیا ہے اور اس کے ساتھ چھیڑ چھاڑ نہیں کی گئی۔ اگر آپ کا اختتامی نقطہ نیچے ہے تو، ویب ہکس ایکسپونیشنل بیک آف کے ساتھ 2 گھنٹے 35 منٹ تک دوبارہ کوشش کرتے ہیں، اس بات کو یقینی بناتے ہوئے کہ آپ کسی ایونٹ سے محروم نہ ہوں۔

کال شروع ہوئی۔

ایک نئی آؤٹ باؤنڈ کال شروع کر دی گئی ہے۔

کال.جواب دیا

وصول کنندہ نے اٹھایا — AMD کی درجہ بندی شامل ہے۔

call.ended

دورانیہ، ترتیب، اور ریکارڈنگ URL کے ساتھ کال مکمل ہوئی۔

call.amd_result

AMD درجہ بندی کا نتیجہ: انسان یا مشین، اعتماد کے اسکور کے ساتھ

agent.state_change

ایجنٹ دستیاب تھا، آن کال، ریپ اپ، یا آف لائن

disposition.set

ایجنٹ نے نتیجہ اور نوٹ کے ساتھ ایک ڈسپوزیشن جمع کرائی

compliance.blocked

قواعد کی تفصیلات کے ساتھ تعمیل انجن کے ذریعہ ایک کال کو بلاک کر دیا گیا تھا۔

مہم شروع ہوئی۔

مہم ڈائل کرنے لگی

مہم روک دی گئی۔

مہم سپروائزر یا سسٹم کے ذریعے روکی گئی۔

ریکارڈنگ.تیار

کال ریکارڈنگ پر کارروائی کی گئی ہے اور پلے بیک کے لیے تیار ہے۔

contact.dnc_added

ایک رابطہ DNC دبانے کی فہرست میں شامل کیا گیا تھا۔

callback.scheduled

ایجنٹ نے ایک رابطہ کے لیے کال بیک شیڈول کیا۔

کیسز استعمال کریں۔

کچھ بھی بنائیں ڈائلر بی کے اوپر

CRM مطابقت پذیری۔

سیلز فورس، ہب اسپاٹ، زوہو، یا ویب ہکس یا API پولنگ کے ذریعے کسی بھی CRM میں ڈسپوزیشنز، کال کے نتائج، اور ریکارڈنگ لنکس کو پش کریں۔

BI اور ڈیٹا گودام

اپنے گودام میں کال ڈیٹا ایکسپورٹ کریں۔ لائکر، ٹیبلو، پاور BI، یا میٹا بیس میں شیڈول رپورٹ کی برآمدات کے ساتھ ڈیش بورڈز بنائیں۔

حسب ضرورت ورک فلوز

کال ایونٹس پر اپنے سسٹمز میں کارروائیوں کو متحرک کریں — خودکار طور پر سپورٹ ٹکٹ بنائیں، لیڈ اسکورز کو اپ ڈیٹ کریں، Slack اطلاعات بھیجیں۔

کال کرنے کے لیے کلک کریں۔

اپنے CRM، ہیلپ ڈیسک، یا حسب ضرورت ایپلیکیشن سے کلک ٹو کال شامل کرنے کے لیے کال اوریجینیشن اینڈ پوائنٹ کا استعمال کریں۔

ہم آہنگی سے رابطہ کریں۔

رابطے کی فہرستوں کو اپنی سچائی کے ماخذ کے ساتھ ہم آہنگ رکھیں۔ CSV کے ذریعے اپ لوڈ کریں یا API کے ذریعے انفرادی رابطوں کو پش کریں۔

تعمیل آٹومیشن

کالز سے پہلے DNC کی حیثیت سے استفسار کریں، دبانے کی فہرستوں کا نظم کریں، اور پروگرام کے مطابق تعمیل آڈٹ لاگز برآمد کریں۔

ہڈ کے نیچے

جہاز بھیجنے والے ڈویلپرز کے لیے بنایا گیا ہے۔

پروٹوکول	صرف HTTPS (TLS 1.2+)
فارمیٹ	JSON درخواست اور رسپانس باڈیز
تصدیق	JWT بیئرر ٹوکن (24 گھنٹے ایکسپائری) ریفریش کے ساتھ
ورژننگ	ویب ہکس میں /v1 URL پاتھ + schema_version
صفحہ بندی	Next_cursor اور has_more کے ساتھ کرسر پر مبنی
شرح کو محدود کرنا	ہیڈرز کے ساتھ فی کرایہ دار 2,000 درخواستیں/ منٹ
خرابی کی شکل	HTTP APIs کے لیے RFC 7807 مسئلے کی تفصیلات
ویب ہک پر دستخط کرنا	HMAC-SHA256 دستخط کی تصدیق
ویب ہُک کی دوبارہ کوششیں	ایکسپونیشنل بیک آف (زیادہ سے زیادہ 2h 35m کل)
ریکارڈنگ یو آر ایل	MinIO کے ذریعے 1 گھنٹے کی میعاد کے ساتھ دستخط شدہ URLs
DNC رجسٹریاں	UAE (TDRA)، KSA (CITC)، مصر (NTRA)، اردن (TRC)
SDKs	جاوا اسکرپٹ اور ازگر (جلد آرہا ہے)

API کے بارے میں اکثر پوچھے گئے سوالات

کیا API تمام منصوبوں پر دستیاب ہے؟

REST API رسائی تمام منصوبوں پر دستیاب ہے۔ سٹارٹر پلانز میں API کا دائرہ محدود ہوتا ہے (کچھ اینڈ پوائنٹس کے لیے صرف پڑھنے کے لیے)۔ پیشہ ورانہ اور انٹرپرائز کے منصوبوں میں رائٹ آپریشنز، ویب ہکس، اور اعلی شرح کی حدوں کے ساتھ مکمل API رسائی شامل ہے۔

میں API دستاویزات کہاں سے حاصل کرسکتا ہوں؟

انٹرایکٹو API دستاویزات dialer.broadnet.me/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 ہیڈر شامل ہیں۔ اگر آپ حد سے تجاوز کرتے ہیں، تو آپ کو دوبارہ کوشش کے بعد ہیڈر کے ساتھ 429 اسٹیٹس ملے گا۔

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

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

انضمام کے لیے تیار ہیں؟

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

API دستاویزات دیکھیں بک ڈیمو