المحادثات | زيتون للمطورين

عرض كافة المحادثات

نشرح في هذا المقال عرض محادثات مركز المساعدة وترتيبها وتصفيتها بناء على عدة عوامل. طلب GET لعرض المحادثات تساعدك نقطة الاتصال conversations/ على عرض محادثات مركز المساعدة وترتيبها وتصفيتها تبعًا لعدة عوامل مثل التاريخ، وحالة المحادثة مفتوحة open أو مغلقة closed، وصندوق البريد الذي تنتمي له المحادثة وغيرها من الخيارات. عنوان URL لنقطة الاتصال https://{your_subdomain}/api/agent/v1/conversations معا...

عرض محادثة باستخدام الرقم التعريفي

نشرح في هذا المقال طريقة استرجاع محادثة محددة من مركز المساعدة باستخدام رقمها التعريفي. طلب عرض محادثة أرسل طلب من نوع GET لنقطة الاتصال {conversations/{id/ وفق التالي: عنوان URL https://{your_subdomain}/api/agent/v1/conversations/{id}. معاملات المسار معامل واحد إجباري هو الرقم التعريفي للمحادثة id ونوعه عدد صحيح integer. معاملات الاستعلام جميعها معاملات اختيارية تستخدم للتحكم بالمعلومات المسترجع...

دمج المحادثات وأرشفتها

نشرح في هذا المقال دمج المحادثات العائدة لجهة اتصال واحدة أو عدة جهات اتصال ضمن محادثة واحدة، وطريقة أرشفتها. طلب دمج المحادثات لدمج المحادثات العائدة لجهة اتصال واحدة أو عدة جهات اتصال ضمن محادثة واحدة مرر الرقم التعريفي لهذه المحادثة conversation_id في عنوان URL ضمن طلب POST لنقطة الاتصال conversations/{conversation_id}/merge/ ومرر الأرقام التعريفية للمحادثات المطلوب دمجها ضمن المصفوفة conversa...

تعديل خصائص محادثة

سنشرح لك في هذا المقال تعديل خصائص محادثة معينة في مركز المحادثة كتحديث حالة المحادثة، أو عنوانها أو تخصيصها لفريق معين. طلب تعديل خصائص محادثة يمكن إرسال طلب PUT لنقطة الاتصال {conversations/{id‎‏‏/ من أجل تعديل صندوق البريد الذي تنتمي إلي المحادثة أو حالة المحادثة أو عنوانها أو المستخدم المُسندة إليه، كما يمكن تعطيل ميزة طلب تقييم المحادثة من العميل بعد إغلاقها وفق التالي: عنوان URL https://{yo...

التعديل الجماعي للمحادثات

نشرح في هذا المقال كيفية تحديث عدة محادثات معًا عبر طلب واحد. طلب التعديل الجماعي أرسل طلب PUT لنقطة الاتصال conversations/ لتعديل عدة محادثات معًا بطلب واحد، إذ يمكنك نقل المحادثات جماعيًّا إلى صندوق بريد معين، أو تعديل الوسوم tags التي تصفها، أو المستخدمين المُسندة إليهم، وفق التالي: عنوان URL support.example.com/api/agent/v1/conversations جسم الطلب Body يكتب بصيغة JSON ويتضمن المعاملات التالية...

إضافة وحذف وكلاء من المحادثات

نشرح في هذا المقال كيفية إضافة وإزالة وكلاء أو موظفي دعم فني لمتابعة المحادثات. طلب إضافة وكيل لمحادثة لإضافة وكيل محدد من مركز المساعدة لمتابعة محادثة، أرسل طلب POST لنقطة الاتصال conversations/{conversation_id}/agents/ . مرر الرقم التعريفي للمحادثة conversation_id كمتغير مسار في عنوان الطلب، ومرر الرقم التعريفي للوكيل agent_id في جسم الطلب. مثال يضيف المثال التالي الوكيل رقم 1434 إلى المحادثة ر...

إضافة وإزالة وسوم من المحادثات

سنشرح في هذا المقال إضافة وسم لمحادثة واحدة أو عدة محادثات، وإزالة الوسوم من هذه المحادثات. يمكنك إضافة الوسوم إلى محادثات مركزك على مستوى المحادثة الواحدة أو على مستوى مجموعة محادثات معًا وإليك توضيح لكل منهما: طلب إضافة وسم واحد أرسل طلب POST لنقطة الاتصال conversations/{conversation_id}/tags/ مع تمرير الرقم التعريفي للمحادثة conversation_id كمتغير مسار في عنوان URL للطلب، وتمرير اسم الوسم بصيغ...

إضافة وإزالة جهة اتصال إلى محادثة

يمكنك إضافة جهة اتصال إلى محادثة معينة أو إزالتها عند الحاجة كما سنشرح في هذا المقال. طلب إضافة جهة اتصال لإضافة جهة اتصال لمحادثة معينة أرسل طلب POST لنقطة الاتصال conversations/{conversation_id}/contacts/ مع تمرير الرقم التعريفي للمحادثة conversation_id كمتغير مسار في عنوان URL للطلب، وتمرير الرقم التعريفي لجهة الاتصال contact_id في جسم الطلب. مثال يضيف المثال التالي جهة اتصال لها الرقم 426018...

إضافة وحذف ملاحظات المحادثات

نشرح في هذا المقال إدارة ملاحظات المحادثات ونتعرف على طريقة إضافة ملاحظة جديدة أوحذفها بشكل كامل أو حذف مرفق معين من ملاحظة. طلب إضافة ملاحظة لكتابة ملاحظة نصية عن محادثة معينة وإرفاق بعض الملفات معها، أرسل طلب POST إلى نقطة الاتصال conversations/{conversation_id}/notes/ مع تمرير الرقم التعريفي للمحادثة conversation_id كمتغير مسار في عنوان URL للطلب، وتمرير معلومات الملاحظة في جسم الطلب كما يلي:...

تعديل ملاحظات المحادثات

سنشرح في هذا المقال تعديل ملاحظة مكتوبة عن محادثة معينة أو إضافة مرفق جديد إلى مرفقاتها الموجودة أساسًا. تعديل محتوى ملاحظة لتعديل محتوى ملاحظة معينة أو إضافة مرفق جديد إلى مرفقاتها دون حذف المرفقات الأصلية، أرسل طلب من نوع PUT إلى نقطة الاتصال {conversations/{conversation_id}/notes/{note_id/ مع تمرير ما ترغب بتعديله من المعاملات التالية ضمن جسم الطلب: details سلسلة نصية string تحدد المحتوى النصي...

عرض تقييمات محادثة

سنشرح في هذا المقال طريقة عرض تقييمات العميل على محادثة في مركز المساعدة. طلب عرض التقييمات يمكن عرض تقييمات محادثة من خلال إرسال طلب GET لنقطة الاتصال conversations/{id}/reviews/ وتمرير رقم المحادثة التعريفي conversation_id في عنوان URL للطلب. مثال يوضح المثال التالي عرض التقييمات التي وضعها المستخدم على المحادثة رقم 510308 ضمن مركز مساعدة له النطاق support.example.com : curl --header 'Authoriza...

إسناد وكيل محادثة لنفسه

سنتشرح في هذا المقال طريقة إسناد الوكيل لمحادثة ضمن مركز المساعدة لنفسه طلب إسناد المحادثة يمكن للوكيل الذي سجل دخول إلى مركز المساعدة إسناد محادثة معينة لنفسه بإرسال طلب POST إلى نقطة الاتصال conversations/{conversation_id}/assign/ مع تضمين المعلومات التالية في الطلب: access token رمز الوصول الخاص بالوكيل. conversation_id الرقم التعريفي للمحادثة. updated_at وقت وتاريخ آخر تحديث أُجري على المحادث...

إدارة الرسائل ضمن محادثة

نشرح في هذا المقال نقاط الاتصال التي تساعدك على التعامل مع الرسائل الموجودة ضمن المحادثات من عرض وتعديل وحذف. عرض رسائل محادثة أرسل طلب GET لنقطة الاتصال {conversations/{conversation_id}/messages/{message_id/ للحصول على رسالة من محادثة معينة، مع تمرير الرقم التعريفي للمحادثة conversation_id والرقم التعريفي للرسالة message_id كمتغيرات مسار ضمن عنوان URL للطلب. مثال يعرض المثال التالي تفاصيل الرسال...

عرض سجل التغييرات على محادثة

نوضح في هذا المقال طريقة تتبع التغييرات التي أجراها وكلاء مركز المساعدة على محادثة معينة. طلب عرض سجل التغييرات أرسل طلب GET لنقطة الاتصال conversations/{conversation_id}/history/ لتتبع تغييرات المحادثة بداية من الإنشاء مرورًا بأي تعديل كتغيير حالة المحادثة، وإضافة الوسوم أو الملاحظات أو جهات الاتصال لها أو غير ذلك وفق ما يلي: عنوان URL https://support.example.com/api/agent/v1/conversations/{conv...