إضافة الشخص

في هذا المقال سنتعلم عملياً كيفية التعامل مع الأشخاص في مركز المساعدة باستخدام واجهة زيتون (API)، بدايةً من عرض بيانات الأشخاص وصولاً إلى إضافتها وتعديلها وحذفها.

عرض شخص

يُمكنك عرض بيانات شخص محدد باستخدام معرفه التعريفي، على سبيل المثال لعرض الشخص ذو المعرف 1001 نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts/1001" \
  -H "Authorization: Bearer $TOKEN"

تصفية أشخاص

يُمكن تصفية نتائج عرض الأشخاص باستخدام معاملات الاستعلام (Query Parameters)، على سبيل المثال لعرض الأشخاص المحذوفين نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts?trashed=1" \
  -H "Authorization: Bearer $TOKEN"

ولعرض الأشخاص المسجلين والمسندين للوكيل رقم 1008 نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts?assign_to=1008" \
  -H "Authorization: Bearer $TOKEN"

أما لعرض أشخاص تابعين للشركة ذات المٌعرف 1008 نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts?company_ids[]=1008" \
  -H "Authorization: Bearer $TOKEN" \
  --globoff

وإن كنت ترغب بعرض أشخاص ضمن فئة رقم 800 نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts?limit=25&sort=last_seen_at.desc&segment_ids[]=800" \
  -H "Authorization: Bearer $TOKEN" \
  --globoff

ولعرض أشخاص مشتركين بوسم مثل "مميز" نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts?tags[]=مميز&sort=created_at.asc" \
  -H "Authorization: Bearer $TOKEN" \
  --globoff

إضافة شخص

يُمكنك إضافة بيانات شخص جديد كإسمه والكنية والصورة المصغرة، على سبيل المثال لإضافة شخص جديد لمركز المساعدة باللغة العربية وضمّه للشركة رقم 1002 وإسناده للوكيل رقم 1008 نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Saleh",
    "last_name": "Amin",
    "avatar": "contact_avatar_in_base64",
    "status": "active",
    "locale": "ar",
    "custom_fields": {
        "field_national_id": "12465000"
    },
    "company_id": "1002",
    "assign_to": "1008"
}'

تعديل شخص

يُمكنك تعديل بيانات الشخص بسهولة، على سبيل المثال لتعديل اسم الشخص رقم 1001 وإضافته إلى الشركة رقم 1002 وإضافة رقمه الوطني كحقل مخصص نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts/1001" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Saleh",
    "last_name": "Amin",
    "custom_fields": {
      "field_national_id": "12465000"
    },
    "company_id": "1002"
  }'

حذف شخص

لحذف شخص من مركز المساعدة على سبيل المثال الشخص ذو المعرف 1001 نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts/1001" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN"

ملاحظة: لا يتم حذف الشخص نهائياً، بل يُنقل لسلة المحذوفات ويُمكن استعادته لاحقاً.

على سبيل المثال لإستعادة نفس الشخص لقائمة الأشخاص النشطين نرسل الطلب التالي:

curl "https://example.com/api/agent/v1/contacts/1001/restore" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

إقرأ أيضاً

• الإتصال بالواجهة البرمجية
• فئات العملاء
• الحقول المخصصة للعملاء