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

نشرح في هذا المقال تعديل إعدادات دردشة مباشرة باستخدام الواجهة البرمجية لزيتون، ونطبق أمثلة عملية على مركز مساعدة تجريبي باسم "المناسب" له النطاق الفرعي al-munasib.zaetoon.com.

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

يمكنك تعديل إعدادات دردشة مباشرة معينة في مركز المساعدة بإرسال طلب من نوع PUT إلى نقطة الاتصال {chats/{id/ وفق التالي:

• عنوان URL لنقطة الاتصال:
  https://{your_subdomain}/api/agent/v1/chats/{id}.
• نوع الطلب: PUT.
• جسم الطلب Body: يكتب بصيغة JSON ويتضمن المعاملات التالية:
• • inbox_id: نوعه عدد صحيح integer، يكتب ضمنه الرقم التعريفي لصندوق البريد الذي ترغب باستخدامه لتخزين رسائل العملاء الواردة عبر هذه الدردشة المباشرة.
  • first_name_field: نوعه سلسلة نصية string، تُحَدِّد بواسطته مواصفات حقل الاسم الأول للعميل، ويقبل إحدى القيم التالية حصرًا:
  • • required الحقل مطلوب وإجباري.
    • hidden الحقل مخفي.
    • optional الحقل ظاهر لكنه اختياري.
  • last_name_field: نوعه سلسلة نصية string، تُحَدِّد بواسطته مواصفات حقل اسم العائلة للعميل، ويقبل إحدى القيم التالية حصرًا:
  • • required الحقل مطلوب وإجباري.
    • hidden الحقل مخفي.
    • optional الحقل ظاهر لكنه اختياري.
  • email_field: نوعه سلسلة نصية string، تُحَدِّد بواسطته مواصفات حقل البريد الإلكتروني للعميل، ويقبل إحدى القيم التالية حصرًا:
  • • required الحقل مطلوب وإجباري.
    • hidden الحقل مخفي.
    • optional الحقل ظاهر لكنه اختياري.
  • mobile_number_field: نوعه سلسلة نصية string، تُحَدِّد بواسطته مواصفات حقل رقم هاتف العميل، ويقبل إحدى القيم التالية حصرًا:
  • • required الحقل مطلوب وإجباري.
    • hidden الحقل مخفي.
    • optional الحقل ظاهر لكنه اختياري.
  • authentication_method: معامل إجباري، نوعه سلسلة نصية string، يُحَدِّد إعدادات المصادقة المطلوبة من العميل قبل بدء الدردشة مع مركز المساعدة، ويقبل إحدى القيمتين التاليتين حصرًا:
  • • email عند اختيارها ينبغي للعميل تسجيل الدخول ببريده الإلكتروني قبل بدء الدردشة(في حال اخترت طريقة المصادقة باستخدام البريد الإلكتروني فيجب أن يكون حقل البريد الإلكتروني للعميل "email_field" حقلًا إجباريًّا required).
    • none لن يُطلب من العميل تسجيل الدخول قبل بدء الدردشة.
  • status: مُعامِل إجباري، نوعه سلسلة نصية string، تُعَدِّل بواسطته حالة الدردشة المباشرة، ويقبل إحدى القيم التالية حصرًا:
  • • active فعالة.
    • inactive غير فعالة.
    • deleted محذوفة.
      علمًا أنك لا تستطيع حذف/ deleted أو إلغاء تفعيل/ inactive الدردشة الأساسية (الافتراضية) لمركز المساعدة.
  • agent_ids: نوعه مصفوفة array، تُعَدِّل بواسطته المستخدمين المكلفين بالرد على رسائل العملاء الواردة عبر هذه الدردشة المباشرة، إذ تُكتب ضمنه الأرقام التعريفية للمستخدمين.
  • team_ids: نوعه مصفوفة array، تُعَدِّل بواسطته فرق العمل المكلفة بالرد على رسائل العملاء الواردة عبر هذه الدردشة المباشرة، إذ تُكتب ضمنه الأرقام التعريفية لفرق العمل.
  • en: نوعه object، خاص بالواجهة الإنجليزية لمركز المساعدة تُعَدِّل بواسطته كل من:
  • • welcome_message رسالة الترحيب التي ستظهر للعملاء ضمن نافذة الدردشة المباشرة باللغة الإنجليزية.
    • title عنوان الدردشة المباشرة التي ستظهر للعملاء باللغة الإنجليزية.
  • ar: نوعه object، خاص بالواجهة العربية لمركز المساعدة تُعَدِّل بواسطته كل من القيم التالية:
  • • welcome_message رسالة الترحيب التي ستظهر للعملاء ضمن نافذة الدردشة المباشرة باللغة العربية.
    • title عنوان الدردشة المباشرة التي ستظهر للعملاء باللغة العربية.
  • description: نوعه سلسلة نصية string، يساعدك على تعديل الوصف الداخلي للدردشة المباشرة.
  • name: نوعه سلسلة نصية string، يساعدك على تعديل الاسم الداخلي للدردشة المباشرة. وهو معامِل إجباري في الطلب حتى إذا لم ترغب بتعديله.
  • replying_speed: نوعه سلسلة نصية string، لتفعيل أو إلغاء تفعيل إظهار معدل سرعة رد موظفي مركز المساعدة على رسائل العملاء الواردة عبر الدردشة. يمكنك إعطائه القيمة disabled لإخفاء معدل سرعة الرد في نافذة الدردشة المباشرة، أو عدم إعطائه أي قيمة (null) لإظهار معدل سرعة الرد في نافذة الدردشة المباشرة.
  • slug: نوعه سلسلة نصية string، يستخدم لتعديل الرابط الخاص بالوصول إلى الدردشة المباشرة الذي ستضيفه إلى تطبيقك أو موقعك الإلكتروني.
  • welcome_message_behaviour: نوعه سلسلة نصية string، يساعدك على تعديل طريقة عرض رسائل الترحيب التي تُعدّ بمثابة دعوة استباقية للعميل ليبدأ المحادثة مع مركزك، أعطهِ القيمة popup لإظهار الدعوة في نافذة منبثقة، والقيمة none لعكس ذلك.
  • tabs: نوعه مصفوفة array، يساعدك على تعديل خصائص علامات التبويب التي تظهر عند النقر على رابط الدردشة المباشرة وحذف بعض علامات التبويب وإضافة علامات تبويب جديدة. تتألف المصفوفة tabs من عدة عناصر، يمثل كل عنصر علامة تبويب ويتضمن التالي:
  • • • name: اسم علامة التبويب، نوعه سلسلة نصية string، وهو حقل إجباري ما لم تُحَدَّد أيقونة للتبويب.
      • icon: أيقونة علامة التبويب، نوعه سلسلة نصية string، وهو حقل إجباري ما لم تُحَدَّد اسم للتبويب.
      • url: رابط التبويب، نوعه سلسلة نصية string.
      • type: سلسلة نصية string، يُحَدِّد نوع علامة التبويب ويقبل إحدى القيم التالية حصرًا: chat للدردشة المباشرة أو knowledgebase لقاعدة المعرفة أو extra لعلامات التبويب الأخرى.
      • sort: ترتيب أو تسلسل داخلي لعلامات التبويب ضمن الدردشة، نوعه سلسلة نصية string.
      • status: حالة علامة التبويب إذا كانت فعالة أو غير فعالة أو محذوفة، ونوعه سلسلة نصية string، تقبل إحدى القيم التالية: active أو inactive أو deleted.
      • locale الإعدادات المحلية، معامل إجباري، نوعه سلسلة نصية ويقبل إحدى القيمتين: ar أو en.
      • blocks الحقول الخاصة بالتبويب، وهي مصفوفة تتكون من ثلاثة عناصر:
      • • content نوعه سلسلة نصية string، تكتب ضمنه أي محتوى نصي ترغب بأن يظهر ضمن علامة التبويب.
        • form_id نوعه عدد صحيح integer، تكتب ضمنه الرقم التعريفي لنموذج التواصل الذي ترغب بعرضه ضمن علامة التبويب.
        • sort نوعه عدد صحيح integer، وهو ترتيب أو تسلسل داخلي للحقول ضمن علامة التبويب.

مثال

لنطبَّق مثالًا عمليًّا على "الدردشة الإضافية" ذات الرقم "1136" التي أنشأناها سابقًا في مركز المساعدة التجريبي "المناسب"، لنفترض أننا نرغب بتعديل إعدادات الدردشة التالية:

1. تعديل الوصف الداخلي للدردشة.
2. إخفاء حقل "رقم الهاتف" من نافذة الدردشة.
3. تغيير طريقة المصادقة ليصبح تسجيل الدخول باستخدام البريد الإلكتروني أمرًا ضروريًا لبدء الدردشة مع مركز المساعدة.
4. منح فريق العمل ذو الرقم التعريفي "2256" صلاحية الرد على الرسائل الواردة عبر هذه الدردشة، دون سحب الصلاحية من الفرق الأخرى المخولة أساسًا بالرد (فأي فريق لا تكتب رقمه ضمن المصفوفة "team_id" لن يتستطع الرد على رسائل الدردشة).
5. حذف تبويب "تَعرّف على خدماتنا" من نافذة الدردشة المباشرة، والإبقاء على تبويب "الدردشة المباشرة" فقط (أي تبويب لا يُذكر ضمن الطلب PUT سيُحذف من علامات تبويب الدردشة).

سيكون الطلب وفق التالي:

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