═══════════════════════════════════════════════════════════════════════════════ Omdaa API — مرجع سريع (Quick Reference) ═══════════════════════════════════════════════════════════════════════════════ Base URL (الإنتاج): https://omdaa.com/api/v1 Base URL (التطوير): http://localhost:5000/api/v1 ─────────────────────────────────────────────────────────────────────────────── المصادقة (Authentication) ─────────────────────────────────────────────────────────────────────────────── • JWT (بعد تسجيل الدخول): Header: Authorization: Bearer YOUR_JWT_TOKEN • API Key (للتكاملات طويلة الأمد): Header: X-API-Key: omdaa_xxxxxxxxxxxxxxxxxxxxx إنشاء API Key (يتطلب JWT): POST /api/v1/api-keys/create Body: { "name": "My Key", "expiresAt": "2025-12-31" } ─────────────────────────────────────────────────────────────────────────────── التسجيل وتسجيل الدخول ─────────────────────────────────────────────────────────────────────────────── POST /api/v1/auth/register Body: { "email", "password", "name" } POST /api/v1/auth/login Body: { "email", "password" } Response: { "token", "user", ... } ─────────────────────────────────────────────────────────────────────────────── الجلسات (Sessions / Instances) ─────────────────────────────────────────────────────────────────────────────── إنشاء جلسة: POST /api/v1/instances قائمة الجلسات: GET /api/v1/instances حالة الجلسة: GET /api/v1/instances/:sessionId/state QR للربط: GET /api/v1/instances/:sessionId/qr قطع الاتصال: POST /api/v1/instances/:sessionId/logout ─────────────────────────────────────────────────────────────────────────────── الرسائل (Messages) ─────────────────────────────────────────────────────────────────────────────── إرسال نص: POST /api/v1/messages/send-text Body: { "sessionId", "to", "message" } إرسال صورة: POST /api/v1/messages/send-image Body: form-data أو JSON مع sessionId, to, image (url أو base64)، caption اختياري إرسال ملف: POST /api/v1/messages/send-document Body: sessionId, to, document, filename اختياري إرسال رسالة تفاعلية (قوائم، أزرار): POST /api/v1/messages/send-interactive Body: sessionId, to, ونوع interactive (list، buttons، إلخ) حسب التوثيق رقم "to" بصيغة دولية بدون + (مثال: 966501234567). ─────────────────────────────────────────────────────────────────────────────── الويب هوكس (Webhooks) ─────────────────────────────────────────────────────────────────────────────── تعيين رابط الويب هوك للجلسة (يتطلب مصادقة): POST /api/v1/webhooks Body: { "sessionId", "url", "events" اختياري } أحداث شائعة: message:received, message:send, session:open, session:close, presence.update, chat.updated، إلخ. راجع توثيق Webhooks للقائمة الكاملة. عند استقبال رسالة، يرسل Omdaa حدثاً (مثل message:received) إلى الرابط المُعدّ؛ يمكن ربط هذا الرابط بـ n8n أو أي خادمك لمعالجة الرسائل والرد تلقائياً. ─────────────────────────────────────────────────────────────────────────────── التكامل مع N8N ─────────────────────────────────────────────────────────────────────────────── حالة التكامل: GET /api/v1/integrations/n8n/status إنشاء بوت N8N: POST /api/v1/integrations/n8n-bot/create قائمة البوتات: GET /api/v1/integrations/n8n-bot/list/:sessionId تحديث بوت: PUT /api/v1/integrations/n8n-bot/:botId حذف بوت: DELETE /api/v1/integrations/n8n-bot/:botId اختبار بوت: POST /api/v1/integrations/n8n-bot/test/:botId إعدادات البيئة لتفعيل N8N: N8N_ENABLED=true، N8N_WEBHOOK_URL=... ─────────────────────────────────────────────────────────────────────────────── المجموعات، جهات الاتصال، المحادثات ─────────────────────────────────────────────────────────────────────────────── المجموعات: GET/POST /api/v1/groups/... جهات الاتصال: GET/POST /api/v1/contacts/... المحادثات: GET /api/v1/chats/... التفاصيل الكاملة في صفحات التوثيق: en/docs/groups، en/docs/contacts، en/docs/chats. ─────────────────────────────────────────────────────────────────────────────── رسائل مجدولة ورسائل جماعية ─────────────────────────────────────────────────────────────────────────────── جدولة: POST /api/v1/scheduled/... جماعي: POST /api/v1/bulk/... راجع en/docs/scheduled و en/docs/bulk. ─────────────────────────────────────────────────────────────────────────────── قوالب واتساب (Templates) والتخزين (Storage) ─────────────────────────────────────────────────────────────────────────────── قوالب: GET/POST /api/v1/templates/... تخزين: GET/POST /api/v1/storage/... (رفع/تحميل ملفات، S3/MinIO) ─────────────────────────────────────────────────────────────────────────────── رموز الحالة والأخطاء ─────────────────────────────────────────────────────────────────────────────── 200 OK 201 Created 400 Bad Request (تحقق من الـ body والبارامترات) 401 Unauthorized (توكن غير صالح أو منتهي) 403 Forbidden 404 Not Found 429 Too Many Requests (تحديد معدل الطلبات) 500 Internal Server Error تفاصيل الأخطاء والأمان في: en/docs/errors ─────────────────────────────────────────────────────────────────────────────── روابط التوثيق الكامل ─────────────────────────────────────────────────────────────────────────────── • نظرة عامة: /en/docs.html • البدء السريع: /en/docs/getting-started.html • المصادقة: /en/docs/authentication.html • الجلسات: /en/docs/instances.html • الرسائل: /en/docs/messages.html • الويب هوكس: /en/docs/webhooks.html • التكاملات: /en/docs/integrations.html • أتمتة الرد بالذكاء الاصطناعي: AI_AUTO_REPLY_GUIDE.txt ═══════════════════════════════════════════════════════════════════════════════