انتقل إلى المحتوى

API وWebhooks

واجهة برمجة التطبيقات (API) والويب هوكس للدايلر: جاهزة للإنتاج، لا شريحة في خارطة طريق.

أكثر من 25 نقطة نهاية REST، وWebhooks فورية، ومصادقة JWT، ووثائق تفاعلية. كل ميزة تستخدمها في الواجهة متاحة عبر API.

تجربة مجانية لمدة 14 يومًا · رصيد ذكاء اصطناعي مجاني لتجربة الوكيل الصوتي بالذكاء الاصطناعي · دون الحاجة إلى بطاقة

من تطوير BroadNet — 22 عامًا في قطاع الاتصالات 11 لغة، مع فهم اللهجات BYOC — شركات اتصالاتك، دون ارتباط إلزامي يدعم الامتثال (TCPA وGDPR وTDRA)

إجابة سريعة

ما هي DialerBee API؟ يوفر DialerBee واجهة REST API جاهزة للإنتاج بأكثر من 25 نقطة نهاية تغطي الحملات وجهات الاتصال والمكالمات والموظفين والامتثال والتسجيلات والتقارير وWebhooks. تعتمد المصادقة على رموز JWT من نوع Bearer تنتهي صلاحيتها بعد 24 ساعة. وتدعم الـ API ترقيم الصفحات القائم على المؤشر (cursor)، وتُرجع استجابات أخطاء وفق RFC 7807، وتفرض حدًا قدره 2,000 طلب/دقيقة لكل مستأجر. وتُرسل Webhooks الفورية الأحداث (call.started وcall.answered وcall.amd_result وdisposition.set وcompliance.blocked وغيرها) مع التحقق من التوقيع عبر HMAC-SHA256 وإعادة المحاولة بفواصل متزايدة أسيًا. وثائق API التفاعلية متاحة على app.dialerbee.com/admin/api-docs.html.

المشكلة

معظم واجهات API لأنظمة الـ Dialer مجرد فكرة لاحقة

اشتريت نظام Dialer لإجراء المكالمات. والآن تحتاج إلى ربطه بنظام CRM، وإرسال البيانات إلى مستودع بياناتك، وتشغيل مسارات العمل من أحداث المكالمات، وبناء لوحات معلومات مخصصة. تراجع وثائق API لدى المورّد فتجد... ملف PDF من عام 2019 فيه 6 نقاط نهاية غير موثقة، ولا Webhooks، وواجهة SOAP.

هذا هو الواقع لدى معظم فرق الاتصال الصادر. نظام الـ Dialer يؤدي عمله جيدًا في إجراء المكالمات، لكن ما إن تحتاج إلى البناء عليه — مزامنة نتائج المكالمات مع Salesforce، أو إنشاء التذاكر تلقائيًا في Zendesk، أو إرسال التحليلات إلى أداة ذكاء الأعمال، أو بناء واجهة مخصصة للموظفين — حتى تجد نفسك عالقًا مع ملفات CSV والعمليات اليدوية.

بُني DialerBee بنهج API أولًا. كل ميزة في الواجهة تعمل عبر REST API نفسها التي يمكنك استدعاؤها من أنظمتك. الـ API ليست إضافة ملحقة، بل هي الأساس الذي تعمل عليه المنصة بأكملها.

6
نقاط النهاية المعتادة لدى المورّدين
غير موثقة، ولا Webhooks
SOAP
بروتوكول قديم
كثير من أنظمة الـ Dialer لا تزال تستخدم XML/SOAP
CSV
تكامل بالتصدير فقط
نقل ملفات يدوي، ولا شيء فوري

كيف يعمل

API أولًا منذ التصميم

تتبع DialerBee API أعراف REST مع حمولات JSON وأساليب HTTP القياسية واستجابات أخطاء وفق RFC 7807. وتعتمد المصادقة على رموز JWT من نوع Bearer يُحصل عليها من نقطة نهاية تسجيل الدخول، بصلاحية 24 ساعة مع دعم تجديد الرمز. وكل استجابة من الـ API تتضمن ترويسات حدود المعدل، كي يضبط تكاملك وتيرة طلباته بسلاسة.

الخطوة 01

المصادقة

أرسل طلب POST إلى /v1/login ببيانات الاعتماد، واحصل على رمز JWT من نوع Bearer صالح لمدة 24 ساعة. واستخدم تجديد الرمز للتكاملات طويلة التشغيل.

الخطوة 02

استدعاء نقاط النهاية

أكثر من 25 نقطة نهاية RESTful للحملات وجهات الاتصال والمكالمات والموظفين والامتثال والتسجيلات والتقارير. JSON في المدخلات والمخرجات.

الخطوة 03

استقبال Webhooks

سجّل عناوين URL للـ Webhooks لتستقبل الأحداث فورًا. كل حمولة موقّعة بـ HMAC-SHA256 لتتمكن من التحقق من صحتها.

الخطوة 04

معالجة الأخطاء

تفاصيل المشكلة وفق RFC 7807 لكل خطأ. ترويسات حدود المعدل في كل استجابة. ورمز الحالة 429 مع إرشاد Retry-After.

مقارنة جنبًا إلى جنب

DialerBee API مقابل واجهات API المعتادة لأنظمة الـ Dialer

القدرة API الـ Dialer المعتادة DialerBee API
نقاط النهاية 5-10، موثقة جزئيًا أكثر من 25، موثقة بالكامل مع مواصفات OpenAPI
البروتوكول SOAP/XML أو بروتوكول خاص REST مع JSON، وأخطاء وفق RFC 7807
المصادقة مفتاح API (لا تنتهي صلاحيته أبدًا) JWT بصلاحية 24 ساعة + تجديد الرمز
الأحداث الفورية استعلام دوري (Polling) أو لا شيء Webhooks موقّعة بـ HMAC-SHA256 مع إعادة المحاولة
ترقيم الصفحات قائم على الإزاحة (Offset) أو لا شيء قائم على المؤشر مع next_cursor + has_more
حدود المعدل غير موثق 2,000 طلب/دقيقة مع ترويسات في كل استجابة
التوثيق ملف PDF أو ويكي قديم وثائق Swagger تفاعلية مباشرة
تعدد المستأجرين مستأجر واحد فقط تقييد النطاق لكل مستأجر في كل نقطة نهاية

مرجع نقاط النهاية

10 مجموعات API. أكثر من 25 نقطة نهاية.

مجموعة API نقاط النهاية
المصادقة POST /login, POST /refresh
الحملات CRUD + بدء/إيقاف مؤقت
جهات الاتصال رفع، عرض، بحث
المكالمات السجل، الأعداد المباشرة، إنشاء مكالمة
الموظفون الحالة، تسجيل SIP
الامتثال وDNC فحوصات ما قبل الاتصال، وقوائم DNC
التسجيلات عرض القائمة، وروابط تشغيل موقّعة
التقارير تصدير (CSV، JSON، PDF)
Webhooks اشتراك، إدارة، تحقق
النظام السلامة، الإصدار

البدء السريع

صادِق وابدأ الاتصال في 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

Webhooks

الأحداث الفورية تصل إلى أنظمتك

تُرسل Webhooks الأحداث إلى أنظمتك فورًا — دون الحاجة إلى استعلام دوري. كل حمولة Webhook موقّعة بـ HMAC-SHA256 لتتحقق من أنها صادرة من DialerBee ولم يُعبث بها. وإذا تعطلت نقطة النهاية لديك، تعيد Webhooks المحاولة بفواصل متزايدة أسيًا لمدة تصل إلى ساعتين و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

جدول الموظف معاودة اتصال بإحدى جهات الاتصال

خلف الكواليس

مصممة للمطورين الذين يُطلقون منتجاتهم فعلًا

البروتوكول HTTPS فقط (TLS 1.2+)
الصيغة طلبات واستجابات بصيغة JSON
المصادقة رموز JWT من نوع Bearer (صلاحية 24 ساعة) مع التجديد
إدارة الإصدارات المسار /v1 في عنوان URL + schema_version في Webhooks
ترقيم الصفحات قائم على المؤشر مع next_cursor وhas_more
حدود المعدل 2,000 طلب/دقيقة لكل مستأجر مع ترويسات
صيغة الأخطاء تفاصيل المشكلة لواجهات HTTP API وفق RFC 7807
توقيع Webhooks التحقق من التوقيع باستخدام HMAC-SHA256
إعادة محاولات Webhooks فواصل متزايدة أسيًا (بحد أقصى ساعتان و35 دقيقة إجمالًا)
روابط التسجيلات روابط موقّعة بصلاحية ساعة واحدة عبر MinIO
سجلات DNC الإمارات (TDRA)، والسعودية (CST)، ومصر (NTRA)، والأردن (TRC)
SDKs JavaScript وPython (قريبًا)

الأسئلة الشائعة حول API

هل الـ API متاحة في جميع الباقات؟
الوصول إلى REST API متاح في جميع الباقات. ونطاق API في باقات Starter محدود (قراءة فقط لبعض نقاط النهاية). أما باقات Professional وEnterprise فتشمل وصولًا كاملًا إلى API مع عمليات الكتابة وWebhooks وحدود معدل أعلى.
أين أجد وثائق API؟
وثائق API التفاعلية متاحة على app.dialerbee.com/admin/api-docs.html. وتتضمن وصفًا لنقاط النهاية، وأمثلة للطلبات والاستجابات، وأدلة المصادقة، ومستكشف API مباشرًا يمكنك فيه اختبار الاستدعاءات مباشرة.
كيف تعمل مصادقة Webhooks؟
تتضمن كل حمولة Webhook توقيع HMAC-SHA256 في الترويسة X-Signature. وعلى نقطة النهاية لديك حساب HMAC لجسم الطلب الخام باستخدام سر Webhook الخاص بك ومقارنته بالتوقيع. وهذا يثبت أن الحمولة صادرة من DialerBee ولم تُعدَّل أثناء النقل.
ماذا يحدث إذا تعطلت نقطة نهاية Webhook لديّ؟
يعيد DialerBee محاولة تسليم Webhooks الفاشلة بفواصل متزايدة أسيًا، وتستمر المحاولات حتى ساعتين و35 دقيقة إجمالًا. وبعد استنفاد كل المحاولات، يُسجَّل الحدث على أنه لم يُسلَّم ويظهر في لوحة Webhooks.
هل يمكنني استخدام API لبناء واجهة مخصصة للموظفين؟
نعم. تتيح الـ API جميع نقاط النهاية الخاصة بالموظفين: إدارة الحالة، والتحكم في المكالمات، وتسجيل نتائج المكالمات، والبحث عن جهات الاتصال، وتشغيل التسجيلات. ومع أحداث WebSocket للتحديثات الفورية، يمكنك بناء تجربة موظف مخصصة بالكامل.
هل الـ API متعددة المستأجرين؟
نعم. كل استدعاء API يقتصر نطاقه على المستأجر المُصادَق عليه. ويمكن لحسابات الشركاء والموزّعين إدارة عدة مستأجرين عبر Partner API، بما في ذلك تجهيز المستأجرين وتهيئتهم وإدارة الفوترة.
ما حد معدل الطلبات؟
2,000 طلب في الدقيقة لكل مستأجر. وتتضمن كل استجابة الترويسات X-RateLimit-Limit وX-RateLimit-Remaining وX-RateLimit-Reset. وإذا تجاوزت الحد، ستتلقى رمز الحالة 429 مع الترويسة Retry-After.
هل تتوفر SDKs؟
حزم SDK للغتي JavaScript وPython قيد التطوير. وحتى ذلك الحين، تعتمد الـ API أعراف REST القياسية مع حمولات JSON، فأي عميل HTTP بأي لغة يعمل معها. وتتضمن الوثائق التفاعلية أمثلة curl لكل نقطة نهاية.

اعرف ما يمكنك الاشتراك فيه

كل حدث موثّق قبل أن تبدأ البناء

تنشر المنصة حدثًا لكل ما يهم في المكالمة، وكل حدث مُفهرس مع شكل حمولته — فتعرف ما سيحتويه الـ Webhook قبل أن تكتب المعالج، بدلًا من اكتشاف المخطط من أول ما يصل.

دورة حياة المكالمة، وحالة الحملة، ونشاط الموظفين، ونتيجة المكالمة، وتوفر التسجيل، وقرارات الامتثال، وتسليم الرسائل — لكلٍّ منها أحداثه الخاصة. اشترك في ما يهم تكاملك وتجاهل الباقي — لست مضطرًا لاستقبال سيل من البيانات للحصول على الأحداث الثلاثة التي تحتاجها.

جاهز للتكامل؟

استكشف وثائق API المباشرة أو احجز عرضًا توضيحيًا واحصل على وصول إلى API. وابنِ أول تكامل لك في ساعات لا أسابيع.

تجربة مجانية لمدة 14 يومًا · رصيد ذكاء اصطناعي مجاني · بدون بطاقة · اطّلع على الأسعار

← عرض الموقع كاملاً بالإنجليزية