واجهة برمجة تطبيقات Zinn® Campaigns وMCP: دليل المطور

كل ما يمكنك القيام به في Zinn® Campaigns عبر لوحة التحكم يمكنك إجراؤه أيضًا من خلال واجهة برمجة التطبيقات (API)، ومعظمه من خلال مساعد ذكاء اصطناعي متصل بحسابكم عبر بروتوكول MCP. يغطي هذا الدليل تسجيل الدخول، والأذونات، ومثالاً عملياً بكلا الطريقتين، والحدود، والأخطاء، وكل عملية من عمليات Campaigns البالغ عددها 89 عملية. تم إنشاء قائمة العمليات أدناه من مواصفات واجهة برمجة التطبيقات الخاصة بنا، لذا فهي تطابق دائمًا ما تفعله واجهة برمجة التطبيقات. يتوفر كل حقل في كل عملية ضمن مرجع واجهة برمجة التطبيقات على الرابط zinndigital.com/developers/api/zinn-campaigns.

تسجيل الدخول

• مفاتيح API. أنشئ مفتاحًا في لوحة التحكم ضمن الإعدادات ← مفاتيح API وأرسله كـ Authorization: Bearer zdk_live_… (يعمل مفتاح zdk_test_… في وضع البيئة التجريبية). امنح المفتاح أذونات Campaigns التي يحتاج إليها فقط دون زيادة.
• مساعدو الذكاء الاصطناعي (MCP). قُم بربط Claude أو ChatGPT أو Cursor أو أي عميل MCP بـ https://api.zinndigital.com/v1/mcp، إما عن طريق تسجيل الدخول من التطبيق أو باستخدام رمز اتصال (zmcp_live_…). راجع ربط Claude أو Cursor أو ChatGPT بحسابك. في شاشة الموافقة، حدد أذونات Zinn® Campaigns.
• الأذونات. يقرأ email_marketing.view الحملات، والقوائم، وجهات الاتصال، والنماذج، وجهات الإرسال، وإعدادات SMS، والتقارير؛ بينما ينشئها ويعدّلها email_marketing.manage. تستخدم الحملات التي ترسلها عبر خدمة البريد الإلكتروني الخاصة بك الإذنين campaigns.view وcampaigns.manage.
• الموزعون. مرّر org_id للعمل نيابةً عن إحدى المؤسسات التابعة لعملائك. اتركه فارغًا عندما يصل مفتاحك أو اتصالك إلى مؤسسة واحدة فقط.

مثال: إنشاء مسودة حملة باستخدام API

curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spring sale",
  "subject": "Our spring sale starts today",
  "list_id": "<list id>",
  "sender_id": "<sender id>",
  "template": "basic"
}'

تكون الإجابة 201 مع المسودة. اختبرها باستخدام POST /v1/email-marketing/campaigns/{campaign_id}/test، وتحقق منها باستخدام GET /v1/email-marketing/campaigns/{campaign_id}/lint، وأرسلها باستخدام POST /v1/email-marketing/campaigns/{campaign_id}/send.

مثال: نفس المسودة من مساعد ذكاء اصطناعي

اطلب من مساعدك بكلمات بسيطة، على سبيل المثال "قم بإنشاء مسودة بريد إلكتروني في Zinn® Campaigns باسم تخفيضات الربيع وبالموضوع 'تبدأ تخفيضات الربيع لدينا اليوم'". في الكواليس، يعثر على العملية باستخدام api_operations_search، ويقرأ معلماتها باستخدام api_operation_get، ويقوم بتشغيلها باستخدام api_operation_call:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "api_operation_call",
    "arguments": {
      "operation_id": "createEmailMarketingCampaign",
      "confirm": true,
      "body": {
        "name": "Spring sale",
        "subject": "Our spring sale starts today"
      }
    }
  }
}

ما لن يفعله المساعد. يتم رفض أي إجراء يرسل إلى مستلميك أو ينفق أموالاً أو يستهلك من رصيدك — كإرسال حملة، أو إرسال رسائل SMS أو WhatsApp، أو الكتابة باستخدام أرصدة الذكاء الاصطناعي، أو التسجيل للمراسلة النصية في US — على المساعد، بحيث لا يمكن لأي تعليمة يساء فهمها أن تصل إلى عملائك أبداً. يجهز المساعد المسودة؛ وتضغط أنت على إرسال في لوحة التحكم أو تستدعي واجهة برمجة التطبيقات بنفسك. كما لا يتم تمرير الأسرار مثل كلمة مرور SMTP عبر المساعد أبداً: أدخلها في لوحة التحكم.

الحدود

• 1,200 طلب في الدقيقة لكل شخص أو مفتاح واجهة برمجة تطبيقات، و6,000 طلب في الدقيقة لكل مؤسسة. ويُطبق الحد الأكثر صرامة بينهما.
• 600 طلب في الدقيقة لكل اتصال MCP.
• عند تجاوز الحد، تكون الاستجابة 429 مع ترويسة Retry-After: انتظر هذا العدد من الثواني.
• تستوعب إضافة أعضاء إلى القائمة 1,000 عنوان كحد أقصى لكل طلب؛ وتُطبق حدود جهات الاتصال ورسائل البريد الإلكتروني الخاصة بخطتك على كل ما تفعله عبر واجهة برمجة التطبيقات.

الأخطاء

لكل خطأ نفس الهيكل:

{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}

لا يتغير code للمشكلة نفسها أبداً، لذا اختبره بدلاً من message. اذكر request_id عندما تتصل بالدعم. الإجابات التي ستواجهها: 401 UNAUTHORIZED، 403 FORBIDDEN، 404 NOT_FOUND، 409 CONFLICT، 422 UNPROCESSABLE_ENTITY، 429 TOO_MANY_REQUESTS. يعني الرمز 403 أن المفتاح أو الاتصال يفتقر إلى إذن مذكور في القائمة أدناه؛ ويغطي الرمز 404 أيضاً عناصر في مؤسسة لا يمكنك رؤيتها؛ بينما يدرج الرمز 422 كل حقل خاطئ في details؛ وبعد الرمز 429، انتظر عدد الثواني المحدد في عنوان Retry-After.

خطافات الويب (Webhooks)

تأتي نتائج التسليم إلى Zinn® Campaigns من المزود الذي يرسل بريدك الإلكتروني:

• مع مزودك الخاص (على سبيل المثال Resend)، احفظ سر توقيع خطاف الويب الخاص به في اتصال الإرسال داخل لوحة التحكم (Campaigns ← Sending). ستحصل على webhook_url؛ وجّه أحداث التسليم والارتداد والشكاوى الخاصة بالمزود إليه. يؤدي الارتداد أو شكوى الرسائل غير المرغوب فيها إلى إزالة العنوان من عمليات الإرسال المستقبلية فوراً.
• مع الإرسال عبر Zinn®، لا يوجد شيء يلزم إعداده.

اقرأ النتائج باستخدام عمليات التقارير (getEmailMarketingCampaignReport، getSmsMarketingCampaignReport).

كل عمليات Campaigns

نظرة عامة

• GET /v1/email-marketing — نظرة عامة على Zinn® Campaigns لمؤسسة واحدة. العملية getEmailMarketingOverview. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.

حملات البريد الإلكتروني

• GET /v1/email-marketing/campaigns — حملات البريد الإلكتروني، الأحدث أولاً، صفحة مفاتيح واحدة. العملية listEmailMarketingCampaigns. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/campaigns — إنشاء مسودة حملة بريد إلكتروني. العملية createEmailMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• GET /v1/email-marketing/campaigns/{campaign_id} — حملة بريد إلكتروني واحدة. العملية getEmailMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — تعديل مسودة (أو حملة مرفوضة، والتي تعود إلى مسودة). العملية updateEmailMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — فحص نص الحملة بحثًا عن مشاكل قابلية التسليم قبل إرسالها. العملية lintEmailMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — أرقام الحملة. العملية getEmailMarketingCampaignReport. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — بدء إرسال حملة إلى قائمتها. العملية sendEmailMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: إنها تستهلك أموالاً أو رصيداً مخصصاً، لذا يضغط عليها شخص ما (تُرسل إلى مستلمين حقيقيين وتستهلك الرصيد).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — إرسال نسخة تجريبية واحدة الآن إلى أحد أعضاء المؤسسة. العملية testEmailMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — ترجمة حملة إلى كل لغة جهة اتصال مفقودة أو قديمة. العملية translateEmailMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — كل لغة جهة اتصال في قائمة الحملة وما إذا كانت ترجمتها محدثة. العملية listEmailMarketingCampaignTranslations. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.

الكتابة باستخدام الذكاء الاصطناعي

• POST /v1/email-marketing/ai/write — كتابة مسودة بريد إلكتروني لحملة انطلاقاً من موجز قصير باستخدام Zinn® AI. العملية writeEmailMarketingCampaignWithAi. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: عبر واجهة برمجة التطبيقات ولوحة التحكم فقط: يستهلك أموالاً أو رصيداً، لذا يضغط عليه شخص (تستهلك الكتابة بالذكاء الاصطناعي أرصدة ذكاء اصطناعي).

عدة العلامة التجارية

• GET /v1/email-marketing/brand-kit — عدة العلامة التجارية للمؤسسة (الاسم، الشعار، الألوان، الخط، نبرة الصوت). العملية getEmailMarketingBrandKit. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• PUT /v1/email-marketing/brand-kit — تعديل عدة العلامة التجارية. العملية updateEmailMarketingBrandKit. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• POST /v1/email-marketing/brand-kit/read — قراءة عدة العلامة التجارية من موقع الويب الخاص بالمؤسسة. العملية readEmailMarketingBrandKit. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.

جهات الاتصال والرسائل لمرة واحدة

• GET /v1/email-marketing/contacts — جهات اتصال المؤسسة، صفحة keyset واحدة في كل مرة. العملية listEmailMarketingContacts. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — إرسال رسالة SMS واحدة إلى جهة اتصال واحدة، مدفوعة من رصيد Zinn®. العملية sendEmailMarketingMessage. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: إنها تستهلك أموالاً أو رصيداً متاحاً، لذا يضغط عليها شخص ما (الرسالة لمرة واحدة إلى جهة اتصال تستهلك من الرصيد المتاح).
• GET /v1/email-marketing/messages — رسائل SMS وWhatsApp التي أرسلتها المؤسسة، الأحدث أولاً، صفحة keyset واحدة. العملية listEmailMarketingMessages. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.

القوائم

• GET /v1/email-marketing/lists — القوائم البريدية الخاصة بالمؤسسة مع أعداد المشتركين / الملغى اشتراكهم. العملية listEmailMarketingLists. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.
• POST /v1/email-marketing/lists — إنشاء قائمة بريدية (أو إرجاع القائمة التي تحمل ذلك الاسم). العملية createEmailMarketingList. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.
• POST /v1/email-marketing/lists/{list_id}/members — إضافة جهات اتصال إلى قائمة حسب عنوان البريد الإلكتروني (بحد أقصى 1,000 لكل طلب). العملية addEmailMarketingListMembers. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.

عمليات الاستيراد

• GET /v1/email-marketing/imports — عمليات استيراد جهات الاتصال السابقة، الأحدث أولاً، صفحة keyset واحدة في كل مرة. العملية listEmailMarketingImports. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.
• POST /v1/email-marketing/imports — استيراد جزء واحد من جهات الاتصال مع إقرار الموافقة الخاص به. العملية createEmailMarketingImport. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد الذكاء الاصطناعي: نعم، من خلال MCP.

نماذج التسجيل

• GET /v1/email-marketing/forms — نماذج الاشتراك (تأكيد مزدوج)، الأحدث أولاً، صفحة keyset واحدة. العملية listEmailMarketingForms. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/forms — إنشاء نموذج اشتراك يضيف الأشخاص المؤكدين إلى قائمة واحدة. العملية createEmailMarketingForm. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• DELETE /v1/email-marketing/forms/{form_id} — حذف نموذج اشتراك (الأشخاص الذين تم تأكيدهم بالفعل يبقون في القائمة). العملية deleteEmailMarketingForm. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• PATCH /v1/email-marketing/forms/{form_id} — تغيير نموذج اشتراك (الصياغة، القائمة، إعادة التوجيه، التشغيل أو الإيقاف). العملية updateEmailMarketingForm. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.

اتصالات الإرسال

• GET /v1/email-marketing/senders — اتصالات الإرسال الخاصة بالمؤسسة. العملية listEmailMarketingSenders. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/senders — ربط مرسل الحملة (إرسال Zinn®، أو خادم SMTP الخاص بالعميل). العملية createEmailMarketingSender. الأذونات التي تم التحقق منها: email_marketing.manage، وemail_marketing.view. من مساعد ذكاء اصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: يحمل سراً يجب ألا يصل أبداً إلى نموذج ذكاء اصطناعي (المحتوى هو كلمة مرور SMTP).
• DELETE /v1/email-marketing/senders/{sender_id} — إزالة اتصال الإرسال وكلمة المرور المخزنة الخاصة به. العملية deleteEmailMarketingSender. الأذونات التي تم التحقق منها: email_marketing.manage، وemail_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/senders/{sender_id}/verify — إثبات عمل اتصال الإرسال، دون إرسال أي شيء. العملية verifyEmailMarketingSender. الأذونات التي تم التحقق منها: email_marketing.manage، وemail_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — تخزين سر توقيع الـ webhook الخاص بمزود البريد الإلكتروني لهذا الاتصال. العملية setEmailMarketingSenderWebhook. الأذونات التي تم التحقق منها: email_marketing.manage، وemail_marketing.view. من مساعد ذكاء اصطناعي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (يخزن سر الـ webhook الخاص بالمزود).

SMS و WhatsApp

• GET /v1/email-marketing/sms — ما تحتاجه شاشة SMS — مفتوح؟، متوقف مؤقتًا؟، رصيد الحساب والأسعار. العملية getEmailMarketingSms. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• GET /v1/email-marketing/sms/campaigns — حملات SMS الجماعية، الأحدث أولاً، صفحة keyset واحدة. العملية listSmsMarketingCampaigns. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• POST /v1/email-marketing/sms/campaigns — إنشاء مسودة SMS لقائمة. العملية createSmsMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — حملة SMS جماعية واحدة. العملية getSmsMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — تعديل مسودة (أو حملة مرفوضة، والتي تعود إلى حالة مسودة). العملية updateSmsMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — أرقام حملة SMS جماعية. العملية getSmsMarketingCampaignReport. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — ابدأ إرسال رسالة SMS إلى كل شخص في قائمتها وافق على تلقي رسائل SMS — أو استأنف حملة أوقفت مؤقتًا بسبب الرصيد. العملية sendSmsMarketingCampaign. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من المساعد الذكي: عبر واجهة برمجة التطبيقات (API) ولوحة التحكم فقط: إنها تستهلك أموالاً أو حصة، لذا يقوم شخص بالضغط عليها (ترسل رسائل SMS/WhatsApp مدفوعة).
• GET /v1/email-marketing/sms/registrations/us — تسجيل US 10DLC الخاص بهذه المؤسسة، وتكلفة التسجيل الواحد. العملية getEmailMarketingUsRegistration. الأذونات التي تم التحقق منها: email_marketing.view. من المساعد الذكي: نعم، عبر MCP.
• POST /v1/email-marketing/sms/registrations/us — إرسال العلامة التجارية والحملة الخاصة بهذه المؤسسة للتسجيل في US 10DLC (يتم تحصيل الرسوم عند الإرسال). العملية submitEmailMarketingUsRegistration. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من المساعد الذكي: عبر واجهة برمجة التطبيقات (API) ولوحة التحكم فقط: إنها تستهلك أموالاً أو حصة، لذا يقوم شخص بالضغط عليها (يتضمن تسجيل US 10DLC رسوم مشغل شبكة الجوال).

الحملات عبر خدمة البريد الإلكتروني الخاصة بك (القوالب، الشرائح، قوائم الاستبعاد)

• GET /v1/campaigns — حملات المؤسسة. العملية listCampaigns. من المساعد الذكي: نعم، عبر MCP.
• POST /v1/campaigns — إنشاء حملة من قالب وجمهور. العملية createCampaign. من المساعد الذكي: نعم، عبر MCP.
• DELETE /v1/campaigns/esp — قطع اتصال حساب المزود وإزالة مفتاحه المخزن. العملية disconnectEsp. من مساعد ذكاء اصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: يحتوي على سر يجب ألا يصل أبداً إلى نموذج ذكاء اصطناعي (يدمر مفتاح ESP المخزن).
• GET /v1/campaigns/esp — حساب مزود البريد الإلكتروني الخاص بالمؤسسة. العملية getEspConnection. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• POST /v1/campaigns/esp — ربط حساب مزود البريد الإلكتروني. العملية connectEsp. من مساعد ذكاء اصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: يحتوي على سر يجب ألا يصل أبداً إلى نموذج ذكاء اصطناعي (الجسم هو مفتاح واجهة برمجة تطبيقات ESP).
• POST /v1/campaigns/esp/verify — إثبات عمل حساب المزود وقراءة نطاقاته التي تم التحقق منها. العملية verifyEspConnection. من مساعد ذكاء اصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: يحتوي على سر يجب ألا يصل أبداً إلى نموذج ذكاء اصطناعي (يعيد التحقق من مفتاح ESP المخزن).
• POST /v1/campaigns/preview — قم بإجراء Render للقالب باستخدام قيم تجريبية. العملية previewCampaignTemplate. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• GET /v1/campaigns/segments — شرائح الجمهور المحفوظة لديكم. العملية listCampaignSegments. الأذونات التي تم فحصها: campaigns.view. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• POST /v1/campaigns/segments — حفظ شريحة جمهور جديدة. العملية createCampaignSegment. الأذونات التي تم فحصها: campaigns.manage. من مساعد ذكاء اصطناعي: نعم، من خلال MCP.
• GET /v1/campaigns/segments/fields — مفردات التصفية وقوائم قيمها والعلامات السحرية. العملية getCampaignSegmentFields. الأذونات التي تم التحقق منها: campaigns.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/campaigns/segments/preview — عدد الأشخاص الذين يصل إليهم هذا، ومن هم، ومن يستبعدهم. العملية previewCampaignSegment. الأذونات التي تم التحقق منها: campaigns.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• DELETE /v1/campaigns/segments/{segmentId} — أرشفة شريحة. العملية archiveCampaignSegment. الأذونات التي تم التحقق منها: campaigns.manage. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• GET /v1/campaigns/segments/{segmentId} — شريحة واحدة محفوظة. العملية getCampaignSegment. الأذونات التي تم التحقق منها: campaigns.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• PATCH /v1/campaigns/segments/{segmentId} — إعادة تسمية شريحة أو تغيير عوامل التصفية الخاصة بها. العملية updateCampaignSegment. الأذونات التي تم التحقق منها: campaigns.manage. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• GET /v1/campaigns/suppressions — العناوين التي يجب ألا تتلقى رسائل تسويقية. العملية listCampaignSuppressions. الأذونات التي تم التحقق منها: campaigns.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/campaigns/suppressions — إضافة عنوان إلى قائمة الاستبعاد. العملية createCampaignSuppression. الأذونات التي تم التحقق منها: campaigns.manage. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• GET /v1/campaigns/tags — لوحة العلامات السحرية التي يتيحها منشئ الحملات. العملية listCampaignTags. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• GET /v1/campaigns/templates — قوالب حملات المؤسسة. العملية listCampaignTemplates. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• POST /v1/campaigns/templates — إنشاء قالب حملة. العملية createCampaignTemplate. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• DELETE /v1/campaigns/templates/{templateId} — أرشفة قالب وإيقاف مصادر الترجمة الخاصة به. العملية archiveCampaignTemplate. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• GET /v1/campaigns/templates/{templateId} — قالب حملة واحد. العملية getCampaignTemplate. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• PUT /v1/campaigns/templates/{templateId} — تعديل قالب حملة. العملية updateCampaignTemplate. من مساعد الذكاء الاصطناعي: نعم، عبر MCP.
• POST /v1/campaigns/unsubscribe — مغادرة قائمة تسويقية. لا يلزم وجود حساب. العملية unsubscribeFromCampaigns. من مساعد الذكاء الاصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: يحتوي على سر يجب ألا يصل مطلقاً إلى نموذج الذكاء الاصطناعي (يأخذ رمز إلغاء اشتراك موقّع للمستلم).
• DELETE /v1/campaigns/{campaignId} — حذف حملة وإيقاف صفوف التسليم الخاصة بها. العملية deleteCampaign. من مساعد الذكاء الاصطناعي: واجهة برمجة التطبيقات ولوحة التحكم فقط: يتطلب إذناً لا يتم منحه لاتصالات الذكاء الاصطناعي (يتطلب حذف حملة ESP إذن campaigns.send).
• GET /v1/campaigns/{campaignId} — حملة واحدة وتقرير تسليمها. العملية getCampaign. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/campaigns/{campaignId}/control — إيقاف إرسال قيد التشغيل مؤقتًا أو استئنافه أو إلغاؤه. العملية controlCampaign. من مساعد ذكاء اصطناعي: عبر واجهة برمجة التطبيقات ولوحة التحكم فقط: يستهلك أموالاً أو حصة استخدام، لذا يضغط عليه شخص (يقوم بإيقاف/استئناف إرسال مباشر مؤقتًا).
• POST /v1/campaigns/{campaignId}/send — بدء الإرسال الدائم. العملية sendCampaign. من مساعد ذكاء اصطناعي: عبر واجهة برمجة التطبيقات ولوحة التحكم فقط: يستهلك أموالاً أو حصة استخدام، لذا يضغط عليه شخص (يرسل حملة ESP إلى مستلمين حقيقيين).
• POST /v1/campaigns/{campaignId}/test — إرسال رسالة حقيقية واحدة عبر القناة التي ستستخدمها الحملة بالفعل. العملية testSendCampaign. من مساعد ذكاء اصطناعي: عبر واجهة برمجة التطبيقات ولوحة التحكم فقط: يتطلب إذنًا لا يتم توفيره لاتصالات الذكاء الاصطناعي (يتطلب إرسال اختبار ESP الإذن campaigns.send).

الصفحات العامة وخطافات الويب الواردة

• GET /v1/public/email-marketing/c/{token} — عداد النقرات. يسجل نقرة واحدة لكل مستلم ويعيد التوجيه إلى الرابط الأصلي. العملية emailMarketingClick. من مساعد ذكاء اصطناعي: صفحة يفتحها المستلمون من بريد إلكتروني (إعادة التوجيه لتتبع النقرات).
• GET /v1/public/email-marketing/f/{public_id} — صفحة مستضافة لنموذج اشتراك (بدون تسجيل دخول). العملية emailMarketingFormPage. من مساعد ذكاء اصطناعي: صفحة يفتحها المستلمون من بريد إلكتروني (صفحة نموذج الاشتراك العامة).
• POST /v1/public/email-marketing/f/{public_id} — إرسال نموذج تسجيل (صفحة مستضافة أو تضمين أو JSON). العملية emailMarketingFormSubmit. من مساعد الذكاء الاصطناعي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (يقوم الزائر بإرسال نموذج التسجيل).
• GET /v1/public/email-marketing/fc — صفحة تأكيد الاشتراك المزدوج (بدون تسجيل دخول). العملية emailMarketingFormConfirmPage. من مساعد الذكاء الاصطناعي: صفحة يفتحها المستلمون لديكم من البريد الإلكتروني (صفحة تأكيد الاشتراك المزدوج).
• POST /v1/public/email-marketing/fc — تأكيد التسجيل (يضيف الشخص إلى القائمة مع سجل الموافقة). العملية emailMarketingFormConfirm. من مساعد الذكاء الاصطناعي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (يقوم الزائر بتأكيد الاشتراك المزدوج).
• GET /v1/public/email-marketing/o/{token} — صورة تتبع الفتح (ملف GIF بحجم 1x1). تحسب عملية فتح واحدة لكل مستلم. العملية emailMarketingOpenPixel. من مساعد الذكاء الاصطناعي: صفحة يفتحها المستلمون لديكم من البريد الإلكتروني (بكسل تتبع الفتح).
• GET /v1/public/email-marketing/u/{token} — رابط إلغاء الاشتراك في التذييل (بدون تسجيل دخول). العملية emailMarketingUnsubscribePage. من مساعد الذكاء الاصطناعي: صفحة يفتحها المستلمون لديكم من البريد الإلكتروني (صفحة إلغاء الاشتراك).
• POST /v1/public/email-marketing/u/{token} — إلغاء الاشتراك بنقرة واحدة وفقًا لـ RFC 8058 (وزر "إيقاف كل شيء" بالصفحة). العملية emailMarketingUnsubscribeOneClick. من المساعد الذكي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (إلغاء الاشتراك بنقرة واحدة وفقًا لـ RFC 8058).
• GET /v1/public/email-marketing/warmup-u/{token} — رابط إلغاء الاشتراك لبريد إحماء مجمع التسويق (بدون تسجيل دخول). العملية emailMarketingWarmupUnsubscribePage. من المساعد الذكي: صفحة يفتحها المستلمون من البريد الإلكتروني (صفحة إلغاء الاشتراك في الإحماء).
• POST /v1/public/email-marketing/warmup-u/{token} — إلغاء الاشتراك بنقرة واحدة من بريد الإحماء وفقًا لـ RFC 8058. العملية emailMarketingWarmupUnsubscribeOneClick. من المساعد الذكي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (إلغاء الاشتراك في الإحماء بنقرة واحدة).
• POST /v1/webhooks/campaign-events — استيعاب حدث تسليم موقع من مزود البريد الإلكتروني. العملية receiveCampaignDeliveryWebhook. من المساعد الذكي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (خطاف ويب موقع لتسليم ESP).
• POST /v1/webhooks/campaigns/telnyx — ردود الرسائل القصيرة SMS الواردة (STOP / START) من مورد الرسائل القصيرة لدينا. العملية receiveCampaignsTelnyxInbound. من المساعد الذكي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (خطاف ويب وارد موقع لـ Telnyx).
• POST /v1/webhooks/email-marketing/{connection_id} — أحداث التسليم الخاصة بمزود البريد الإلكتروني التابع للعميل لاتصال إرسال واحد. العملية receiveEmailMarketingProviderWebhook. من مساعد ذكاء اصطناعي: يتم استدعاؤه بواسطة نظام آخر (مزود أو زائر)، وليس بواسطتكم (خطاف ويب مُوقّع من المزود المرسل).

Flows

• GET /v1/email-marketing/flows — مسارات البريد الإلكتروني (الترحيب، الرسائل المتتابعة، تاريخ سنوي)، صفحة مفاتيح واحدة. العملية listEmailMarketingFlows. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/flows — إنشاء مسار (يبدأ كمسودة). العملية createEmailMarketingFlow. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — حذف مسار وتسجيلاته (تبقى عمليات التشغيل المرسلة، كحملات). العملية deleteEmailMarketingFlow. الأذونات التي تم التحقق منها: email_marketing.manage، email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• GET /v1/email-marketing/flows/{flow_id} — مسار واحد مع خطواته وتقريره (المسجلون، قيد التنفيذ، عمليات التشغيل والمستلمون لكل خطوة). العملية getEmailMarketingFlow. الأذونات التي تم التحقق منها: email_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• PATCH /v1/email-marketing/flows/{flow_id} — تغيير مسار تسلسلي؛ عند تحديد steps، فإنها تستبدل التسلسل بالكامل. العملية updateEmailMarketingFlow. الأذونات التي تم التحقق منها: email_marketing.manage، وemail_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/flows/{flow_id}/activate — تفعيل مسار تسلسلي؛ يتم تسجيل الأشخاص الذين ينضمون إلى القائمة من الآن فصاعدًا فقط. العملية activateEmailMarketingFlow. الأذونات التي تم التحقق منها: email_marketing.manage، وemail_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.
• POST /v1/email-marketing/flows/{flow_id}/pause — إيقاف مسار تسلسلي مؤقتًا؛ تنتظر الخطوات المستحقة ولا يتم إرسال رسائل بريد إلكتروني لأي أشخاص جدد حتى يُعاد تشغيله. العملية pauseEmailMarketingFlow. الأذونات التي تم التحقق منها: email_marketing.manage، وemail_marketing.view. من مساعد ذكاء اصطناعي: نعم، عبر MCP.