عرض سجل التغييرات على محادثة
محتويات الصفحة
نوضح في هذا المقال طريقة تتبع التغييرات التي أجراها وكلاء مركز المساعدة على محادثة معينة.
طلب عرض سجل التغييرات
أرسل طلب GET لنقطة الاتصال conversations/{conversation_id}/history/ لتتبع تغييرات المحادثة بداية من الإنشاء مرورًا بأي تعديل كتغيير حالة المحادثة، وإضافة الوسوم أو الملاحظات أو جهات الاتصال لها أو غير ذلك وفق ما يلي:
عنوان URL
https://support.example.com/api/agent/v1/conversations/{conversation_id}/history.
معاملات المسار
معامل واحد فقط هو conversation_id الرقم التعريفي للمحادثة التي ترغب بعرض سجل تغييراتها، نوع المُعامِل عدد صحيح integer، وهو معامل إجباري.
معاملات الاستعلام
جميعها معاملات اختيارية وهي كالتالي:
after | نوعه مصفوفة array، يساعدك على عرض التغييرات التي يتجاوز رقمها التعريفي id حد معين، أو التي حدثت بعد تاريخ معين، أو التي تحقق الشرطين معًا. |
before | نوعه مصفوفة array، يساعدك على عرض التغييرات التي يقل رقمها التعريفي id عن حد معين، أو التي حدثت قبل تاريخ معين، أو التي تحقق الشرطين معًا. |
event | نوعه سلسلة نصية string، يساعدك في عرض التغييرات التي تتعلق بنوع معين من الأحداث. |
limit | نوعه عدد صحيح integer، يساعدك على التحكم بعدد التغييرات التاريخية المعروضة في الاستجابة response، قيمته الافتراضية 6 ما لم تعطيه قيمة مغايرة، وأكبر قيمة يقبلها هي 100. |
sort | نوعه سلسلة نصية string، يساعدك على ترتيب التغييرات الحاصلة على المحادثة تصاعديًّا أو تنازليًّا تبعًا لتاريخ حدوثها، ويقبل القيمة created_at.desc أو created_at.asc. |
مثال
لعرض سجل التغييرات للمحادثة رقم 509339 في مركز مساعدة له النطاق support.example.com متضمنًا التغييرات التي طرأت بين تاريخين ونتج عنها تغيير في حالة المحادثة وترتيب النتائج تصاعديًا، نكتب التالي:
curl --globoff --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/509339/history?limit=100&after[created_at]=2024-09-01T00%3A00%3A00&before[created_at]=2024-09-16T00%3A00%3A00&sort=created_at.asc&event=status.updated'