توثيق InboxWarm API

التوثيق المرجعي لواجهة REST API الخاصة بـ InboxWarm. استخدمه إلى جانب مجموعة InboxWarm API Postman.

في هذه الصفحة

عنوان URL الأساسي المصادقة حدود المعدل الأخطاء فهرس نقاط النهاية

النظام

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

GETسرد حسابات البريد الإلكتروني POSTربط حساب بريد إلكتروني POSTربط مجمّع لحسابات البريد الإلكتروني POSTقطع اتصال حساب البريد الإلكتروني DELETEحذف حساب البريد الإلكتروني POSTحذف مجمّع لحسابات البريد الإلكتروني GETالحصول على حالة حساب البريد الإلكتروني POSTحالة مجمّعة لحسابات البريد الإلكتروني

التسخين

GETالحصول على إعدادات التسخين PATCHتحديث إعدادات التسخين GETعرض لغات الإحماء GETعرض قطاعات الإحماء POSTبدء التسخين POSTإيقاف التسخين POSTإجراء تسخين مجمّع POSTتحديث مجمّع لإعدادات التسخين GETسجل نشاط التسخين

قابلية التسليم

GETالحصول على درجة الإعداد POSTتحديث درجة الإعداد GETفحص صحة DNS POSTالحصول على درجة قابلية التسليم

التقارير

GETلوحة التحكم POSTتقرير حساب واحد POSTتقرير مجمّع POSTتصدير التقرير

https://app.inboxwarm.ai/api/v1

يستخدم InboxWarm مخطط مصادقة مختلطًا اعتمادًا على طريقة HTTP:

GET

طلبات GET وDELETE — أرسل مفتاح API الخاص بك كمعامل استعلام api_key.

POST

طلبات POST وPATCH — أرسل مفتاح API الخاص بك كحقل apiKey داخل نص JSON.

أنشئ المفاتيح وأدرها من Developer kit > API Integration في تطبيق InboxWarm. يمنح كل مفتاح وصولًا كاملاً إلى الحساب عبر كل نقطة نهاية أدناه.

مثال — طلب GET:

GET https://app.inboxwarm.ai/api/v1/email-accounts?api_key=YOUR_API_KEY

مثال — نص طلب POST:

{
  "apiKey": "YOUR_API_KEY",
  ...
}

الحد الافتراضي هو 20 طلبًا/دقيقة لكل مفتاح API. تحقق من الاستخدام الحالي في أي وقت عبر GET /rate-limit — لا يُحتسب هذا الاستدعاء ضمن حصتك.

تتبع الأخطاء بنية متسقة:

{
  "error_code": "validation_error",
  "message": "One or more fields are invalid.",
  "details": {}
}

قيم error_code الشائعة: validation_error (400)، not_found (404)، conflict (409)، unprocessable (422).

النظام

GET/healthفحص الصحة GET/rate-limitحالة حد المعدل

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

GET/email-accountsسرد حسابات البريد الإلكتروني POST/email-accountsربط حساب بريد إلكتروني POST/email-accounts/bulk-connectربط مجمّع لحسابات البريد الإلكتروني POST/email-accounts/{emailAccountId}/disconnectقطع اتصال حساب البريد الإلكتروني DELETE/email-accounts/{emailAccountId}حذف حساب البريد الإلكتروني POST/email-accounts/bulk-deleteحذف مجمّع لحسابات البريد الإلكتروني GET/email-accounts/{emailAccountId}/statusالحصول على حالة حساب البريد الإلكتروني POST/email-accounts/bulk-statusحالة مجمّعة لحسابات البريد الإلكتروني

التسخين

GET/warmup-settings/{emailAccountId}الحصول على إعدادات التسخين PATCH/warmup-settings/{emailAccountId}تحديث إعدادات التسخين GET/warmup-settings/languagesعرض لغات الإحماء GET/warmup-settings/industriesعرض قطاعات الإحماء POST/warmup-settings/{emailAccountId}/startبدء التسخين POST/warmup-settings/{emailAccountId}/stopإيقاف التسخين POST/warmup-settings/bulk-actionإجراء تسخين مجمّع POST/warmup-settings/bulk-updateتحديث مجمّع لإعدادات التسخين GET/warmup-status/{emailAccountId}سجل نشاط التسخين

قابلية التسليم

GET/setup-score/{emailAccountId}الحصول على درجة الإعداد POST/setup-score/{emailAccountId}/refreshتحديث درجة الإعداد GET/dns-health/{emailAccountId}فحص صحة DNS POST/deliverability-score/{emailAccountId}الحصول على درجة قابلية التسليم

التقارير

GET/dashboardلوحة التحكم POST/reportsتقرير حساب واحد POST/reports/bulkتقرير مجمّع POST/reports/exportتصدير التقرير

GEThttps://app.inboxwarm.ai/api/v1/health

فحص أساسي لحيوية API.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "status": "ok"
}

GEThttps://app.inboxwarm.ai/api/v1/rate-limit

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

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "limit": 20,
  "remaining": 18,
  "reset": 1752585600
}

GEThttps://app.inboxwarm.ai/api/v1/email-accounts

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

المصادقة:معامل الاستعلامapi_key

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

searchالبحث حسب عنوان البريد الإلكتروني أو الاسم

statusactive | warming | paused | error | auth-expired

sort

sortBy

الاستجابات

{
  "items": [
    {
      "id": "12345",
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "status": "warming",
      "createdAt": "2026-06-01T10:00:00.000Z"
    },
    {
      "id": "12346",
      "fromEmail": "sales@yourcompany.com",
      "fromName": "Sales Team",
      "type": "microsoft",
      "status": "active",
      "createdAt": "2026-06-03T14:20:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts

اربط حساب Gmail أو Microsoft أو SMTP/IMAP باستخدام بيانات اعتماد SMTP/IMAP (تعمل كلمة مرور التطبيق مع كل من Gmail وMicrosoft). احفظ emailAccountId المُعاد — فكل نقطة نهاية أخرى مرتبطة به.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "fromEmail": "john@yourcompany.com",
  "fromName": "John Doe",
  "type": "gmail",
  "smtp": {
    "host": "smtp.example.com",
    "port": 587,
    "password": "your-password",
    "encryption": "TLS",
    "userName": "smtp-username"
  },
  "imap": {
    "host": "imap.example.com",
    "port": 993,
    "encryption": "SSL",
    "userName": "imap-username"
  }
}

الاستجابات

{
  "emailAccountId": "12345",
  "fromEmail": "john@yourcompany.com",
  "fromName": "John Doe",
  "type": "gmail",
  "status": "active"
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-connect

اربط ما يصل إلى 20 حسابًا في استدعاء واحد. يتم التحقق من كل إدخال وربطه بشكل مستقل — فلا يوقف حساب واحد غير صالح أو مكرر باقي الحسابات — وتُبلغ الاستجابة عن نجاح أو فشل كل حساب، بنفس ترتيب المُدخلات.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccounts": [
    {
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "smtp": { "host": "smtp.example.com", "port": 587, "password": "your-password", "encryption": "TLS", "userName": "smtp-username" },
      "imap": { "host": "imap.example.com", "port": 993, "encryption": "SSL", "userName": "imap-username" }
    },
    {
      "fromEmail": "sales@yourcompany.com",
      "type": "microsoft",
      "smtp": { "password": "app-specific-password" }
    }
  ]
}

الاستجابات

{
  "results": [
    {
      "success": true,
      "emailAccountId": "12345",
      "fromEmail": "john@yourcompany.com",
      "fromName": "John Doe",
      "type": "gmail",
      "status": "active"
    },
    {
      "success": false,
      "fromEmail": "sales@yourcompany.com",
      "error_code": "already_connected",
      "message": "This email address is already connected.",
      "details": {}
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}/disconnect

أوقف حسابًا مؤقتًا دون حذفه. يتم الحفاظ على الإعدادات والسجل لإعادة الاتصال لاحقًا.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}"
}

الاستجابات

{
  "emailAccountId": "12345",
  "status": "disconnected"
}

DELETEhttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}

أزل حسابًا نهائيًا مع جميع بيانات التسخين والسجل المرتبطة به.

المصادقة:معامل الاستعلامapi_key

الاستجابات

لا يوجد محتوى للاستجابة

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-delete

أزل نهائيًا ما يصل إلى 20 حسابًا في استدعاء واحد.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ]
}

الاستجابات

{
  "results": [
    {
      "emailAccountId": "12345",
      "deleted": true
    },
    {
      "emailAccountId": "12346",
      "deleted": true
    }
  ]
}

GEThttps://app.inboxwarm.ai/api/v1/email-accounts/{emailAccountId}/status

حالة تفصيلية لحساب واحد — صحة الاتصال، وحالة التسخين، وحالة المصادقة، والأخطاء النشطة.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "emailAccountId": "12345",
  "fromEmail": "john@yourcompany.com",
  "type": "gmail",
  "authStatus": "connected",
  "warmupStatus": "active",
  "healthScore": 92,
  "connectionError": null,
  "lastConnectedAt": "2026-07-15T08:00:00.000Z"
}

POSThttps://app.inboxwarm.ai/api/v1/email-accounts/bulk-status

حالة ما يصل إلى 50 حسابًا في استدعاء واحد، تُعاد بنفس ترتيب المعرفات المُدخلة.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ]
}

الاستجابات

{
  "results": [
    {
      "emailAccountId": "12345",
      "fromEmail": "john@yourcompany.com",
      "type": "gmail",
      "authStatus": "connected",
      "warmupStatus": "active",
      "healthScore": 92,
      "connectionError": null,
      "lastConnectedAt": "2026-07-15T08:00:00.000Z"
    },
    {
      "emailAccountId": "12346",
      "fromEmail": "sales@yourcompany.com",
      "type": "microsoft",
      "authStatus": "connected",
      "warmupStatus": "paused",
      "healthScore": 81,
      "connectionError": null,
      "lastConnectedAt": "2026-07-14T22:10:00.000Z"
    }
  ]
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}

جلب تكوين التسخين الحالي لحساب ما.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "emailAccountId": "12345",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

PATCHhttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}

تحديث إعداد واحد أو أكثر من إعدادات التسخين لحساب ما — اسم المرسل، أو المنطقة الزمنية، أو جدول الإرسال، أو اللغة، أو الصناعة، أو المواضيع. يتم تغيير الحقول التي ترسلها فقط.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

الاستجابات

{
  "emailAccountId": "12345",
  "displayName": "Ada Lovelace",
  "timeZone": "America/New_York",
  "sendingDays": [1, 2, 3, 4, 5],
  "sendingWindowStartTime": "09:00",
  "sendingWindowEndTime": "17:00",
  "warmupLanguage": "en",
  "targetIndustry": "saas_software",
  "warmupTopics": ["Referral request", "Case study"]
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/languages

عرض كل لغة يمكن توليد محتوى الإحماء بها، لمعرفة القيم التي تقبلها warmupLanguage.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "languages": [
    { "code": "en", "name": "English", "nativeName": "English", "script": "Latin" },
    { "code": "es", "name": "Spanish", "nativeName": "Español", "script": "Latin" },
    { "code": "ja", "name": "Japanese", "nativeName": "日本語", "script": "Japanese" }
  ]
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-settings/industries

عرض كل قطاع مستهدف والمواضيع المقترحة له، لمعرفة القيم التي تقبلها targetIndustry وwarmupTopics.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "industries": [
    {
      "key": "e_commerce",
      "name": "E-Commerce",
      "topics": [
        "Abandoned cart follow-up",
        "New product launch",
        "Seasonal sale announcement",
        "Order and shipping update",
        "Customer review request"
      ]
    },
    {
      "key": "saas_software",
      "name": "SaaS / Software",
      "topics": ["Feature announcement", "Onboarding tip", "Case study"]
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}/start

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

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}"
}

الاستجابات

{
  "emailAccountId": "12345",
  "warmupStatus": "active"
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/{emailAccountId}/stop

أوقف التسخين لحساب ما.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}"
}

الاستجابات

{
  "emailAccountId": "12345",
  "warmupStatus": "paused"
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/bulk-action

ابدأ أو أوقف التسخين لما يصل إلى 50 حسابًا في استدعاء واحد.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "action": "start"
}

الاستجابات

{
  "results": [
    {
      "emailAccountId": "12345",
      "status": "ok"
    },
    {
      "emailAccountId": "12346",
      "status": "ok"
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/warmup-settings/bulk-update

طبّق إعدادات الجدول و/أو المحتوى على ما يصل إلى 50 حسابًا في استدعاء واحد.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "apply": ["language", "window"],
  "warmupLanguage": "es",
  "sendingWindowStartTime": "06:00",
  "sendingWindowEndTime": "10:00"
}

الاستجابات

{
  "updatedCount": 2
}

GEThttps://app.inboxwarm.ai/api/v1/warmup-status/{emailAccountId}

نشاط التسخين اليوم لحساب ما: المُرسَل، المُستلَم، المُردود عليه، المزعج، المرتد.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "emailAccountId": "12345",
  "date": "2026-07-15",
  "current": "active",
  "dailySendingLimit": 10,
  "sent": 12,
  "received": 10,
  "replied": 7,
  "spam": 1,
  "bounced": 0
}

GEThttps://app.inboxwarm.ai/api/v1/setup-score/{emailAccountId}

درجة صحة الإعداد المخزنة مؤقتًا (فحوصات DMARC وSPF وDKIM وMX والقائمة السوداء) لحساب ما.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "emailAccountId": "12345",
  "emailAccountScore": 86,
  "dmarcScore": 15,
  "spfScore": 29,
  "dkimScore": 18,
  "mxRecordScore": 9,
  "ipBlacklistScore": 5,
  "domainBlacklistScore": 10,
  "updatedAt": "2026-07-14T10:30:00.000Z",
  "manualLastRefreshedAt": "2026-07-14T10:30:00.000Z"
}

POSThttps://app.inboxwarm.ai/api/v1/setup-score/{emailAccountId}/refresh

أعد حساب درجة الإعداد لحساب ما بشكل متزامن.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}"
}

الاستجابات

{
  "emailAccountId": "12345",
  "emailAccountScore": 88,
  "dmarcScore": 15,
  "spfScore": 29,
  "dkimScore": 18,
  "mxRecordScore": 9,
  "ipBlacklistScore": 7,
  "domainBlacklistScore": 10,
  "updatedAt": "2026-07-15T09:00:00.000Z",
  "manualLastRefreshedAt": "2026-07-15T09:00:00.000Z"
}

GEThttps://app.inboxwarm.ai/api/v1/dns-health/{emailAccountId}

بحث DNS مباشر لنطاق الإرسال الخاص بالحساب — نجاح/فشل لـ SPF وDKIM وDMARC وMX.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "emailAccountId": "12345",
  "spf": "pass",
  "dkim": "pass",
  "dmarc": "pass",
  "mx": "pass",
  "cachedAt": "2026-07-15T09:00:00.000Z"
}

POSThttps://app.inboxwarm.ai/api/v1/deliverability-score/{emailAccountId}

معدل قابلية تسليم صندوق الوارد مقابل الرسائل المزعجة إجماليًا ولكل ESP لنطاق تاريخي.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "startDate": "2026-06-01",
  "endDate": "2026-06-30",
  "esps": [
    "gmail",
    "outlook",
    "other"
  ]
}

الاستجابات

{
  "emailAccountId": "12345",
  "totalDeliverabilityRate": 88,
  "totalSentCount": 1500,
  "totalInboxCount": 1320,
  "totalSpamInboxCount": 180,
  "gmail": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  },
  "outlook": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  },
  "other": {
    "deliverabilityRate": 92,
    "sentCount": 500,
    "inboxCount": 460,
    "spamCount": 40
  }
}

GEThttps://app.inboxwarm.ai/api/v1/dashboard

ملخص تسخين على مستوى الحساب عبر جميع صناديق البريد الوارد المتصلة.

المصادقة:معامل الاستعلامapi_key

الاستجابات

{
  "totalAccounts": 42,
  "activeWarmups": 30,
  "pausedWarmups": 8,
  "accountsWithErrors": 2,
  "avgSetupScore": 78.5
}

POSThttps://app.inboxwarm.ai/api/v1/reports

تقرير تسخين يومي لحساب واحد على مدى نطاق تاريخي.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccountId": "12345",
  "from": "2026-06-01",
  "to": "2026-06-30"
}

الاستجابات

{
  "emailAccountId": "12345",
  "from": "2026-06-01",
  "to": "2026-06-30",
  "days": [
    {
      "date": "2026-06-15",
      "sent": 25,
      "inbox": 20,
      "received": 22,
      "spam": 3,
      "bounced": 1,
      "undelivered": 0,
      "replied": 5,
      "deliverabilityRate": 92.5
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/reports/bulk

تقارير تسخين يومية لما يصل إلى 50 حسابًا على مدى نطاق تاريخي.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "from": "2026-06-01",
  "to": "2026-06-30"
}

الاستجابات

{
  "reports": [
    {
      "emailAccountId": "12345",
      "from": "2026-06-01",
      "to": "2026-06-30",
      "days": [
        {
          "date": "2026-06-15",
          "sent": 25,
          "inbox": 20,
          "received": 22,
          "spam": 3,
          "bounced": 1,
          "undelivered": 0,
          "replied": 5,
          "deliverabilityRate": 92.5
        }
      ]
    }
  ]
}

POSThttps://app.inboxwarm.ai/api/v1/reports/export

ابدأ تصدير CSV غير متزامن لتقارير التسخين، يُسلَّم عبر البريد الإلكتروني عند جاهزيته.

المصادقة:حقل النصapiKey

نص الطلب

{
  "apiKey": "{{apiKey}}",
  "emailAccountIds": [
    "12345",
    "12346"
  ],
  "from": "2026-06-01",
  "to": "2026-06-30"
}

الاستجابات

{
  "jobId": "a1b2c3d4",
  "status": "queued"
}

توثيق InboxWarm API

عنوان URL الأساسي#

المصادقة#

حدود المعدل#

الأخطاء#

فهرس نقاط النهاية#

النظام

فحص الصحة#

حالة حد المعدل#

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

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

ربط حساب بريد إلكتروني#

ربط مجمّع لحسابات البريد الإلكتروني#

قطع اتصال حساب البريد الإلكتروني#

حذف حساب البريد الإلكتروني#

حذف مجمّع لحسابات البريد الإلكتروني#

الحصول على حالة حساب البريد الإلكتروني#

حالة مجمّعة لحسابات البريد الإلكتروني#

التسخين

الحصول على إعدادات التسخين#

تحديث إعدادات التسخين#

عرض لغات الإحماء#

عرض قطاعات الإحماء#

بدء التسخين#

إيقاف التسخين#

إجراء تسخين مجمّع#

تحديث مجمّع لإعدادات التسخين#

سجل نشاط التسخين#

قابلية التسليم

الحصول على درجة الإعداد#

تحديث درجة الإعداد#

فحص صحة DNS#

الحصول على درجة قابلية التسليم#

التقارير

لوحة التحكم#

تقرير حساب واحد#

تقرير مجمّع#

تصدير التقرير#