البحث في مركز المساعدة

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

لتطبيق الأمثلة، سنفترض وجود مركز مساعدة على النطاق example.com، ومفتاح الواجهة البرمجية لزيتون مخزن ضمن متغير TOKEN$ لاستخدامه في الطلبات المختلفة.

export TOKEN="YOUR_API_KEY"

البحث في مركز المساعدة

يمكن إرسال طلب من النوع GET إلى نقطة الوصول Search من أجل البحث في مختلف أنواع البيانات المسجلة في مركز المساعدة سواء كانت جهات اتصال، أو وكلاء، أو مقالات، أو استلامات نماذج أو غيره.

شخص حسب البريد الإلكتروني

للبحث عن شخص حسب بريده الإلكتروني، مثلًا الشخص الذي يملك البريد ahmad@example.com نكتب الطلب التالي:

curl "https://example.com/api/agent/v1/search?in[]=contacts&query=ahmad@example.com" \
  -H "Authorization: Bearer @TOKEN" \
  --globoff

وكيل حسب الاسم

للبحث عن وكيل باسم Ali على سبيل المثال ضمن وكلاء مركز المساعدة نكتب الطلب التالي:

curl "https://example.com/api/agent/v1/search?in[]=agents&query=Ali" \
  -H "Authorization: Bearer @TOKEN" \
  --globoff

جهة اتصال حسب الاسم

للبحث عن كافة جهات الاتصال سواء شركات أو أشخاص تتضمن أسماؤها كلمة معينة ولتكن "new"على سبيل المثال، مع إظهار أول 10 نتائج بحث نكتب الطلب على النحو التالي:

curl "https://example.com/api/agent/v1/search?in[]=contacts&in[]=companies&query=new&skip=0&limit=10" \
  -H "Authorization: Bearer @TOKEN" \
  --globoff

ولإظهار الصفحة الثانية من نتائج البحث نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/search?in[]=contacts&in[]=companies&query=new&skip=10&limit=10" \
  -H "Authorization: Bearer @TOKEN" \
  --globoff

كلمة في مركز المساعدة

للبحث عن كلمة "الدعم" مثلًا ضمن كافة بيانات مركز المساعدة بما فيها جهات الاتصال والمحادثات والمقالات وغيرها نكتب الطلب التالي:

curl "https://example.com/api/agent/v1/search?query=الدعم&in[]=agents&in[]=companies&in[]=contacts&in[]=articles&in[]=conversations&in[]=form_submissions&in[]=categories&skip=0" \
  -H "Authorization: Bearer @TOKEN" \
  --globoff

كلمة في مقال

للبحث عن كلمة "الدعم" مثلًا ضمن المقالات فقط نكتب الطلب التالي:

curl "example.com/api/agent/v1/search?query=الدعم&in[]=articles&limit=10&skip=0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer @TOKEN"