إضافة شخص

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

    سنشرح في هذا المقال كيفية إضافة شخص جديد إلى مركز المساعدة.

    طلب إضافة شخص

    يمكنك إرسال طلب من نوع POST إلى نقطة الوصول contacts/ لإضافة شخص جديد إلى جهات اتصال مركز المساعدة، وفق التالي:

    عنوان URL

    https://{your_subdomain}/api/agent/v1/contacts

    جسم الطلب Body

    يُكتب بصيغة JSON ويتضمن المعاملات التالية

    first_name

    نوعه سلسلة نصية string، يحدد الاسم الأول للشخص الجديد المراد إضافته.

    last_name

    نوعه سلسلة نصية string، يحدد اسم عائلة الشخص الجديد المراد إضافته.

    avatar

    نوعه سلسلة نصية string، يستخدم لتمرير الصورة الشخصية للشخص بصيغة base64.

    status

    نوعه سلسلة نصية string، يحدد حالة الشخص المُضاف، ويقبل حصرًا إحدى القيم التالية:

    • active فعَّال
    • banned محظور
    • deleted محذوف

    avatar_url

    نوعه سلسلة نصية string، تُمَرِّر ضمنه رابط صورة الشخص بدلًا من رفعها إلى الخادم.

    locale

    نوعه سلسلة نصية string، يحدد الإعدادات المحلية أي إعدادات اللغة للشخص، ويأخذ إحدى القيمتين ar أو en.

    company_id

    نوعه عدد صحيح integer، تُمَرِر ضمنه الرقم التعريفي id للشركة التي تود ضم الشخص الجديد إليها.

    assign_to

    نوعه عدد صحيح integer، تُمَرِر ضمنه الرقم التعريفي id للوكيل الذي تود إسناد الشخص الجديد إليه.

    custom_fields

    نوعه عنصر object مركب من عدة عناصر، يمثل كل عنصر منها أحد الحقول المخصصة الخاصة بتعريف الأشخاص في حال استخدامك لها

    تمرير الحقول المخصصة

    تكتب الحقول المخصصة وفق الصيغة العامة التالية:

    "custom_fields": {
               "field_{field id}": "your custom field value"
         }

    علمًا أنك تستطيع معرفة الرقم التعريفي للحقل المخصص الفرعي {field id} ضمن مجموعة الحقول المخصصة المستخدمة لتعريف الأشخاص في مركزك عبر إرسال طلب GET لنقطة الوصول {custom-fields/{id/.
    وتختلف قيمة الحقل المخصص حسب نوعه، فإذا كان الحقل المخصص من نوع نص text فتكتب قيمته بصيغة سلسلة نصية string، كما في المثال التالي الخاص بحقل العنوان:

    "custom_fields": {
               "field_33525": "عنوان الشخص"
         }

    وإذا كان الحقل المخصص من نوع ملفات files، فيمكنك إما تمرير الملفات بصيغة base64 أو binary كما يلي:

    "custom_fields": {
               "field_33525":{
                    "files": ["file1 as base64", "file2 as base64"]
                 }
         }

    أو تمرير الأرقام التعريفية للملفات المُحَمَّلة مسبقًا بواسطة نقطة الوصول files/ أو files/images/ كما في المثال التالي: 

    "custom_fields": {
               "field_33525":{
                     "ids": [1, 2, 3]
                 }
         }

    وإذا كان الحقل المخصص من نوع صندوق اختيار checkbox يتضمن عدة خيارات، فيُكتب بصيغة مصفوفة تتضمن الأرقام التعريفية للاختيارات المطلوبة وفق التالي:

    "custom_fields": {
               "field_35413": [1, 2, 3]
         }

    مثال

    يبين المثال التالي إضافة شخص جديد لمركز مساعدة له النطاق الفرعي support.example.com وضمه إلى الشركة رقم 265 ضمن المركز، وإسناده إلى الوكيل رقم 1434 ليتابع المحادثات معه:

    curl -X POST --header 'Authorization: Bearer your_token' --header 'Content-Type: application/json' --data '{
    "first_name": "Ali",
    "last_name": "Ahmad",
    "avatar": "contact_avatar_in_base64",
    "status": "active",
    "locale": "ar",
    "custom_fields": {
               "field_34424": "client_national_id"
         },
    "company_id": "265",
    "assign_to": "1434"
    }' 'https://support.example.com/api/agent/v1/contacts'


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