النماذج
نماذج الاشتراك، والأشخاص الذين يملؤونها، وأرقامها.
أدوات النماذج
| الأداة | ما تفعله |
|---|---|
| listForms | نماذج الاشتراك في مساحة العمل، الأحدث تغييرًا أولًا، مع حالتها واشتراكاتها ومشاهداتها. |
| getForm | نموذج واحد بالكامل: حقوله ونصوصه وجماهيره والتأكيد المزدوج والإشعارات. ويضيف النموذج المنشور رابطه وشيفرة التضمين والعنوان الذي يرسل إليه نموذج HTML العادي البيانات، ويعيد includeDesign المسودة بصيغة JSON. |
| listFormStarters | نقاط البداية التي يمكن أن ينطلق منها نموذج جديد، مع الحقول التي تطلبها كل منها. |
| createForm | أنشئ نموذجًا من نقطة بداية، أو من تصميم مكتوب بوصفه document، أو من نقطة بداية مع تغييرات فوقها، بأي إعدادات. ويبقى مسودة ما لم تكن قيمة publish هي true. |
| updateForm | غيّر اسم النموذج وإعداداته، وهي تُطبَّق فورًا، أو تصميم مسودته عبر document. وتُدمج النصوص والنمط مفتاحًا مفتاحًا، ويستبدل fields القائمة كلها. |
| publishForm | اجعل المسودة الحالية هي ما يراه الزوار، ليستقبل النموذج الاشتراكات. |
| setFormStatus | أوقف نموذجًا منشورًا مؤقتًا، أو افتحه من جديد. |
| duplicateForm | انسخ نموذجًا إلى مسودة جديدة، دون اشتراكاته. |
| deleteForm | احذف نموذجًا واشتراكاته نهائيًا. ويتوقف رابطه ونسخه المضمَّنة عن العمل، ويبقى الأشخاص الذين أضافهم في جهات اتصالك. |
| getFormAnalytics | المشاهدات والاشتراكات والأشخاص المضافون والذين ما زالوا ينتظرون، ومعدل التحويل خلال فترة، إجمالًا ولكل دقيقة أو ساعة أو يوم. وتُحفظ المشاهدات لكل ساعة. |
| listFormSubmissions | الأشخاص الذين ملؤوا نموذجًا، من الأحدث إلى الأقدم، مع إجاباتهم وحالتهم، صفحةً في كل مرة. ابحث حسب عنوان البريد الإلكتروني وصفِّ حسب الحالة. |
| getFormSubmission | اشتراك واحد بالكامل: كل إجابة، وحالته، ومتى وصل ومتى أُضيف الشخص، والصفحة التي جاء منها، وجماهيره. |
| approveFormSubmission | أضف اشتراكًا ينتظر تأكيده دون رسالة التأكيد. ويتطلب contacts:write أيضًا. |
| resendFormConfirmation | أرسل بالبريد رابط تأكيد جديدًا إلى اشتراك ما زال ينتظر. ولا يُرسل شيء إن كان هذا النموذج قد راسل ذلك العنوان في آخر عشر دقائق، أو إن كان العنوان قد تلقى خمسة من مساحة العمل هذه خلال اليوم الماضي. ويتطلب emails:send أيضًا. |
| removeFormSubmissions | احذف حتى 200 اشتراك من نموذج بمعرّفاتها. وتبقى جهات الاتصال والجماهير كما هي. |
القراءة تتطلب forms:read وكل تغيير يتطلب forms:write. وكل ما يجعل النموذج يرسل بريدًا يتطلب emails:send أيضًا: تفعيل التأكيد المزدوج، وتعيين المُرسِل أو رسالة التأكيد، ونشر نموذج ذي تأكيد مزدوج أو فتحه، وإعادة إرسال تأكيد. والعميل الذي يعمل لحساب عضو لا يرى إلا النماذج التي أنشأها ذلك العضو، والعميل المقيّد ببعض العناوين لا يجوز له أن يرسل رسائل التأكيد إلا من العناوين التي يصل إليها، ولا أن يُشعر إلا إياها.
تصميم نموذج انطلاقًا من وصف مكتوب يجري في محادثة التطبيق. أما عبر MCP فالعميل هو المصمِّم: مرّر الحقول والنصوص والنمط بوصفها document إلى createForm أو updateForm، فترتّب الأدوات التصميم وتذكر ما غيّرته.
سبع أدوات على هذا الخادم تُجري تغييرًا تحميه REST API برمز تحقق، وتطلب الرمز نفسه: createRule وsetRuleEnabled وremoveDomain وremoveDomainAddress وremoveAppHost وdeleteForm، وdeleteAudience لجمهور أنشأته. ما لم يتحقق العميل من رمز خلال آخر 60 دقيقة، أو يختر الشخص له «السماح بالتغييرات لمدة 60 دقيقة» في الحساب → التطبيقات المرتبطة، تردّ هذه الأداة بنتيجة تبدأ بـ Refused (step_up_required): ولا تغيّر شيئًا. أما emptyAudience فلا يطلب رمزًا أبدًا. صفحة المصادقة في API تشرح كيف يُطلب رمز وكيف يُتحقق منه.
تطبّق الأدوات القواعد وحالات الرفض نفسها التي تطبّقها REST API، وتصف صفحات /forms في مرجع API كل حقل. ويعرض listForms النماذج مرتّبةً حسب آخر تغيير، ويرتّب createForm وupdateForm مستند document الجزئي، في حين تأخذه API كاملًا.