واجهة برمجة التطبيقات وخطافات الويب
واجهة برمجة تطبيقات جاهزة للإنتاج. ليست شريحة لخارطة طريق.
أكثر من 25 نقطة نهاية REST، وخطافات ويب فورية، ومصادقة JWT، ووثائق تفاعلية. كل ميزة تستخدمها في واجهة المستخدم متاحة عبر واجهة برمجة التطبيقات (API).
إجابة سريعة
ما هي واجهة برمجة تطبيقات DialerBee؟ توفر DialerBee واجهة برمجة تطبيقات REST جاهزة للاستخدام في بيئات الإنتاج، مع أكثر من 25 نقطة نهاية تغطي الحملات، وجهات الاتصال، والمكالمات، والوكلاء، والامتثال، والتسجيلات، والتقارير، وخطافات الويب. تستخدم المصادقة رموز JWT المميزة التي تنتهي صلاحيتها خلال 24 ساعة. تدعم واجهة برمجة التطبيقات التصفح القائم على المؤشر، وتُرجع استجابات خطأ RFC 7807، وتفرض حدًا أقصى قدره 2000 طلب/دقيقة لكل مستخدم. تُرسل خطافات الويب في الوقت الفعلي الأحداث (call.started، call.answered، call.amd_result، disposition.set، compliance.blocked، إلخ) مع التحقق من التوقيع باستخدام HMAC-SHA256 وتراجع إعادة المحاولة الأسي. تتوفر وثائق واجهة برمجة التطبيقات التفاعلية على الرابط dialer.broadnet.me/admin/api-docs.html.
المشكلة
معظم واجهات برمجة تطبيقات الاتصال هي فكرة لاحقة
اشتريتَ برنامج اتصال لإجراء المكالمات. الآن تحتاج إلى دمجه مع نظام إدارة علاقات العملاء (CRM)، وإرسال البيانات إلى مستودع البيانات، وتفعيل سير العمل بناءً على أحداث المكالمات، وإنشاء لوحات تحكم مخصصة. تراجع وثائق واجهة برمجة التطبيقات (API) الخاصة بالمورد، فتجد... ملف PDF من عام ٢٠١٩ يحتوي على ٦ نقاط نهاية غير موثقة، ولا يحتوي على روابط ويب، وواجهة SOAP.
هذا هو الواقع بالنسبة لمعظم فرق التسويق الخارجي. يعمل نظام الاتصال بشكل جيد لإجراء المكالمات، ولكن في اللحظة التي تحتاج فيها إلى قم بالبناء فوق ذلك — مزامنة الترتيبات مع Salesforce، وإنشاء التذاكر تلقائيًا في Zendesk، ودفع التحليلات إلى أداة ذكاء الأعمال الخاصة بك، أو بناء واجهة وكيل مخصصة — أنت عالق مع عمليات تصدير CSV والعمليات اليدوية.
تم تصميم DialerBee وفقًا لمنهجية API. كل ميزة في واجهة المستخدم مدعومة بنفس واجهة برمجة تطبيقات REST التي يمكنك استدعاؤها من أنظمتك الخاصة. واجهة برمجة التطبيقات ليست إضافة ثانوية، بل هي الأساس الذي تقوم عليه المنصة بأكملها.
كيف يعمل
واجهة برمجة التطبيقات أولاً عن طريق التصميم
تتبع واجهة برمجة تطبيقات DialerBee معايير REST مع حمولات JSON، وطرق HTTP القياسية، واستجابات أخطاء RFC 7807. تستخدم المصادقة رموز JWT المميزة التي يتم الحصول عليها عبر نقطة نهاية تسجيل الدخول، مع دعم صلاحية الرمز المميز لمدة 24 ساعة وإمكانية تجديده. يتضمن كل رد من واجهة برمجة التطبيقات رؤوسًا لتحديد معدل الطلبات، مما يسمح لتكاملك بالتحكم الذاتي في معدل الطلبات بسلاسة.
المصادقة
أرسل طلب POST إلى /v1/login باستخدام بيانات الاعتماد. ستتلقى رمز JWT صالحًا لمدة 24 ساعة. استخدم خاصية تحديث الرمز المميز لعمليات التكامل طويلة الأمد.
نقاط نهاية الاتصال
أكثر من 25 نقطة نهاية RESTful للحملات، وجهات الاتصال، والمكالمات، والوكلاء، والامتثال، والتسجيلات، والتقارير. مدخلات ومخرجات JSON.
استلام روابط الويب
سجّل عناوين URL الخاصة بخطافات الويب لتلقّي الأحداث في الوقت الفعلي. يتم توقيع كل حمولة بيانات باستخدام HMAC-SHA256، ما يُمكّنك من التحقق من صحتها.
معالجة الأخطاء
تفاصيل المشكلة لكل خطأ (RFC 7807). رؤوس تحديد معدل الاستجابة في كل رد. حالة 429 مع توجيهات لإعادة المحاولة بعد ذلك.
مقارنة جنبًا إلى جنب
واجهة برمجة تطبيقات DialerBee مقابل واجهات برمجة تطبيقات الاتصال النموذجية
| القدرة | واجهة برمجة تطبيقات الاتصال النموذجية | واجهة برمجة تطبيقات DialerBee |
|---|---|---|
| نقاط النهاية | 5-10، موثقة جزئياً | أكثر من 25 موثق بالكامل وفقًا لمواصفات OpenAPI |
| بروتوكول | SOAP/XML أو خاص | REST مع JSON، أخطاء RFC 7807 |
| المصادقة | مفتاح API (لا تنتهي صلاحيته أبدًا) | رمز JWT بصلاحية 24 ساعة + تحديث الرمز |
| أحداث في الوقت الفعلي | استطلاع رأي أو عدمه | روابط الويب الموقعة باستخدام HMAC-SHA256 مع إعادة المحاولة |
| ترقيم الصفحات | قائم على الإزاحة أو لا شيء | يعتمد على المؤشر مع next_cursor + has_more |
| تحديد معدل الاستخدام | غير موثق | 2000 طلب/دقيقة مع تضمين العناوين في كل استجابة |
| الوثائق | ملف PDF أو ويكي قديم | وثائق Swagger التفاعلية المباشرة |
| متعدد المستأجرين | للمستأجر الواحد فقط | تحديد النطاق لكل مستأجر على كل نقطة نهاية |
مرجع نقطة النهاية
10 مجموعات واجهة برمجة التطبيقات (API). أكثر من 25 نقطة نهاية.
| مجموعة API | نقاط النهاية |
|---|---|
| المصادقة | POST /login, POST /refresh |
| الحملات | عمليات CRUD + بدء/إيقاف مؤقت |
| جهات الاتصال | تحميل، عرض القوائم، البحث |
| المكالمات | التاريخ، الأرواح لها قيمتها، الأصل |
| الوكلاء | الولاية، تسجيل SIP |
| الامتثال وعدم الإزعاج | التحقق المسبق من المكالمات، وقوائم عدم الاتصال |
| التسجيلات | قائمة عناوين URL للتشغيل الموقعة |
| التقارير | تصدير (CSV، JSON، PDF) |
| روابط الويب | اشترك، إدارة، تحقق |
| نظام | الصحة، الإصدار |
بداية سريعة
قم بالمصادقة وابدأ الاتصال في 3 استدعاءات لواجهة برمجة التطبيقات
بريد /v1/تسجيل الدخول
نوع المحتوى: تطبيق/json
{
"بريد إلكتروني": "admin@yourcompany.com",
"كلمة المرور": "••••••••"
}
→ الرد: { "رمزي": "eyJhbG...", "expires_in": 86400 }بريد /v1/campaigns
التفويض: حامل البطاقة eyJhbG...
{
"اسم": "مجموعات الربع الثالث",
"وضع": "تقدمي",
"amd_enabled": true,
"ملف_الامتثال": "uae-tdra"
}بريد /v1/campaigns/{id}/contacts
نوع المحتوى: multipart/form-data
→ قم بتحميل ملف CSV يحتوي على رقم الهاتف والاسم والحقول المخصصة
بريد /v1/campaigns/{id}/start
→ الحملة تتصل الآنروابط الويب
أحداث في الوقت الفعلي يتم تسليمها إلى أنظمتك
تُرسل Webhooks الأحداث إلى أنظمتك في الوقت الفعلي - دون الحاجة إلى الاستقصاء. يتم توقيع كل حمولة Webhook باستخدام HMAC-SHA256 حتى تتمكن من التحقق من أنها صادرة من DialerBee ولم يتم التلاعب بها. في حال تعطل نقطة النهاية، ستعيد Webhooks المحاولة مع تأخير زمني متزايد لمدة تصل إلى ساعتين و35 دقيقة، مما يضمن عدم تفويت أي حدث.
بدأ الاتصال تم بدء مكالمة صادرة جديدة
تم الرد على المكالمة استلم المستلم الطلب - تم تضمين تصنيف AMD
انتهت المكالمة تم الانتهاء من المكالمة مع تحديد المدة والنتيجة ورابط التسجيل
call.amd_result نتيجة تصنيف AMD: إنسان أو آلة، مع درجة الثقة
agent.state_change كان الوكيل متاحًا، أو على أهبة الاستعداد، أو في مرحلة إنهاء المكالمة، أو غير متصل بالإنترنت.
disposition.set قدّم الوكيل تقريرًا بالنتيجة والملاحظات.
الامتثال. محظور تم حظر المكالمة بواسطة نظام الامتثال مع تفاصيل القاعدة
بدأت الحملة بدأت الحملة بالاتصال
الحملة متوقفة مؤقتًا تم إيقاف الحملة مؤقتًا من قبل المشرف أو النظام
التسجيل جاهز تمت معالجة تسجيل المكالمة وهو جاهز للتشغيل
contact.dnc_added تمت إضافة جهة اتصال إلى قائمة حظر الاتصال بالحزب الديمقراطي
callback.scheduled قام الموظف بجدولة معاودة الاتصال بأحد جهات الاتصال
حالات الاستخدام
ابنِ أي شيء بالإضافة إلى DialerBee
مزامنة نظام إدارة علاقات العملاء
قم بدفع معلومات الترتيبات ونتائج المكالمات وروابط التسجيل إلى Salesforce أو HubSpot أو Zoho أو أي نظام إدارة علاقات العملاء عبر webhooks أو استطلاع API.
ذكاء الأعمال ومستودع البيانات
قم بتصدير بيانات المكالمات إلى مستودع البيانات الخاص بك. أنشئ لوحات معلومات في Looker أو Tableau أو Power BI أو Metabase مع تصدير التقارير المجدولة.
سير العمل المخصص
قم بتشغيل الإجراءات في أنظمتك عند وقوع أحداث المكالمات - إنشاء تذاكر الدعم تلقائيًا، وتحديث نقاط العملاء المحتملين، وإرسال إشعارات Slack.
انقر للاتصال
استخدم نقطة نهاية بدء المكالمة لإضافة ميزة النقر للاتصال من نظام إدارة علاقات العملاء (CRM) أو مكتب المساعدة أو التطبيق المخصص الخاص بك.
مزامنة جهات الاتصال
حافظ على مزامنة قوائم جهات الاتصال مع مصدر البيانات الموثوق. حمّلها عبر ملف CSV أو أرسل جهات الاتصال الفردية عبر واجهة برمجة التطبيقات (API).
أتمتة الامتثال
استعلم عن حالة DNC قبل المكالمات، وقم بإدارة قوائم الحظر، وقم بتصدير سجلات تدقيق الامتثال برمجيًا.
تحت غطاء المحرك
مصمم للمطورين الذين يقومون بإصدار المنتجات
| بروتوكول | بروتوكول HTTPS فقط (TLS 1.2+) |
| شكل | بيانات طلب واستجابة JSON |
| المصادقة | رموز JWT Bearer (صلاحية 24 ساعة) مع إمكانية التحديث |
| التحكم في الإصدارات | مسار عنوان URL /v1 + إصدار المخطط في خطافات الويب |
| ترقيم الصفحات | يعتمد على المؤشر مع next_cursor و has_more |
| تحديد معدل الاستخدام | 2000 طلب/دقيقة لكل مستأجر مع رؤوس الطلبات |
| تنسيق الخطأ | تفاصيل المشكلة المتعلقة بواجهات برمجة تطبيقات HTTP وفقًا لـ RFC 7807 |
| توقيع Webhook | التحقق من التوقيع باستخدام HMAC-SHA256 |
| إعادة محاولات Webhook | التراجع الأسي (بحد أقصى ساعتين و35 دقيقة إجمالاً) |
| روابط التسجيل | عناوين URL موقعة بصلاحية ساعة واحدة عبر MinIO |
| سجلات عدم الاتصال | الإمارات العربية المتحدة (TDRA)، المملكة العربية السعودية (CITC)، مصر (NTRA)، الأردن (TRC) |
| مجموعات تطوير البرامج (SDKs) | جافا سكريبت وبايثون (قريبًا) |
الميزات ذات الصلة
منصة ذات علامة تجارية بيضاء
واجهة برمجة تطبيقات الشركاء لتوفير المستأجرين، والعلامات التجارية، والفواتير.
التحليلات والتقارير
قم بتصدير بيانات التقرير عبر واجهة برمجة التطبيقات (API) إلى أدوات ذكاء الأعمال الخاصة بك.
أحضر شركة الشحن الخاصة بك
إدارة خطوط SIP عبر لوحة التحكم الإدارية وواجهة برمجة التطبيقات (API).
التكاملات
موصلات جاهزة لأنظمة إدارة علاقات العملاء، والمراسلة، والمزيد.
الأسئلة الشائعة حول واجهة برمجة التطبيقات (API)
هل واجهة برمجة التطبيقات (API) متاحة في جميع الباقات؟
أين يمكنني العثور على وثائق واجهة برمجة التطبيقات (API)؟
كيف تعمل عملية المصادقة عبر الويب هوك؟
ماذا يحدث إذا تعطلت نقطة نهاية webhook الخاصة بي؟
هل يمكنني استخدام واجهة برمجة التطبيقات (API) لإنشاء واجهة وكيل مخصصة؟
هل واجهة برمجة التطبيقات متعددة المستخدمين؟
ما هو الحد الأقصى لمعدل الطلبات؟
هل تتوفر حزم تطوير البرامج (SDKs)؟
هل أنت مستعد للتكامل؟
استكشف وثائق واجهة برمجة التطبيقات (API) المباشرة أو احجز عرضًا توضيحيًا واحصل على إمكانية الوصول إلى واجهة برمجة التطبيقات. أنشئ أول عملية تكامل لك في غضون ساعات، وليس أسابيع.