إنشاء وكيل

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

    نوضح في هذا المقال طريقة إنشاء وكيل جديد في مركز المساعدة.

    طلب إنشاء وكيل

    يمكنك إنشاء وكيل agent جديد في مركز المساعدة الذي تديره بإرسال طلب من نوع POST إلى نقطة الاتصال agents/ وفق التالي:

    عنوان URL

    support.example.com/api/agent/v1/agents

    جسم الطلب Body

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

    first_name

    معامل إجباري، نوعه سلسلة نصية string، يحدد الاسم الأول للوكيل الجديد.

    last_name

    معامل إجباري، نوعه سلسلة نصية string، يحدد اسم عائلة الوكيل الجديد.

    avatar

    معامل إجباري، نوعه سلسلة نصية string، يحدد مسار تخزين الصورة الشخصية للوكيل الجديد.

    email

    معامل إجباري، نوعه سلسلة نصية string، يُحَدِّد البريد الإلكتروني للوكيل الجديد.

    password

    معامل إجباري، نوعه سلسلة نصية string، تضبط بواسطته كلمة المرور الخاصة بالوكيل الجديد.

    password_confirmation

    معامل إجباري، نوعه سلسلة نصية string، يستعمل لتأكيد كلمة مرور الوكيل.

    status

    معامل إجباري، نوعه سلسلة نصية string، يحدد حالة حساب الوكيل الجديد إذا كان فعالًا أم لا، ويقبل القيمة active أو inactive أو deleted.

    locale

    معامل اختياري، نوعه سلسلة نصية string، يحدد الإعدادات المحلية لحساب الوكيل الجديد، ويقبل إحدى القيمتين ar أو en.

    online_status

    معامل اختياري، نوعه سلسلة نصية string، يحدد حالة ظهور الوكيل الجديد، ويقبل القيمة online أو away أو invisible أو inactive.

    inbox_ids

    معامل اختياري، نوعه مصفوفة أعداد صحيحة array، يُحَدِّد الأرقام التعريفية لصناديق البريد التي ترغب بأن يكون للوكيل الجديد صلاحية عليها، علمًا أنك تستطيع معرفة الأرقام التعريفية لصناديق البريد بإرسال طلب GET إلى نقطة الاتصال inboxes/.

    team_ids

    معامل اختياري، نوعه مصفوفة أعداد صحيحة array، يُحَدِّد الأرقام التعريفية لفرق العمل التي ترغب بأن ينتمي إليها الوكيل الجديد، علمًا أنك تستطيع معرفة الأرقام التعريفية لفرق العمل بإرسال طلب GET إلى نقطة الاتصال teams/.

    form_ids

    معامل اختياري، نوعه مصفوفة أعداد صحيحة array، يُحَدِّد الأرقام التعريفية لنماذج التواصل التي ترغب بأن يكون للوكيل الجديد صلاحية عليها، علمًا أنك تستطيع معرفة الأرقام التعريفية للنماذج بإرسال طلب GET إلى نقطة الاتصال forms/.

    custom_fields

    استخدم هذا المعامل إذا أنشأت حقولًا مخصصة تُضاف إلى الحقول الافتراضية التي توفرها زيتون لتعريف الوكلاء الجدد، نوع هذا المعامل هو مصفوفة array تتألف من عدة عناصر objects يمثل كل عنصر منها أحد الحقول المخصصة تمرر فيه قيم الحقول الخاصة بالوكيل الجديد كاسم بلده، أو وصف مهاراته، أو صورة بطاقته الشخصية. يمكنك معرفة معلومات عن الحقول المخصصة المتعلقة بتعريف الوكلاء بإرسال طلب GET إلىcustom-fields/.

    segment_ids

    معامل اختياري، نوعه مصفوفة أعداد صحيحة array، يُحَدِّد الأرقام التعريفية لفئات جهات الاتصال التي ترغب بأن يكون للوكيل الجديد صلاحية عليها، علمًا أنك تستطيع معرفة الأرقام التعريفية لفئات جهات الاتصال بإرسال طلب GET إلى نقطة الاتصال segments/.

    field_group_ids

    معامل اختياري، نوعه مصفوفة أعداد صحيحة، تكتب ضمنه الأرقام التعريفية لمجموعة الحقول المخصصة الخاصة بتعريف الشركات وجهات الاتصال التي ترغب بأن يكون للوكيل الجديد صلاحية عليها، ويمكنك معرفة الأرقام التعريفية لمجموعات الحقول المخصصة وتبعيتها للموارد بإرسال طلب GET لنقطة الاتصال custom-fields/.

    مثال

    لننشئ وكيل جديد في مركز المساعدة الذي يملك النطاق الفرعي

    support.example.com مع تحديد إعداداته كالاسم الأول، واسم العائلة، والبريد الإلكتروني، والحالة، والصورة الشخصية من خلال الطلب التالي:


    curl -X POST --header 'Authorization: Bearer your_token' --form 'first_name="User_First_Name"' --form 'last_name="User_Last_Name"' --form 'avatar=@"path\to\user_avatar.png"' --form 'email="user_email@exampel.com"' --form 'status="active"' 'https://support.example.com/api/agent/v1/agents'

    لاحظ أننا استخدمنا الخيار "form--" بدل "data--" لتمرير البيانات في هذا المثال، لأن بياناتنا هنا متنوعة الأنواع فهي تتضمن ملف صورة إضافة للبيانات المعتادة التي استخدمناها في بقية الأمثلة.

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

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