═══════════════════════════════════════════════════════════════════════════════ Omdaa API — مرجع سريع (Quick Reference) · محدّث يوليو 2026 ═══════════════════════════════════════════════════════════════════════════════ Base URL (الإنتاج): https://omdaa.com/api/v1 Base URL (التطوير): http://localhost:5000/api/v1 Health: GET /api/v1/health Docs site: https://omdaa.net Swagger: https://omdaa.com/api/v1/docs ⭐ Free Forever — جلسات ورسائل وwebhooks وOmdaa AI بلا حدود · بدون بطاقة ائتمان https://omdaa.com/en/free-forever ─────────────────────────────────────────────────────────────────────────────── المصادقة (Authentication) ─────────────────────────────────────────────────────────────────────────────── يقبل Omdaa أحد الطرق التالية (JWT أو API Key): 1) JWT بعد تسجيل الدخول: Header: Authorization: Bearer 2) API Key عبر Bearer (مفضّل للتكاملات): Header: Authorization: Bearer المفتاح عادةً hex بطول 64 حرفاً (يُعرض مرة واحدة عند الإنشاء). 3) API Key عبر هيدر مخصص (توافق خلفي): Header: X-API-Key: إنشاء مفتاح (يتطلب JWT): POST /api/v1/api-keys/create Body: { "name": "My Key", "permissions": ["*"], // الافتراضي: صلاحيات كاملة "expiresAt": null // اختياري } كتالوج الصلاحيات: GET /api/v1/api-keys/permissions الافتراضي عند الإنشاء: ["*"] أمثلة صلاحيات دقيقة: messages:send | messages:receive | sessions:read | sessions:manage groups:read | groups:manage | webhooks:manage | integrations:manage chats:manage | contacts:read | storage:manage | labels:manage | dashboard:read لوحة التحكم: https://omdaa.com/dashboard/api-keys ─────────────────────────────────────────────────────────────────────────────── التسجيل وتسجيل الدخول ─────────────────────────────────────────────────────────────────────────────── POST /api/v1/auth/register Body: { "email", "password", "name" } POST /api/v1/auth/login Body: { "email", "password" } Response: { success, data: { token | accessToken, user, ... } } ─────────────────────────────────────────────────────────────────────────────── الجلسات (Sessions) — المسار الرسمي /sessions ملاحظة: /instances في التوثيق القديم → استخدم /sessions ─────────────────────────────────────────────────────────────────────────────── إنشاء جلسة: POST /api/v1/sessions/create قائمة الجلسات: GET /api/v1/sessions تفاصيل جلسة: GET /api/v1/sessions/:sessionId حالة الجلسة: GET /api/v1/sessions/:sessionId/status QR (JSON/نص): GET /api/v1/sessions/:sessionId/qr QR صورة: GET /api/v1/sessions/:sessionId/qr/image أو GET /api/v1/sessions/:sessionId/qr?format=image إعادة توليد QR: POST /api/v1/sessions/:sessionId/qr/regenerate (يتطلب sessions:manage مع API Key) قطع الاتصال: DELETE /api/v1/sessions/:sessionId/logout حذف جلسة: DELETE /api/v1/sessions/:sessionId أو DELETE /api/v1/sessions/delete/:sessionId (يتطلب sessions:manage مع API Key) ─────────────────────────────────────────────────────────────────────────────── الرسائل (Messages) ─────────────────────────────────────────────────────────────────────────────── إرسال نص: POST /api/v1/messages/send-text Body: { "sessionId", "to", "message" } إرسال صورة: POST /api/v1/messages/send-image إرسال ملف: POST /api/v1/messages/send-document تفاعلي: POST /api/v1/messages/send-interactive رقم "to" بصيغة دولية بدون + (مثال: 966501234567). المصادقة: JWT أو API Key مع messages:send (أو *). ─────────────────────────────────────────────────────────────────────────────── الويب هوكس (Webhooks) ─────────────────────────────────────────────────────────────────────────────── POST /api/v1/webhooks Body: { "sessionId", "url", "events" اختياري } أحداث شائعة: message:received, message:send, session:open, session:close, presence.update, chat.updated لوحة التحكم: https://omdaa.com/dashboard/webhooks ─────────────────────────────────────────────────────────────────────────────── التكاملات النشطة (يوليو 2026) ─────────────────────────────────────────────────────────────────────────────── • N8N Bots /dashboard/n8n /api/v1/integrations/n8n-bot • Omdaa AI /dashboard/openai /api/v1/integrations/openai-bot (افتراضي الإنتاج: Groq + llama-3.1-8b-instant) • Free API /dashboard/free-api /api/v1/free/ (outbox push/pull/ack) • Geo Links /dashboard/geo-links /api/v1/geo/ و /api/v1/user/geo-links/ • Webhooks / API Keys / Zapier / Baileys / Meta Cloud (حالة) أُزيلت من الواجهة (لا تعتمد عليها في تكاملات جديدة): Typebot · Chatwoot · Dify · Flowise · EvoAI · Evolution Bot · MyTayibat Bridge n8n على الإنتاج: https://omdaa.com/n8n/ Webhook جاهز: https://omdaa.com/n8n/webhook/omdaa-whatsapp ─────────────────────────────────────────────────────────────────────────────── Free API Outbox (للأنظمة الخارجية بدون webhook فوري) ─────────────────────────────────────────────────────────────────────────────── Push events: POST /api/v1/free/outbox/... Pull: GET /api/v1/free/outbox/... Ack: POST /api/v1/free/outbox/.../ack راجع: /guides/free-api-geo-ar.html و /dashboard/free-api ─────────────────────────────────────────────────────────────────────────────── المجموعات / جهات الاتصال / المحادثات ─────────────────────────────────────────────────────────────────────────────── المجموعات: /api/v1/groups/... جهات الاتصال: /api/v1/contacts/... المحادثات: /api/v1/chats/... ─────────────────────────────────────────────────────────────────────────────── رموز الحالة والأخطاء ─────────────────────────────────────────────────────────────────────────────── 200 OK · 201 Created · 400 Bad Request · 401 Unauthorized 403 Forbidden (صلاحية API Key ناقصة) · 404 Not Found 429 Too Many Requests · 500 Internal Server Error شكل الاستجابة المعتاد: { "success": true|false, "data": ..., "message": "..." } ─────────────────────────────────────────────────────────────────────────────── MCP Server v2.0 — تحكم كامل بالحساب (43 أداة) ─────────────────────────────────────────────────────────────────────────────── Endpoint: POST https://omdaa.com/api/v1/mcp Discovery: GET https://omdaa.com/api/v1/mcp/info (بدون مصادقة) Auth: Authorization: Bearer ⚠️ لا تستخدم ?key= في الرابط (مهمل) مجموعات الأدوات: جلسات · رسائل · صندوق وارد · webhooks · ملف/إحصائيات تكاملات (Omdaa AI / n8n / Free API / Geo) · مفاتيح API · health ملاحظات أمان: • الحذف/الإزالة تحتاج confirm: true • إنشاء/إلغاء/تدوير مفاتيح API يحتاج JWT (ليس API Key) تثبيت Cursor: https://omdaa.com/mcp دليل: /guides/mcp-ar.html · /guides/mcp-en.html Directory: https://cursor.directory/plugins/omdaa-api ─────────────────────────────────────────────────────────────────────────────── روابط مفيدة ─────────────────────────────────────────────────────────────────────────────── • Free Forever: https://omdaa.com/en/free-forever • MCP landing: https://omdaa.com/mcp • دليل MCP عربي: /guides/mcp-ar.html • دليل MCP إنجليزي: /guides/mcp-en.html • أدلة التوثيق: /guides/ • صلاحيات API Key: /guides/api-permissions-ar.html • البدء السريع: /guides/quick-start-ar.html • سجل التغييرات: /changelog.html • حالة النظام: https://omdaa.com/status (المصدر: https://status.omdaa.com/status/omdaa) • SDK GitHub: https://github.com/omdaapi/omdaa-sdk ═══════════════════════════════════════════════════════════════════════════════