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

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

نشرح في هذا المقال نقاط الاتصال التي تساعدك على التعامل مع الرسائل الموجودة ضمن المحادثات من عرض وتعديل وحذف.

عرض رسائل محادثة

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

مثال

يعرض المثال التالي تفاصيل الرسالة رقم 2671132 ضمن المحادثة رقم 509339 ضمن مركز مساعدة له النطاق support.example.com:

curl  --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/509339/messages/2671132'

وللحصول على كافة الرسائل ضمن المحادثة 509339 سنكتب الطلب بالصيغة التالية:

curl  --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/509339'

تعديل رسالة ضمن محادثة

يمكن تعديل أي رسالة ترسلها عبر محادثات زيتون خلال مدة خمس دقائق فقط بعد إرسالها من خلال طلب PUT لنقطة الاتصال {conversations/{conversation_id}/messages/{message_id/ مع تمرير الرقم التعريفي للمحادثة conversation_id والرقم التعريفي للرسالة message_id كمتغيرات مسار ضمن عنوان URL للطلب، وتضمين المعاملات التالية ضمن جسم الطلب:

content	سلسلة نصية string، تكتب ضمنها المحتوى المعدل للرسالة.
attachments	مصفوفة أعداد صحيحة، تمرر ضمنه المرفقات التي تود إضافتها إلى الرسالة زيادة على مرفقاتها الموجودة.

مثال

لاحظ المثال التالي لتعديل محتوى رسالة رقم 2673833 ضمن المحادثة رقم 509339، حيث سنعدل محتوى الرسالة إلى edit your message ونضيف لها مرفقًا جديدًا برقم 1410778.

curl -X PUT --header 'Authorization: Bearer your_token' --header 'Content-Type: application/json' --data '{
"content": "edit your message",
"attachments": [1410778]
}'
'https://support.example.com/api/agent/v1/conversations/509339/messages/2673833'

ملاحظة: لا يعني تمرير مرفقات جديدة استبدال المرفقات الأصلية إنما الإضافة عليها، أما إذا رغبت بحذف مرفق من الرسالة فاستخدم نقطة الاتصال الموضحة في الفقرة التالية.

حذف مرفق من الرسالة

لحذف مرفق معين من رسالة أرسل طلب DELETE لنقطة الاتصال {conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id/ مع تمرير المعلومات التالية كمتغيرات مسار ضمن عنوان URL للطلب:

conversation_id	الرقم التعريفي للمحادثة.
message_id	الرقم التعريفي للرسالة.
attachment_id	الرقم التعريفي للمرفق المراد حذفه.

مثال

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

curl -X DELETE --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/509339/messages/2673833/attachments/1410778'

حذف رسالة ضمن محادثة

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

مثال

يحذف المثال التالي الرسالة رقم 2673833 من المحادثة رقم 509339 ضمن مركز المساعدة:

curl -X DELETE --header 'Authorization: your_token' 'https:/support.example.com.com/api/agent/v1/conversations/509339/messages/2673833'

تعيين بعض الرسائل كمقروءة

لتغيير حالة رسائل محادثة من غير مقروءة لمقروءة، أرسل طلب POST لنقطة الاتصال conversations/{conversation_id}/messages/mark-read/ مع تمرير الرقم التعريفي للمحادثة conversation_id كمتغير مسار ضمن عنوان URL للطلب، وتمرير الأرقام التعريفية للرسائل المراد تعيينها كمقروءة ضمن المصفوفة message_ids في جسم الطلب.

مثال

يضع الطلب التالي علامة مقروءة على مجموعة من الرسائل المحددة ضمن المحادثة ذات الرقم التعريفي 510638، ويحددالرسائل التي ستعين كمقروءة باستخدام أرقامها التعريفية 2676821 و 2676816:


curl -X POST --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token'  --data '{
"message_ids": [2676821, 2676816]
}' 'https://support.example.com/api/agent/v1/conversations/510638/messages/mark-read'

عرض مرفق ضمن الرسالة

لعرض مرفق معين من مرفقات الرسالة أرسل طلب GET لنقطة الاتصال التالية conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/preview/ حيث ستعيد لك الواجهة البرمجية عنوان URL الخاص بالمرفق لتتمكن من عرضه في تطبيقك.

ينبغي أن يتضمن الطلب GET متغيرات المسار التالية:

conversation_id	الرقم التعريفي للمحادثة.
message_id	الرقم التعريفي للرسالة.
attachment_id	الرقم التعريفي للمرفق المراد عرضه.

مثال

ألقِ نظرة على المثال التالي لعرض المرفق رقم 261421 المرتبط بالرسالة رقم 2674190 داخل المحادثة رقم 510125 ضمن مركز المساعدة.

curl --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/510125/messages/2674190/attachments/261421/preview'

تحميل مرفق من الرسالة

يمكنك تحميل أي مرفق يأتي مع الرسالة وحفظه على جهازك المحلي بإرسال طلب POST لنقطة الاتصال conversations/{conversation_id}/messages/message_id}/attachments/{attachment_id}/download مع تمرير متغيرات المسار التالية ضمن جسم الطلب:

conversation_id	الرقم التعريفي للمحادثة.
message_id	الرقم التعريفي للرسالة.
attachment_id	الرقم التعريفي للمرفق المطلوب تنزيله.

مثال

لاحظ المثال التالي الذي يطلب تنزيل مرفقات إحدى الرسائل في مركز المساعدة وحفظها محليًّا:

curl -X POST --header 'Authorization: Bearer your_token' 'https://support.example.com/api/agent/v1/conversations/510125/messages/2674190/attachments/261421/download' -o download_attachment.png