الانتقال إلى المحتوى الرئيسي

الرابط الأساسي

الافتراضي هو http://localhost:3000. مع APP_BASE_PATH=/gowa، كل مسار يتحرك تحت /gowa باستثناء /health.

المصادقة

عندما يتم تعيين APP_BASIC_AUTH، كل مسار يتطلب مصادقة أساسية HTTP، باستثناء /health، /statics/*، و Chatwoot webhook و MCP OAuth نقاط النهائية. انظر Authentication.

تحديد الجهاز

معظم المسارات تعمل على جهاز WhatsApp واحد. اختر مع رأس X-Device-Id (معرف الفتحة أو JID)، أو معلمة الاستعلام device_id. عندما يكون لدى الخادم جهاز واحد بالضبط يمكنك حذفه؛ والمزيد مطلوب. انظر Multi-device.

مجموعات نقاط النهاية

تُولَّد صفحات نقاط النهاية في علامة التبويب هذه من مواصفات OpenAPI الخاصة بـ GOWA. التعريف المرجعي المعتمد هو docs/openapi.yaml في مستودع الخادم. يستخدم هذا الموقع نسخة متزامنة في openapi.yml، تتضمن /send/interactive. ويوثّق دليل الرسائل التفاعلية القيود الحالية لهذه النقطة.

الطلبات

  • هيئات JSON: Content-Type: application/json.
  • تحميل الملف: multipart/form-data.
  • أرقام الهاتف: أرقام مع رمز البلد (628123456789) أو كاملًا JID (...@s.whatsapp.net, ...@g.us).

الاستجابات

تكون قيمة code إما SUCCESS أو رمز خطأ؛ ويحتوي results على البيانات. انظر الأخطاء.

مثال

أسماء جهات الاتصال

GET /user/my/contacts يرجع اسم عرض مفضل لكل جهة اتصال. على GWA main بعد v9.9. ، اتصل بـ GET /user/my/contacts/detailed للحصول على full_name, first_name, push_name, و business_name كحقول منفصلة. تقوم GOWA بإسقاط الأسماء الفارغة وتشمل lid على الرقم الهاتفي JID عندما يكون الجهاز لديه خرائط. تحتوي النتائج على جهات اتصال شخصية من الجهاز المحدد، مرتبة حسب jid.

واجهات أخرى

  • WebSocket في /ws لأحداث لوحة التحكم المباشرة.
  • MCP في /mcp لوكلاء AI (MCP server).
  • Webhooks دفع إلى عناوين URL الخاصة بك (Webhooks).