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

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

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

    طلب إضافة ملاحظة

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

    details

    نص الملاحظة ونوعه سلسلة نصية string

    attachments

    نوعه مصفوفة أعداد صحيحة array تمرر ضمنها الأرقام التعريفية للمرفقات.

    ملاحظة: ينبغي أن تتضمن الملاحظة نص أو مرفق أو كليهما معًا.

    مثال

    يضيف المثال التالي ملاحظة جديدة لها النص write your note إلى المحادثة رقم 509643، تحتوي هذه الملاحظة مرفق واحد له الرقم 1410778. 

    curl -X POST --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' --data '{
    "details": "write your note",
    "attachments": [1410778]
    }' 'https://support.example.com/api/agent/v1/conversations/509643/notes'

    طلب حذف مرفق من ملاحظة

    يمكنك حذف المرفق من ملاحظة عائدة لمحادثة معينة بإرسال طلب DELETE إلى نقطة الاتصال ‎‏‏conversations/{conversation_id}/notes/{note_id}/attachments/{attachment_id}‎/ مع تمرير كل من المعاملات التالية كمتغيرات مسار في عنوان URL للطلب:

    conversation_id

    الرقم التعريفي للمحادثة.

    note_id

    الرقم التعريفي للملاحظة.

    attachment_id

    الرقم التعريفي للمرفق المراد حذفه من الملاحظة.

    مثال

    لاحظ المثال التالي لحذف أحد مرفقات الملاحظة رقم 336440 الخاصة بالمحادثة رقم 509339 ضمن مركز مساعدة له النطاق support.example.com:

    curl -X DELETE --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/509339/notes/336440/attachments/261227

    ملاحظة: سيحذف المرفق رقم 261227 فقط من الملاحظة ويبقى المحتوى النصي للملاحظة وأي مرفقات أخرى في حال وجودها.

    طلب حذف ملاحظة

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

    علمًا أنك تستطيع عرض كافة الملاحظات المكتوبة عن محادثة معينة ومعرفة أرقامها التعريفية بإرسال طلب GET إلى نقطة الاتصال conversations/{conversation_id}/notes/.

    مثال

    يحذف المثال التالي الملاحظة رقم 336438 من سجل الملاحظات الخاص بالمحادثة رقم 509339 ضمن مركز مساعدة له النطاق support.example.com.

    curl -X DELETE --header 'Authorization: Bearer your_token' 'https://support.example.com.com/api/agent/v1/conversations/509339/notes/336438'
    محتويات الصفحة