API للمطورين

واجهة REST API واحدة للقوائم والحملات وبريد المعاملات، وللذكاء الاصطناعي أيضًا.

البدء

تتضمن كل باقة مدفوعة وصولًا كاملًا إلى REST API. أنشئ مفتاحًا في حسابك من الحساب ← مفاتيح API، ثم أرسله مع كل طلب:

curl -H "X-Api-Key: YOUR_KEY" https://mailflow.top/api/index.php/lists

عنوان URL الأساسي: https://mailflow.top/api/index.php · تكون الاستجابات بتنسيق JSON وتتضمن حقل status بقيمة success أو error. لا تتوفر API في الباقة المجانية.

الموارد الأساسية

المنصة متوافقة مع MailWizz، لذا فإن واجهة API الأساسية الكاملة — القوائم، والمشتركون، والشرائح، والحقول المخصصة، والحملات، والتتبّع، والقوالب، وبريد المعاملات، والارتدادات، وإلغاءات الاشتراك — موثّقة بشكل تفاعلي (OpenAPI) على:

← مرجع API التفاعلي (OpenAPI)

تعمل حِزم SDK الحالية الخاصة بـ MailWizz (مثل PHP SDK الرسمية) مباشرةً دون أي إعداد؛ ما عليك سوى توجيهها إلى عنوان URL الأساسي أعلاه.

نقاط نهاية الذكاء الاصطناعي

ميزات الذكاء الاصطناعي جزء أصيل من API: المفتاح نفسه، والمصادقة نفسها، وحدود الباقة واحتساب الأرصدة نفسها كما في تطبيق الويب.

GET /ai/credits

عدّاد أرصدة الذكاء الاصطناعي للشهر الحالي. تُحتسب الأرصدة لكل شهر فوترة، ولا تُرحَّل الأرصدة غير المستخدمة.

{"status":"success","data":{"unlimited":false,"limit":750,"used":112,"remaining":638}}

GET /ai/replies

تصنيفات الردود الذكية لحملاتك: زوّد نظام CRM لديك بمن هو مهتم، ومن طرح سؤالًا، ومن اشتكى. عوامل التصفية: category (interested، question، complaint، unsubscribe_request، auto_reply، out_of_office، bounce، other)، campaign_uid، since (YYYY-MM-DD)، page، per_page (50 كحد أقصى).

curl -H "X-Api-Key: YOUR_KEY" \
  "https://mailflow.top/api/index.php/ai/replies?category=interested&since=2026-08-01"

{"status":"success","data":{"count":42,"current_page":1,"per_page":20,"total_pages":3,
  "records":[{"from_email":"[email protected]","subject":"RE: your offer",
    "category":"interested","confidence":98,"engine":"embeddings",
    "summary":"...","suggested_reply":"...","date_added":"2026-08-24 18:21:19",
    "campaign_uid":"py794hjqk8a8d"}]}}

GET /ai/tiers

مستويات التفاعل المحددة بالذكاء الاصطناعي (vip، engaged، passive، at_risk، dormant) لكل قائمة، وهو التقييم نفسه الذي يشغّل الطيار الآلي واستعادة المشتركين.

{"status":"success","data":{"records":[
  {"list_uid":"qk661oq7nl8c1","name":"Main list","tiers":{"engaged":1200,"passive":3400,"dormant":900}}]}}

POST /ai/subject-lines

توليد أسطر الموضوع بأي لغة. نص الطلب: topic (إلزامي)، count (1–5، الافتراضي 3)، language (اختياري). يستهلك أرصدة الذكاء الاصطناعي مثل محرر الويب.

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"topic":"Summer sale for B2B customers","count":3,"language":"Greek"}' \
  https://mailflow.top/api/index.php/ai/subject-lines

{"status":"success","data":{"subjects":["...","...","..."],"credits_remaining":636}}

GET /ai/flows · POST /ai/flows/author · POST /ai/flows/<uid>/enroll · POST /ai/flows/<uid>/status

منشئ مسارات العمل بالذكاء الاصطناعي عبر API: اعرض مسارات العمل لديك مع عدّادات مباشرة؛ واجعل الذكاء الاصطناعي يؤلّف مسار عمل كاملًا انطلاقًا من هدف مكتوب بلغة بسيطة ({"goal":"...","list_uid":"..."} — يُعيد مسودة تفعّلها باستخدام {"status":"active"})؛ وأضف مشتركًا إلى مسار عمل ({"email":"..."}).

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"goal":"When someone replies interested, notify me, wait 2 days, then send a case study"}' \
  https://mailflow.top/api/index.php/ai/flows/author

الأخطاء والحدود

  • 401X-Api-Key مفقود أو غير صالح
  • 403 — الميزة غير مضمّنة في باقتك
  • 422 — معلمات مفقودة أو غير صالحة
  • 429 — تم بلوغ حد أرصدة الذكاء الاصطناعي أو الحصة الشهرية للذكاء الاصطناعي؛ يُعاد ضبطه في تاريخ الفوترة التالي

يُحَدّ من دفعات الطلبات المتلاحقة لكل مفتاح، لذا طبّق التراجع الأُسّي عند تلقي 429. هل لديك أسئلة؟ تواصل معنا أو افتح تذكرة دعم.