إنشاء دردشة مباشرة

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 حقلًا إجباريًّا.
• none: يعني أن العميل لن يحتاج لتسجيل الدخول ببريده الإلكتروني قبل بدء الدردشة.

status

معامل إجباري، نوعه سلسلة نصية string وقيمته الافتراضية active، يحدد حالة الدردشة الجديدة المُضافة إذا كانت فعالة أو غير فعالة أو محذوفة، ويقبل إحدى القيم التالية حصرًا:

• active فعالة.
• Inactive غير فعالة.
• deleted محذوفة.

agent_ids

نوعه مصفوفة array، تُكتب ضمنه الأرقام التعريفية لوكلاء مركز المساعدة المكلفين بالرد على الرسائل الواردة عبر الدردشة الجديدة.

team_ids

نوعه مصفوفة array، تُكتب ضمنه الأرقام التعريفية لفرق العمل المكلفة بالرد على رسائل العملاء الواردة عبر الدردشة الجديدة.

en

نوعه object، سيظهر للعملاء الذين اختاروا اللغة الإنجليزية للتواصل مع مركز المساعدة، ويتألف من:

• welcome_message سلسلة نصية string، تتضمن نص رسالة الترحيب التي ستظهر للعملاء ضمن نافذة الدردشة المباشرة عندما يتواصلون مع المركز لأول مرة، ويفترض أن تكون باللغة الإنجليزية.
• title سلسلة نصية string، تُحَدِّد عنوان الدردشة المباشرة التي ستظهر للعملاء، ويفترض أن تكون باللغة الإنجليزية.

ar

نوعه object، سيظهر للعملاء الذين اختاروا اللغة العربية للتواصل مع مركز المساعدة، ويتألف من:

• welcome_message سلسلة نصية string، تتضمن نص رسالة الترحيب التي ستظهر للعملاء ضمن نافذة الدردشة المباشرة عندما يتواصلون مع المركز لأول مرة، ويفترض أن تكون باللغة العربية.
• title سلسلة نصية string تحدد عنوان الدردشة المباشرة التي ستظهر للعملاء، ويفترض أن تكون باللغة العربية.

description

نوعه سلسلة نصية string، وهو وصف داخلي للدردشة الجديدة، يُقصد بالوصف الداخلي أنه يظهر فقط داخل مركز المساعدة ولا يظهر للعملاء.

name

نوعه سلسلة نصية string، وهو اسم داخلي للدردشة الجديدة المُضافة ولا يظهر للعملاء.

replying_speed

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

slug

نوعه سلسلة نصية string، تُحَدِّد بواسطته الرابط الخاص بالوصول إلى الدردشة المباشرة الجديدة والذي يمكنك إضافته إلى تطبيقك أو موقعك الألكتروني. على سبيل المثال إذا أعطيت المعامل slug القيمة new-chat فسيكون رابط الدردشة المباشرة support.example.com/new-chat

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 إعدادات اللغة، معامل إجباري، نوعه سلسلة نصية string، ويقبل القيمة ar أو en.
  • blocks الحقول الخاصة بالتبويب، وهي مصفوفة تتكون من ثلاثة عناصر وهي سلسلة نصية content تكتب ضمنها أي محتوى نصي ترغب بأن يظهر ضمن علامة التبويب، وعدد صحيح form_id تكتب ضمنه الرقم التعريفي لنموذج التواصل الذي ترغب بعرضه ضمن علامة التبويب، وعدد صحيح sort يمثل ترتيب الحقول ضمن علامة التبويب.