تخط وانتقل إلى المحتوى الرئيسي

كيفية تكوين السمات وحمولة واجهة برمجة تطبيقات REST Action

ملخص

يشرح هذا الدليل كيفية عمل سمات إجراءات واجهة برمجة تطبيقات REST في Astra وكيفية استخدامها داخل وكلاء Astra. تعمل السمات كعناصر نائبة تخزن البيانات وتمررها بين التعليمات والإجراءات.

ستتعرف على الأنواع المختلفة للسمات، وكيفية عملها، وكيفية استخدامها بشكل صحيح عند تكوين إجراءات واجهة برمجة تطبيقات REST (نقل الحالة التمثيلية).

تعليمات

ما هي السمة

في Astra، السمة هي عنصر نائب يخزن قيمة. يسمح لوكيلك باستخدام البيانات ديناميكيًا أثناء التنفيذ.

على سبيل المثال، يمكن للسمات مثل الاسم الأول أو الاسم الأخير تخزين تفاصيل العميل وإعادة استخدامها في الردود أو الإجراءات.

نقاط رئيسية

  • تعمل السمات مثل المتغيرات داخل وكيلك

  • يمكن استخدامها في التعليمات والإجراءات

  • في التعليمات، تستخدم السمات بشكل أساسي للوضوح أو لهيكلة المدخلات والمخرجات

سمات الإدخال والإخراج

يتم تصنيف السمات في Astra بناءً على كيفية استخدامها:

سمات الإدخال

  • توفير البيانات لإجراء أو خطوة

  • مثال: تمرير اسم العميل إلى طلب واجهة برمجة تطبيقات

سمات الإخراج

  • تخزين النتائج التي تم إرجاعها من إجراء

  • مثال: حفظ معرف الاستجابة من واجهة برمجة التطبيقات

يمكن الإشارة إلى كلا النوعين في جميع أنحاء سير عمل وكيلك.

أ. سمات جهات الاتصال

سمات جهات الاتصال هي نوع محدد من السمات المرتبطة ببيانات العملاء.

سمات جهات الاتصال المعرفة مسبقًا

تشمل الأمثلة الشائعة:

  • الاسم الأول

  • الاسم الأخير

سمات جهات الاتصال المخصصة

يمكنك إنشاء سمات مخصصة بناءً على حالة الاستخدام الخاصة بك داخل الوكيل.

هام

  • تستقبل سمات جهات الاتصال القيم فقط عندما يتم التقاط البيانات بالفعل.

يتم تعبئتها عندما:

  • يتم تقديم نموذج مخصص أثناء المحادثة

  • يتم تشغيل إجراء واجهة برمجة تطبيقات REST بعد المحادثة

نقاط هامة أخرى يجب ملاحظتها

  • لا تعتبر سمات جهات الاتصال متطابقة مع حقول جهات الاتصال

  • تشمل حقول جهات الاتصال:

    • email

    • phone

  • يمكن أن تأتي أيضًا من:

    • نماذج مخصصة

    • معايير تأهيل العملاء المحتملين

ترتبط سمات جهات الاتصال بهذه الحقول فقط عند التقاط البيانات عبر هذه التدفقات.

ب. سمات الإجراء

ترتبط سمات الإجراءات بالإجراءات المكونة في وكيلك.

أنواع سمات الإجراء

  • سمات إجراء واجهة برمجة تطبيقات REST

  • سمات الإجراءات المعرفة مسبقًا

1. سمات الإجراءات المعرفة مسبقًا

تصبح هذه متاحة عند إضافة إجراءات معينة إلى وكيلك.

أمثلة:

  • Wati إرسال ملخص المبيعات → sales_summary_content (إدخال)

  • Slack إرسال رسالة → message_content (إدخال)

  • Google Sheets إضافة صف → inserted_data_id (إخراج)

  • Google Sheets تحديث صف → target_data_id (إدخال)

2. سمات إجراء واجهة برمجة تطبيقات REST

  • يتم إنشاء سمات الإدخال عند تكوين الإجراء

  • يتم إنشاء سمات الإخراج بعد تشغيل الإجراء (أثناء الاختبار أو التنفيذ المباشر)

هام

يجب عليك إضافة الإجراء المقابل إلى وكيلك قبل استخدام سماته.

كيفية تكوين حمولة إجراء واجهة برمجة تطبيقات REST

تستخدم إجراءات واجهة برمجة تطبيقات REST في Astra عناصر نائبة لتمرير البيانات الديناميكية.

ما هي العناصر النائبة

تُكتب العناصر النائبة باستخدام: ##{{placeholder_name}}

يمكنك استخدامها في:

  • معلمات الاستعلام

  • الرؤوس

  • جسم الطلب

الطريقة الموصى بها: استخدام إدخال البيانات

هذا هو النهج الأكثر مرونة والموصى به.

أ. استخدام إدخال البيانات

الخطوة 1: إضافة حقل إدخال بيانات

أنشئ إدخال بيانات في تكوين الإجراء الخاص بك.

الخطوة 2: تكوين الحقل

حدد:

  • نوع البيانات

  • الاسم

  • الوصف

  • إلزامي أو اختياري

  • سمة مرجعية (اختياري)

  • القيمة الافتراضية (اختياري)

الخطوة 3: اختر كيفية الحصول على القيمة

لديك 3 خيارات:

  • لا يوجد مرجع

    • يقوم الوكيل بإنشاء القيمة من السياق

    • أضف وصفًا واضحًا حتى يعرف الوكيل ما يجب تمريره

  • الإشارة إلى سمة جهة اتصال

    • استخدم فقط إذا تم التقاط القيمة بالفعل

    • تجنب استخدام هذا إلا إذا:

      • تم تقديم نموذج مخصص، أو

      • حدث حدث واجهة برمجة تطبيقات بعد المحادثة

  • الإشارة إلى سمة إخراج إجراء

    • استخدم الإخراج من إجراء سابق

    • يجب تشغيل الإجراء المشار إليه قبل الإجراء الحالي

الخطوة 4: استخدام العنصر النائب

أشر إليه في حمولتك: ##{{data_input_name}}

تأكد من تطابق الاسم تمامًا.

ب. استخدام سمة جهة اتصال مباشرة

يمكنك الإشارة مباشرة إلى سمة جهة اتصال: ##{{contact.attribute_name}}

  • لا حاجة لتعريف إدخال بيانات

  • يمكن إدراجه مباشرة من واجهة المستخدم

ج. استخدام سمة إجراء مباشرة

يمكنك الإشارة إلى إخراج إجراء: ##{{action.<action_id>#out#<attribute_name>}}

  • يرتبط بالإخراج من إجراء سابق

  • يمكن إدراجه من واجهة المستخدم

  • لا حاجة لكتابة الصيغة الكاملة يدويًا

أفضل الممارسات

  • استخدم إدخال البيانات لمعظم حالات الاستخدام

  • تجنب الاعتماد على سمات جهات الاتصال إلا إذا كنت متأكدًا من أنها مملوءة

  • تأكد من صحة ترتيب تنفيذ الإجراء عند استخدام المخرجات

  • اختبر جميع إجراءات واجهة برمجة التطبيقات قبل النشر

من خلال فهم سمات Astra، يمكنك بناء وكلاء أكثر تنظيمًا وموثوقية وديناميكية داخل Wati.

هل أجاب هذا عن سؤالك؟