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

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

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

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

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

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

الكائنات ​

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

حساب

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

{
  "id": "integer",
  "name": "string"
}

صندوق الوارد​

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

{
  "id": "integer",
  "name": "string"
}

جهة الاتصال

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

{
  "id": "integer",
  "name": "string",
  "avatar": "string",
  "type": "contact",
  "account": {
    // <...Account Object>
  }
}

مستخدم​

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

{
  "id": "integer",
  "name": "string",
  "email": "string",
  "type": "user"
}

المحادثة​

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

{
  "additional_attributes": {
    "browser": {
      "device_name": "string",
      "browser_name": "string",
      "platform_name": "string",
      "browser_version": "string",
      "platform_version": "string"
    },
    "referer": "string",
    "initiated_at": {
      "timestamp": "iso-datetime"
    }
  },
  "can_reply": "boolean",
  "channel": "string",
  "id": "integer",
  "inbox_id": "integer",
  "contact_inbox": {
    "id": "integer",
    "contact_id": "integer",
    "inbox_id": "integer",
    "source_id": "string",
    "created_at": "datetime",
    "updated_at": "datetime",
    "hmac_verified": "boolean"
  },
  "messages": ["Array of message objects"],
  "meta": {
    "sender": {
      // Contact Object
    },
    "assignee": {
      // User Object
    }
  },
  "status": "string",
  "unread_count": "integer",
  "agent_last_seen_at": "unix-timestamp",
  "contact_last_seen_at": "unix-timestamp",
  "timestamp": "unix-timestamp",
  "account_id": "integer"
}

رسالة​

{
  "id": "integer",
  "content": "string",
  "message_type": "integer",
  "created_at": "unix-timestamp",
  "private": "boolean",
  "source_id": "string / null",
  "content_type": "string",
  "content_attributes": "object",
  "sender": {
    "type": "string - contact/user"
    // User or Contact Object
  },
  "account": {
    // Account Object
  },
  "conversation": {
    // Conversation Object
  },
  "inbox": {
    // Inbox Object
  }
}

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

{
  "event": "event_name"
  // Attributes related to the event
}

Webhook أحداث​

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

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

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

{
  "event": "conversation_created"
  // <...Conversation Attributes>
}

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

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

{
  "event": "conversation_updated",
  "changed_attributes": [
    {
      "<attribute_name>": {
        "current_value": "",
        "previous_value": ""
      }
    }
  ]
  // <...Conversation Attributes>
}

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

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

ملحوظة: إذا كنت تستخدم واجهات برمجة تطبيقات وكيل الروبوت بدلاً من الخطافات، فإن هذا الحدث غير مدعوم حاليًا.

{
  "event": "conversation_status_changed"
  // <...Conversation Attributes>
}

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

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

{
  "event": "message_created"
  // <...Message Attributes>
}

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

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

{
  "event": "message_updated"
  // <...Message Attributes>
}

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

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

{
  "id": ,
  "contact": {
    // <...Contact Object>
  },
  "inbox": {
    // <...Inbox Object>
  },
  "account": {
    // <...Account Object>
  },
  "current_conversation": {
    // <...Conversation Object>
  },
  "source_id": "string",
  "event": "webwidget_triggered",
  "event_info": {
    "initiated_at": {
      "timestamp": "date-string"
    },
    "referer": "string",
    "widget_language": "string",
    "browser_language": "string",
    "browser": {
      "browser_name": "string",
      "browser_version": "string",
      "device_name": "string",
      "platform_name": "string",
      "platform_version": "string"
    }
  }
}