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

محتويات الصفحة

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

    طلب عرض محادثة

    أرسل طلب من نوع GET لنقطة الوصول {conversations/{id/ وفق التالي:

    عنوان URL

    https://{your_subdomain}/api/agent/v1/conversations/{id}

    معاملات المسار

    معامل واحد إجباري هو الرقم التعريفي للمحادثة id ونوعه عدد صحيح integer.

    معاملات الاستعلام

    جميعها معاملات اختيارية تستخدم للتحكم بالمعلومات المسترجعة من محادثة محددة وهي كالتالي:

    contact_ids

    نوعه مصفوفة أعداد صحيحة array، نمرر من خلالهالأرقام التعريفية للمحادثات التي نريد عرض المحادثات السابقة previous أو اللاحقة later لها والتي أجريت بين جهات الاتصال المشتركة بالمحادثات المستعلم عنها.

    limit

    نوعه عدد صحيح integer، يحدد عدد المحادثات المعروضة ضمن الاستجابة، وقيمته الافتراضية 6.

    load

    نوعه مصفوفة array، يقبل القيمتين التاليتين حصرًا:

    • previous لعرض المحادثات السابقة للمحادثة المُستعلم عنها والتي اشتركت بها جهات الاتصال المذكورة ضمن contact_ids.
    • later لعرض المحادثات اللاحقة للمحادثة المُستعلم عنه والتي اشتركت بها جهات الاتصال المذكورة ضمن contact_ids.

    merged_conversation

    نوعه منطقي boolean، إذا أعطيته القيمة true فإنه يعرض الأرقام التعريفية للمحادثات المدمجة سابقًا مع المحادثة التي نستعلم عنها في حال وجودها.

    messages_sort

    نوعه سلسلة نصية string، يأخذ إحدى القيمتين التاليتين:

    • asc لعرض رسائل المحادثة بترتيب تصاعدي لتاريخ إنشائها.
    • desc لعرض رسائل المحادثة بترتيب تنازلي لتاريخ إنشائها.

    simple_view

    نوعه منطقي boolean، إذا أعطيته القيمة true فستحصل في الاستجابة على معلومات مختصرة عن المحادثة التي تستعلم عنها، على سبيل المثال لن تظهر سوى آخر رسالة فقط من رسائل المحادثة.

    ملاحظة: إذا كانت المحادثة التي تستعلم عنها باستخدام نقطة الوصول هذه مدمجة مع محادثات أخرى فستحصل ضمن معلومات الاستجابة على رسالة مفادها conversation.merged_with أي تم دمج المحادثة المطلوبة بمحادثة أخرى لإشعارك بعملية الدمج.

    مثال

    لاسترجاع المحادثة رقم 429245 ضمن مركز مساعدة له النطاق support.example.com مع تفعيل خيار إظهار المحادثات السابقة واللاحقة لاثنين من جهات الاتصال المشتركين بها، بالإضافة إلى ترتيب الرسائل ترتيبًا تصاعديًّا نكتب الطلب التالي:

    curl --globoff --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/510125?contact_ids[]=429245&contact_ids[]=426016&load[]=previous&load[]=later&merged_conversation=true&messages_sort=asc'
    محتويات الصفحة