إضافة حقول جديدة لتعريف الأشخاص

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

إضافة حقول جديدة للأشخاص

تساعدك نقطة الاتصال contacts/{contact_id}/fields/ على إضافة حقول جديدة إلى إعدادات تعريف الأشخاص في مركز المساعدة مثل روابط مواقع الويب URLs، وهي نوعية الحقول المتاحة حاليًّا.

  • عنوان URL لنقطة الاتصال:

https://{your_subdomain}/api/agent/v1/contacts/{contact_id}/fields.

  • نوع الطلب: POST.
  • معاملات المسار Path Parameters:
    • contact_id: الرقم التعريفي للشخص، معامل إجباري، نوعه عدد صحيح integer.
    • جسم الطلب Body: يكتب بصيغة JSON ويتضمن المعاملات التالية:
      • key: معامل إجباري، نوعه سلسلة نصية string، يُكتب ضمنه اسم الرابط، مثلًا: linkedin أو ما شابه.
      • value: معامل إجباري، نوعه سلسلة نصية string، يُكتب ضمنه الرابط.
      • type: معامل إجباري، نوعه سلسلة نصية string، يُحَدِّد نوع الحقل، ويقبل حصرًا القيمة "url".

مثال

يضيف المثال التالي رابط LinkedIn إلى بيانات مستخدم في مركز مساعدة تجريبي باسم "المناسب" له النطاق الفرعي al-munasib.zaetoon.com.

curl -X POST --header 'Authorization: Bearer your_token' --header 'Content-Type: application/json' --data '{
"key": "linkedin",
"value": "https://www.linkedin.com/exampel/",
"type": "url"
}' 'https://al-munasib.zaetoon.com/api/agent/v1/contacts/439582/fields'

وإذا رغبت بحذف الحقل (أي الرابط في حالتنا) فيمكنك ذلك بإرسال طلب من نوع DELETE إلى نقطة الاتصال {contacts/{contact_id}/fields/{field_id/ مع تمرير كل من رقم الشخص contact_id ورقم الحقل field_id في عنوان URL للطلب.

مثال

يحذف المثال التالي الحقل رقم "216301" من إعدادات الشخص رقم "439582" في مركز مساعدة "المناسب":

curl -X DELETE --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/contacts/439582/fields/216301'