ضبط الدردشات المباشرة

توفر زيتون دردشة مباشرة افتراضية مضافة مسبقًا إلى مركز المساعدة تسمى الدردشة الأساسية، كما تقدم كودًا جاهزًا لدمج هذه الدردشة الافتراضية في أي موقع أو تطبيق خاص بنا، كل ما نحتاجه هو إضافة هذا الكود في الصفحة التي نرغب في إظهار الدردشة فيها للتواصل بسهولة مع العملاء، وتوفير الإجابات المناسبة التي يحتاجونها بسرعة.

سنشرح في هذا المقال كيفية تخصيص وضبط الدردشة المباشرة من خلال الواجهة البرمجية لزيتون.

لتطبيق الأمثلة، سنفترض وجود مركز مساعدة على النطاق example.com، ومفتاح الواجهة البرمجية لزيتون مخزن ضمن المتغير TOKEN$.

export TOKEN="YOUR_API_KEY"

عرض إعدادات الدردشات

لعرض قائمة بكافة إعدادات الدردشات المباشرة والمعلومات المتعلقة بكل دردشة مثل اسم الدردشة، وحالتها، ونوعها، والحقول المطلوب تعبئتها لبدئها، والفرق والوكلاء المشاركين بها، وترتيبها وتصفيتها وفق معايير محددة، نرسل طلبGET لنقطة الوصول List all chats.

ولعرض كافة إعدادات دردشة معينة نرسل طلب GET لنقطة الوصول Retrieve a chat مع تمرير الرقم التعريفي للدردشة المطلوبة في عنوان الطلب.

كافة الدردشات

لعرض كافة الدردشات المباشرة ضمن مركز المساعدة، مع ترتيبها تصاعديًّا حسب تاريخ إنشائها نرسل الطلب على النحو التالي:

curl "https://example.com/api/agent/v1/chats?sort=created_at.asc" \
  -H "Authorization: Bearer @TOKEN"

الدردشات ضمن صندوق بريد

لعرض الدردشات المباشرة المرتبطة بصندوق البريد رقم 1010، نكتب الطلب كما يلي:

curl "https://example.com/api/agent/v1/chats?inbox_id=1010" \
  -H "Authorization: Bearer @TOKEN" \
  --globoff

الدردشات الفعالة

لعرض الدردشات الفعالة فقط، أي التي لم تغلق بعد نكتب الطلب كما يلي:

curl "https://example.com/api/agent/v1/chats?statuses[]=active" \
  -H "Authorization: Bearer @TOKEN"

دردشة واحدة

لعرض كافة إعدادات الدردشة المباشرة التي لها الرقم التعريفي 1011، نكتب الطلب التالي:

curl "https://example.com/api/agent/v1/chats/1011" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer @TOKEN"

إنشاء دردشة

قد نحتاج لإنشاء دردشة إضافية بإعدادات مخصصة تتناسب مع نوع العمل أو الخدمة التي نقدمها، ولإنشاء دردشة مباشرة إضافية في مركز المساعدة نرسل طلب POST لنقطة الوصول Create a chat مع تمرير إعدادت الدردشة المطلوبة في جسم الطلب.

دردشة واحدة

لننشئ دردشة جديدة في مركز المساعدة مع ضبط مختلف إعدادتها من خلال الطلب التالي:

curl "https://example.com/api/agent/v1/chats" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer @TOKEN" \
  -d '{
    "name": "الدردشة الإضافية",
    "description": "دردشة إضافية",
    "inbox_id": "1010",
    "first_name_field": "required",
    "last_name_field": "required",
    "email_field": "required",
    "mobile_number_field": "optional",
    "agent_ids": [108, 1008],
    "team_ids": [1009],
    "slug": "new-chat",
    "welcome_message_behaviour": "popup",
    "replying_speed": "",
    "authentication_method": "none",
    "status": "active",
    "ar": {
      "welcome_message": "كيف يمكننا مساعدتك؟",
      "title": "تحدث معنا"
    },
    "tabs": [
      {
        "name": "تعرّف على خدماتنا",
        "icon": "your_icon_image_SVG_Code",
        "status": "active",
        "locale": "ar",
        "type": "knowledgebase",
        "sort": "0"
      },
      {
        "name": "الدردشة المباشرة",
        "icon": "your_icon_image_SVG_Code",
        "status": "active",
        "locale": "ar",
        "type": "chat",
        "sort": "1"
      }
    ]
  }'

تعديل إعدادات دردشة

يمكن تعديل إعدادات دردشة مباشرة معينة في مركز المساعدة بإرسال طلب PUT لنقطة الوصول Update a chat مع تمرير إعدادت الدردشة في جسم الطلب.

دردشة واحدة

لتعديل إعدادت الدردشة المباشرة التي أضفناها في المثال السابق بافتراض أن لها الرقم التعريفي 1011، بحيث نعدل وصف هذه الدردشة ونخفي رقم الهاتف من نافذة الدردشة، ونفرض التسجيل باستخدام البريد الإلكتروني، ونمنح لفريق عمل له الرقم التعريفي 109 صلاحية الرد على الرسائل الواردة عبر الدردشة دون سحب الصلاحية من فريق عمل سابق له الرقم 1009، ونحذف تبويب "تعرف على خدماتنا" سنكتب الطلب على النحو التالي:

curl "https://example.com/api/agent/v1/chats/1011" \
  -X PUT \\
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_token" \
  -d '{
    "name": "الدردشة الإضافية",
    "description": "هذه الدردشة مخصصة لعملاء المتجر",
    "mobile_number_field": "hidden",
    "email_field": "required",
    "authentication_method": "email",
    "team_ids": [1009 , 109],
    "status": "active",
    "ar": {
      "title": "تحدث معنا"
    },
    "tabs": [
      { 
        "name": "الدردشة المباشرة",
        "icon": "Enter_your_icon_image_SVG_Code",
        "status": "active",
        "locale": "ar",
        "type": "chat",
        "sort": "1"
      }
    ]
  }'