تعديل إعدادات صندوق البريد

يمكنك تعديل إعدادات أي صندوق البريد وتخصيصه بالطريقة التي تناسبك باستخدام أكثر من نقطة وصول في واجهة زيتون البرمجية:

1. {inboxes/{id/ لتعديل الإعدادات الأساسية لصندوق البريد.
2. inboxes/save/ لتعديل كافة إعدادات صندوق البريد.
3. inboxes/{inbox_id}/emails/ لإضافة بريد إلكتروني إلى صندوق البريد.
4. {inboxes/{inbox_id}/emails/{email_id/ لتعديل أحد عناوين البريد الإلكتروني المرتبطة بصندوق بريد معين، سواءً بتعديل عنوانه email أو حالته status.
5. {inboxes/{inbox_id}/emails/{email_id/ لحذف أحد عناوين البريد الإلكتروني المرتبطة بصندوق بريد معين.
6. inboxes/{inbox_id}/teams/ لإضافة فريق عمل إلى إعدادات صندوق البريد.
7. {inboxes/{inbox_id}/teams/{team_id/ لحذف فريق عمل من إعدادات صندوق البريد.
8. inboxes/{inbox_id}/agents/ لإضافة مستخدم إلى إعدادات صندوق البريد.
9. {inboxes/{inbox_id}/agents/{agent_id/ لحذف مستخدم من إعدادات صندوق البريد.
10. inboxes/{inbox_id}/sort/ لتعديل الترتيب أو التسلسل الداخلي لصندوق البريد ضمن قائمة صناديق بريد مركز المساعدة.

أمثلة

لنطبق الآن مثالًا عمليًّا على كل نقطة اتصال endpoint، سنستخدم في أمثلتنا مركز مساعدة تجريبي يدعى "المناسب al-munasib" له النطاق الفرعي al-munasib.zaetoon.com.

تعديل إعدادات الصندوق بواسطة {inboxes/{id/

تساعدك نقطة الاتصال هذه على تعديل الإعدادات التالية لأي صندوق بريد في مركز المساعدة عن طريق تمريرها كمعاملات في جسم الطلب المرسل وهو من نوع PUT:

• اسم الصندوق name (معامل إجباري).
• الوصف description.
• الرابط slug (معامل إجباري).
• التسلسل sort (معامل إجباري).
• تفعيل أو تعطيل رسالة الرد التلقائي send_autoresponse.
• نص رسالة الرد التلقائي auto_responsetext.
• تفعيلأو تعطيل رسالة التقييم send_rating_request (معامل إجباري).
• نص رسالة التقييم rating_message.
• دون أن ننسى تمرير الرقم التعريفي لصندوق البريد "id" كمتغير مسار path parameter ضمن عنوان URL للطلب.

لنأخذ مثلًا صندوق البريد "new_inbox_name" الذي أنشأناه في الفقرة السابقة، والذي يحمل الرقم التعريفي "2281" ونحاول تعديل اسمه ليصبح "inbox_name" مع تعطيل ميزتي الرد التلقائي وطلب التقييم المُفَعّلتين سابقًا عند إنشاء الصندوق:

curl -X PUT --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' --data '{
"name": "inbox_name",
"slug" :"new-inbox",
"sort": 6,
"send_rating_request": false,
"send_autoresponse": false
}' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281' 

لاحظ أن طلب التعديل ينبغي أن يتضمن دائمًا المعاملات الإجبارية (حتى إذا لم نكن نرغب بتعديلها) بالإضافة إلى أي معاملات أخرى نريد تعديلها.

تعديل إعدادات الصندوق بواسطة inboxes/save/

ذكرنا أن نقطة الوصول هذه تملك وظيفتين: إنشاء صندوق بريد جديد، وتعديل إعدادات صندوق بريد موجود، وما يميز وظيفة عن أخرى هو استخدام المعامل "id" فاستخدامه يعني أننا نُعَدِّل إعدادات صندوق البريد ذو الرقم التعريفي "id".

كما شرحنا معاملات نقطة الاتصال بالتفصيل في المثال السابق"إنشاء صندوق بريد بواسطة نقطة الاتصال inboxes/save/" والآن سنعطيك مثالًا على استخدامها لتعديل بعض إعدادات صندوق البريد ذو الرقم "2281":

curl -X post -header 'Content-Type: application/json' --header 'Authorization: Bearer your_token'
--data '{"id": 2281,
"name": "new_inbox",
"slug" :"new-inbox",
"send_autoresponse": true,
"autoresponse_text": "your_new_text",
"send_rating_request": false,
"team_ids": [2256, 2142, 2143]
}' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/save'

وهنا أيضًا ينبغي أن يتضمن الطلب المعاملات الإجبارية لنقطة الاتصال مع أي معاملات أخرى نريد تعديلها.

إضافة بريد إلكتروني للصندوق

تساعدك نقطة الاتصال inboxes/{inbox_id}/emails/ على إضافة بريد إلكتروني جديد إلى عناوين البريد الإلكتروني المرتبطة بصندوق بريد معين، كما في المثال التالي:

curl -X POST --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' --data '{"email": "test@gmail.com",
"status": "secondary"}' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/emails' 

لاحظ أننا مررنا الرقم التعريفي لصندوق البريد inbox_id (وهو في مثالنا "2281") كمتغير مسار ضمن عنوان URL.

تعديل أحد عناوين البريد الإلكتروني للصندوق

يمكنك أيضًا إرسال طلب من نوع PUT إلى نقطة الاتصال {inboxes/{inbox_id}/emails/{email_id/ لتعديل معلومات البريد الإلكتروني ذو الرقم التعريفي "email_id" الموجود ضمن إعدادات صندوق البريد ذو الرقم التعريفي "inbox_id".

تُمَرِّر كل من "email_id" و "inbox_id" كمتغيرات مسار ضمن عنوان URL، وتُمَرِّر معلومات البريد الإلكتروني التي تود تعديلها ضمن جسم الطلب، علمًا أنك تستطيع تعديل اسم البريد الإلكتروني email أو حالته status أو تعدل الاثنين معًا في طلب واحد.

لنفترض على سبيل المثال أننا ارتكبنا خطأ املائي بكتابة عنوان البريد الإلكتروني ذو الرقم "2291" الذي أضفناه في الخطوة السابقة، وسنعمل الآن على تعديله:

curl -X PUT --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' --data '{"email": "test@exampel.com"}' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/emails/2291'

حذف أحد عناوين البريد الإلكتروني من إعدادات الصندوق

أرسل طلب من نوع DELETE إلى نقطة الاتصال {inboxes/{inbox_id}/emails/{email_id/ إذا رغبت بحذف عنوان بريد إلكتروني معين من إعدادات صندوق البريد.

لنحذف مثلًا عنوان البريد الإلكتروني ذو الرقم التعريفي "2291" من إعدادات صندوق البريد "2281":

curl -X DELETE --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/emails/2291'

إضافة فريق عمل لصندوق البريد

تستطيع إضافة فريق عمل إلى صندوق البريد ومنحه صلاحية الوصول إلى الصندوق بإرسال طلب من نوع POST إلى نقطة الاتصال inboxes/{inbox_id}/teams/ مع تمرير رقم صندوق البريد "inbox_id" كمتغير مسار في عنوان URL للطلب، وإرسال رقم فريق العمل "team_id" المراد إضافته ضمن جسم الطلب، كما في المثال التالي:

curl -X POST --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' --data '{"team_id": 2238}' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/teams'

حذف فريق عمل من إعدادات الصندوق

يمكنك حذف فريق العمل من إعدادات صندوق البريد (أو سحب الصلاحية منه) بإرسال طلب من نوع DELETE إلى نقطة الاتصال {inboxes/{inbox_id}/teams/{team_id/ مع تمرير كل من رقم صندوق البريد ورقم فريق العمل كمتغيرات مسار في عنوان URL للطلب كما يلي:

curl --X DELETE --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/teams/2238' 

إضافة مستخدم لإعدادات الصندوق

أرسل طلب من نوع POST إلى نقطة الاتصال inboxes/{inbox_id}/agents/ إذا رغبت بمنح أحد المستخدمين صلاحيات الوصول إلى صندوق بريد معين، وذلك عبر تمرير الرقم التعريفي لصندوق "inbox_id" كمتغير مسار ضمن عنوان URL للطلب، والرقم التعريفي للمستخدم "agent_id" ضمن جسم الطلب.

يبين المثال التالي إضافة المستخدم ذو الرقم "1516" إلى صندوق البريد "2281":

curl -X POST --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' --data '{"agent_id": "1516"}' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/agents' 

حذف مستخدم من إعدادات الصندوق

يجري حذف أحد المستخدمين من إعدادت صندوق البريد بإرسال طلب من نوع DELETE إلى نقطة الاتصال {inboxes/{inbox_id}/agents/{agent_id/ مع تمرير كل من الرقم التعريفي لصندوق البريد "inbox_id" والرقم التعريفي للمستخدم "agent_id" كمتغيرات مسار ضمن عنوان URL للطلب.

يحذف المثال التالي المستخدم ذو الرقم "1516" من إعدادات صندوق البريد "2281":

curl -X DELETE --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/agents/1516'

تعديل تسلسل ترتيب صندوق البريد

يساعدك معامل الفرز sort على التحكم بترتيب صندوق بريد معين ضمن قائمة صناديق البريد الخاصة بمركز المساعدة.

وذلك بإرسال طلب من POST إلى نقطة الاتصال inboxes/{inbox_id}/sort/ مع تمرير الرقم التعريفي لصندوق البريد "inbox_id" كمتغير مسار ضمن عنوان URL للطلب POST ووضع قيمة "sort" الجديدة وهي من نوع integer ضمن جسم الطلب، كما في المثال التالي:

لنفترض مثلًا أننا نرغب بتغيير ترتيب صندوق البريد ذو الرقم "2281" ليصبح الصندوق الأول في قائمة صناديق بريد مركز مساعدة "المناسب"، وبذلك سيظهر دائمًا كأول عنصر في أي استعلام تطلبه عن صناديق بريد المركز، فسنكتب عندها الأمر التالي:

curl -X POST --header 'Content-Type: application/json' --header 'Authorization: Bearer your_token' --data '{"sort": 0}' 'https://al-munasib.zaetoon.com/api/agent/v1/inboxes/2281/sort'

لا تنسَ تعديل قيمة "sort" لصندوق البريد الذي يتمتع في الأصل بالترتيب الأول أي جعل قيمة "sort" له تساوي "0" لتحصل على الترتيب المرغوب لصندوقك بدقة.