أحداث (Webhook) المدعومة في Bevatel

أحداث (Webhook) المدعومة في Bevatel

"استكشف أحداث (Webhook) المدعومة في بيفاتيل لتبقى على اطلاع دائم بشأن تغييرات الدردشة والرسائل والحالة مع حمولات مخصصة."

أحداث (Webhook) المدعومة في بيفاتيل


تقوم بيفاتيل بنشر مجموعة متنوعة من الأحداث إلى نقاط نهاية (webhook) المكونة. إذا كنت ترغب في تكوين خطاف، يُرجى الرجوع إلى الدليل هنا.

كل حدث له هيكل حمولته استنادًا إلى نوع النموذج الذي يعمل عليه. 

يصف القسم التالي الكائنات الرئيسية التي نستخدمها في بيفاتيل وسماتها.

الكائنات

يمكن أن يحتوي الحدث على أي من الكائنات التالية كحمولة. الأنواع المختلفة من الكائنات المدعومة في بيفاتيل هي كما يلي.

حساب

سيتم إرجاع الحمولة التالية لحساب.

  1. {
  2.   "id": "integer",
  3.   "name": "string"
  4. }

صندوق الوارد


سيتم إرجاع الحمولة التالية إلى البريد الوارد.

  1. {
  2.   "id": "integer",
  3.   "name": "string"
  4. }


جهة الاتصال


سيتم إرجاع الحمولة التالية لجهة الاتصال.

  1. {
  2.   "id": "integer",
  3.   "name": "string",
  4.   "avatar": "string",
  5.   "type": "contact",
  6.   "account": {
  7.     // <...Account Object>
  8.   }
  9. }

مستخدم

سيتم إرجاع الحمولة التالية لوكيل/مدير.

  1. {
  2.   "id": "integer",
  3.   "name": "string",
  4.   "email": "string",
  5.   "type": "user"
  6. }

المحادثة

سيتم إرجاع الحمولة التالية لمحادثة.

  1. {
  2.   "additional_attributes": {
  3.     "browser": {
  4.       "device_name": "string",
  5.       "browser_name": "string",
  6.       "platform_name": "string",
  7.       "browser_version": "string",
  8.       "platform_version": "string"
  9.     },
  10.     "referer": "string",
  11.     "initiated_at": {
  12.       "timestamp": "iso-datetime"
  13.     }
  14.   },
  15.   "can_reply": "boolean",
  16.   "channel": "string",
  17.   "id": "integer",
  18.   "inbox_id": "integer",
  19.   "contact_inbox": {
  20.     "id": "integer",
  21.     "contact_id": "integer",
  22.     "inbox_id": "integer",
  23.     "source_id": "string",
  24.     "created_at": "datetime",
  25.     "updated_at": "datetime",
  26.     "hmac_verified": "boolean"
  27.   },
  28.   "messages": ["Array of message objects"],
  29.   "meta": {
  30.     "sender": {
  31.       // Contact Object
  32.     },
  33.     "assignee": {
  34.       // User Object
  35.     }
  36.   },
  37.   "status": "string",
  38.   "unread_count": "integer",
  39.   "agent_last_seen_at": "unix-timestamp",
  40.   "contact_last_seen_at": "unix-timestamp",
  41.   "timestamp": "unix-timestamp",
  42.   "account_id": "integer"
  43. }

رسالة

  1. {
  2.   "id": "integer",
  3.   "content": "string",
  4.   "message_type": "integer",
  5.   "created_at": "unix-timestamp",
  6.   "private": "boolean",
  7.   "source_id": "string / null",
  8.   "content_type": "string",
  9.   "content_attributes": "object",
  10.   "sender": {
  11.     "type": "string - contact/user"
  12.     // User or Contact Object
  13.   },
  14.   "account": {
  15.     // Account Object
  16.   },
  17.   "conversation": {
  18.     // Conversation Object
  19.   },
  20.   "inbox": {
  21.     // Inbox Object
  22.   }
  23. }

عينة من حمولة Webhok

  1. {
  2.   "event": "event_name"
  3.   // Attributes related to the event
  4. }

Webhook أحداث


تدعم بيفاتيل أحداث webhook التالية. يمكنك الاشتراك فيها أثناء تكوين webhook في لوحة التحكم أو باستخدام واجهة برمجة التطبيقات (API).

محادثة_تم إنشاؤها

سيتم تشغيل هذا الحدث عند إنشاء محادثة جديدة في الحساب. تكون حمولة الحدث كما يلي.

  1. {
  2.   "event": "conversation_created"
  3.   // <...Conversation Attributes>
  4. }


تحديث_المحادثة

سيتم تشغيل هذا الحدث عند حدوث تغيير في أي من السمات في المحادثة.

  1. {
  2.   "event": "conversation_updated",
  3.   "changed_attributes": [
  4.     {
  5.       "<attribute_name>": {
  6.         "current_value": "",
  7.         "previous_value": ""
  8.       }
  9.     }
  10.   ]
  11.   // <...Conversation Attributes>
  12. }

تم_تغيير_حالة_المحادثة

سيتم تشغيل هذا الحدث عند تغيير حالة المحادثة.

ملحوظة: إذا كنت تستخدم واجهات برمجة تطبيقات وكيل الروبوت بدلاً من الخطافات، فإن هذا الحدث غير مدعوم حاليًا.
  1. {
  2.   "event": "conversation_status_changed"
  3.   // <...Conversation Attributes>
  4. }


تم_إنشاء_الرسالة

سيتم تشغيل هذا الحدث عند إنشاء رسالة في محادثة. تكون حمولة الحدث كما يلي.

  1. {
  2.   "event": "message_created"
  3.   // <...Message Attributes>
  4. }

تم_تحديث_الرسالة

سيتم تشغيل هذا الحدث عند تحديث رسالة في محادثة. تكون حمولة الحدث كما يلي.

  1. {
  2.   "event": "message_updated"
  3.   // <...Message Attributes>
  4. }

تم_تشغيل_عنصر_واجهة_الويب

سيتم تشغيل هذا الحدث عندما يقوم المستخدم النهائي بفتح عنصر واجهة الدردشة المباشرة.

  1. {
  2.   "id": ,
  3.   "contact": {
  4.     // <...Contact Object>
  5.   },
  6.   "inbox": {
  7.     // <...Inbox Object>
  8.   },
  9.   "account": {
  10.     // <...Account Object>
  11.   },
  12.   "current_conversation": {
  13.     // <...Conversation Object>
  14.   },
  15.   "source_id": "string",
  16.   "event": "webwidget_triggered",
  17.   "event_info": {
  18.     "initiated_at": {
  19.       "timestamp": "date-string"
  20.     },
  21.     "referer": "string",
  22.     "widget_language": "string",
  23.     "browser_language": "string",
  24.     "browser": {
  25.       "browser_name": "string",
  26.       "browser_version": "string",
  27.       "device_name": "string",
  28.       "platform_name": "string",
  29.       "platform_version": "string"
  30.     }
  31.   }
  32. }

    • Related Articles

    • WhatsApp Cloud

      يوضح هذا الدليل خطوات دمج واجهة برمجة تطبيقات واتساب السحابية (WhatsApp Cloud API) مع نظام المحادثات التجارية في Bevatel. يتضمن إعداد واجهة API، تكوين الـ Webhook، تعيين الوكلاء، وتأكيد نجاح إعداد القناة. الخطوة 1: اختيار مزود واجهة API انتقل إلى ...

    • تهيئة Webhooks

      "ابدأ باستخدام webhooks في بيفاتيل لتمكين الاستدعاءات النصية HTTP التي يتم تنشيطها بواسطة الأحداث مثل إنشاء الرسائل لتعزيز التكامل والأتمتة." البدء باستخدام خطافات الويب في بيفاتيل الـ Webhooks هي استدعاءات HTTP تم تحديدها في كل حساب. تُشغل هذه ...

    • الدعم متعدد اللغات

      "تقدم بيفاتيل دعما ل 2 لغة مختلفة ، مما يتيح للمستخدمين تكوين لوحة التحكم بسهولة بلغتهم المفضلة عبر إعدادات الملف الشخصي." الدعم متعدد اللغات بيفاتيل يدعم في الأساس 2 لغات مختلفة. يوضح القسم أدناه كيف يمكنك تكوين لوحة تحكم بيفاتيل للعمل بلغات مختلفة. ...

    • قناة API

      إنشاء قناة قم بإعداد صندوق بريد لقناة API بسهولة في بيفاتيل، مما يتيح لك إرسال واستقبال الرسائل باستخدام واجهات برمجة التطبيقات الخاصة ببيفاتيل بخطوات إعداد بسيطة. كيف تنشئ صندوق بريد لقناة API؟ يتضمن إعداد قناة API الخطوات التالية: إنشاء صندوق بريد ...

    • Beva Smart AI

      1. إعدادات Beva Smart AI يمكنك تخصيص إعدادات Beva Smart AI لتتناسب مع احتياجاتك من خلال اتباع الخطوات التالية: خطوات ضبط الإعدادات: انتقل إلى "Beva Smart AI" ضمن لوحة الإعدادات. يمكنك تفعيل أو تعطيل الميزات التالية حسب احتياجاتك: تغيير النغمة (Change ...