الخطوة 4: قم بإضافة الوكلاء إلى القناة.

الخطوة 5: تهانينا!! تم إعداد صندوق البريد بنجاح.

الآن تم إعداد القناة بنجاح، دعنا نجرب إرسال رسالة باستخدام واجهات برمجة التطبيقات الخاصة ببيفاتيل.

عند محاولة المستخدم تعديل إعدادات صندوق البريد:

في قسم المتعاونين في إعدادات صندوق البريد:

1. عند إضافة وكيل في حقل الوكيل (Agent Field):

   • أي مستخدم تم تعيينه كوكيل يمكنه رؤية والوصول إلى هذا الصندوق من خلال وحدة المحادثات.
   • يمكنهم إدارة المحادثات داخل هذا الصندوق.

2. عند إضافة فريق في حقل الفريق (Team Field):

   • المستخدمون الذين يحاولون تعيين محادثات لفريق معين من خلال وحدة المحادثات، سيتمكنون فقط من رؤية الفرق المضافة إلى صندوق البريد المرتبط.
   • هذا يقيد خيارات تعيين المحادثات للفرق المرتبطة بصندوق البريد المحدد، مما يضمن توزيع المحادثات بشكل مناسب بين الفرق المعنية.
     

إرسال الرسائل
تعرف على كيفية إرسال الرسائل في قناة API داخل منصة Bevatel من خلال إنشاء جهات اتصال، محادثات، ورسائل باستخدام رموز الوصول إلى API والحمولات المنظمة لتحقيق تواصل فعال.

إرسال الرسائل إلى قناة API

لإرسال الرسائل إلى قناة API، يجب أن تكون لديك فهم أساسي للنماذج والمصطلحات المستخدمة في Bevatel. دعنا نفهم هذه المفاهيم أولاً:

• القناة (Channel): يمكنك إنشاء مصادر متعددة للمحادثات التي تنتمي لنفس نوع القناة. على سبيل المثال: يمكن أن يكون لديك أكثر من صفحة فيسبوك متصلة بحساب Bevatel. كل صفحة تعتبر قناة داخل Bevatel.
• المحادثة (Conversation): المحادثة هي مجموعة من الرسائل.
• جهة الاتصال (Contact): كل محادثة لها شخص حقيقي مرتبط بها، هذا الشخص يسمى جهة اتصال.
• صناديق جهات الاتصال (Contact Inboxes): هذا هو الجلسة لكل جهة اتصال على صندوق الوارد. يمكن لجهة الاتصال أن يكون لها عدة جلسات وعدة محادثات داخل نفس صندوق الوارد.

كيفية إرسال رسالة في قناة API؟

لإرسال رسالة في قناة API، يجب إنشاء جهة اتصال أولاً، ثم إنشاء محادثة، ثم إرسال رسالة.

تتطلب واجهات API وجود api_access_token في رأس الطلب. يمكنك الحصول على هذا الرمز من خلال زيارة إعدادات الملف الشخصي الخاص بك > رمز الوصول (Access Token).

1. إنشاء جهة اتصال

قم بتمرير معرف صندوق الوارد الخاص بقناة API مع المعلمات الأخرى المحددة. سيتم إنشاء جلسة تلقائيًا. استجابة العينة قد تبدو كالتالي:"

1. {
2.   "email": "string",
3.   "name": "string",
4.   "phone_number": "string",
5.   "thumbnail": "string",
6.   "additional_attributes": {},
7.   "contact_inboxes": [
8.     {
9.       "source_id": "string",
10.       "inbox": {
11.         "id": 0,
12.         "name": "string",
13.         "website_url": "string",
14.         "channel_type": "string",
15.         "avatar_url": "string",
16.         "widget_color": "string",
17.         "website_token": "string",
18.         "enable_auto_assignment": true,
19.         "web_widget_script": "string",
20.         "welcome_title": "string",
21.         "welcome_tagline": "string",
22.         "greeting_enabled": true,
23.         "greeting_message": "string"
24.       }
25.     }
26.   ],
27.   "id": 0,
28.   "availability_status": "string" }

2. إنشاء محادثة

• استخدم source_id الذي تم استلامه من واجهة برمجة التطبيقات السابقة.

• ستتلقى معرف المحادثة (conversation ID)، والذي يمكن استخدامه لإنشاء رسالة.

1. {
2.   "id": 0
3. }
   

3. إنشاء رسالة جديدة

هناك نوعان من الرسائل يمكن إنشاؤها:

1. الرسائل الواردة (Incoming):
   الرسائل التي يرسلها المستخدم النهائي يتم تصنيفها كرسائل واردة.

2. الرسائل الصادرة (Outgoing):
   الرسائل التي يرسلها الوكيل (Agent) يتم تصنيفها كرسائل صادرة.

كيفية إنشاء رسالة؟

• عند استدعاء واجهة برمجة التطبيقات (API) بالمحتوى الصحيح، ستحصل على بيانات استجابة مشابهة للمثال أدناه.

1. {
2.     "id": 0,
3.     "content": "This is a incoming message from API Channel",
4.     "inbox_id": 0,
5.     "conversation_id": 0,
6.     "message_type": 0,
7.     "content_type": null,
8.     "content_attributes": {},
9.     "created_at": 0,
10.     "private": false,
11.     "sender": {
12.         "id": 0,
13.         "name": "Pranav",
14.         "type": "contact"
15.     }
    

واجهات برمجة التطبيقات للعملاء (Client APIs)

استفد من واجهات برمجة التطبيقات (APIs) الخاصة بمنصة Bevatel لإنشاء واجهات مخصصة للعملاء، بما في ذلك عناصر واجهة الدردشة، تكاملات تطبيقات الهواتف المحمولة، وامتدادات المنصة، مما يتيح إدارة فعالة لبيانات العملاء والتفاعل معهم.

إنشاء واجهات باستخدام Client APIs

ملاحظة: هذه الواجهات لا تزال في مرحلة alpha، وقد تحدث تغييرات في التنفيذ مستقبلاً.

استخدامات Client APIs

توفر واجهات برمجة التطبيقات (APIs) المتاحة لقناة API أدوات لبناء واجهات موجهة للعملاء على Bevatel.
تشمل الاستخدامات:

1. استخدام واجهة دردشة مخصصة بدلاً من عنصر واجهة دردشة Bevatel الافتراضي.
2. دمج واجهات محادثة داخل تطبيقات الهواتف المحمولة الخاصة بك.
3. إضافة دعم Bevatel إلى منصات لا توفر لها Bevatel أدوات تطوير رسمية (SDK).

إنشاء كائنات العملاء (Customer Objects)

معرّف صندوق البريد (Inbox Identifier):

• يمكنك الحصول على inbox_identifier من:
  قناة API -> الإعدادات -> التكوين (Configuration).

معرّف العميل (Customer Identifier):

• customer_identifier أو source_id يمكن الحصول عليه عند إنشاء العميل باستخدام واجهة Create API.
• يجب تخزين هذا المعرف في جانب العميل (client-side) لإجراء الطلبات المستقبلية نيابة عن العميل.
  • يمكن تخزينه في cookies، local storage، إلخ.

واجهات API المتوفرة

بعض الوظائف التي يمكنك القيام بها باستخدام هذه الواجهات:

1. إنشاء، عرض، وتحديث جهات الاتصال.
2. إنشاء، عرض، وإدارة المحادثات.
3. إنشاء، عرض، وتحديث الرسائل.

مصادقة HMAC

• تدعم Client APIs مصادقة HMAC.
• يمكن الحصول على رمز HMAC الخاص بالقناة عن طريق تشغيل الأمر التالي في Rails Console (إذا كنت تستخدم بيئة ريلز).

أهمية HMAC Authentication

• تضمن أمان الاتصالات بين العملاء وخادم Bevatel.
• يُوصى باستخدامه عند التعامل مع بيانات العملاء الحساسة أو إجراء عمليات حرجة.

1. # replace api_inbox_id with your inbox id
2. Inbox.find(api_inbox_id).channel.hmac_token
   

الاتصال بـ Bevatel WebSockets

للحصول على تحديثات في الوقت الفعلي من لوحة تحكم الوكلاء (Agent Dashboard)، يمكنك الاتصال بـ Bevatel WebSockets.

رابط الاتصال بـ WebSockets:

الاتصال يمكن إنشاؤه باستخدام عنوان URL التالي:

مصادقة اتصال WebSocket

للبدء في استقبال الأحداث الموجهة نحو كائن العميل (Customer Object) الخاص بك، يجب عليك الاشتراك باستخدام pubsub_token.

---

ما هو pubsub_token؟

• pubsub_token هو رمز مصادقة يتم توفيره أثناء استدعاء واجهة برمجة التطبيقات (Customer-Created API Call).
• يُستخدم هذا الرمز لتحديد العميل والتحقق من صحة الاتصال عبر WebSocket.

---

مثال:



2. const connection = new WebSocket('ws://localhost:3000/cable');
3. connection.send(JSON.stringify({ command:"subscribe", identifier: "{\"channel\":\"RoomChannel\",\"pubsub_token\":\""+ customer_pubsub_token+"\"}" }));