> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# مرجع API

> عنوان URL الأساسي والمصادقة واختيار الجهاز وتنسيقات الطلبات والبنية الموحّدة للاستجابات في واجهة GOWA REST API.

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

```text theme={null}
http://<host>:3000<APP_BASE_PATH>
```

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

## المصادقة

عندما يتم تعيين `APP_BASIC_AUTH`، كل مسار يتطلب مصادقة أساسية HTTP، باستثناء `/health`، `/statics/*`، و Chatwoot webhook و MCP OAuth نقاط النهائية. انظر [Authentication](https://gowa-docs.mintlify.site/ar/api-reference/authentication.md).

## تحديد الجهاز

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

| نطاق الجهاز | غير مقياس للجهاز |
| - | - |
| `/app/*` (باستثناء `/app/info` و`/app/metrics`)، و`/send/*`، و`/message/*`، و`/chat/*`، و`/chats`، و`/user/*`، و`/group/*`، و`/newsletter/*`، و`/call/*` | `/devices*`, `/app/info`, `/app/metrics`, `/health`, `/mcp`, `/chatwoot/*` |

انظر [Multi-device](https://gowa-docs.mintlify.site/ar/concepts/multidevice.md).

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

| مجموعة | الغرض |
| - | - |
| الأجهزة | إنشاء وقائمة وتسجيل الدخول، تسجيل الخروج وحذف فتحات الجهاز؛ عناوين الويب لكل جهاز وتشكيلات Chatwoot. |
| التطبيق | تسجيل الدخول (QR، رمز الاقتران، مفتاح المرور)، تسجيل الدخول، إعادة الاتصال، حالة معلومات الخادم والمعالجة، الذاكرة، القرص ومقاييس الجهاز. |
| إرسال | النصوص ووسائط الإعلام والاتصال والموقع والربط والاستطلاع والحضور والجدولة والرسائل التفاعلية التجريبية الفورية. |
| رسالة | رد الفعل، تحرير، إلغاء، حذف، قراءة، نجم، إلى الأمام، تنزيل الوسائط. |
| الدردشة | قائمة المحادثات، الرسائل؛ التثبت ، الأرشيف، المؤقت المختفي، طلب التاريخ. |
| المستخدم | معلومات الملف الشخصي، الصورة الرمزية، اسم الدفع، الخصوصية، جهات الاتصال، المجموعات، التحقق من الأرقام. |
| مجموعة | إنشاء، مشاركين، مشرفين، طلبات الإنضمام، الإعدادات، وصلات الدعوة. |
| النشرة الإخبارية | متابعة، إلغاء المتابعة، معلومات القناة، الدليل، الرسائل، العدادات، التحديثات المباشرة، وتحميل الوسائط. |
| اتصل | رفض المكالمات الواردة. |

تُولَّد صفحات نقاط النهاية في علامة التبويب هذه من مواصفات OpenAPI الخاصة بـ GOWA. التعريف المرجعي المعتمد هو [`docs/openapi.yaml`](https://github.com/aldinokemal/go-whatsapp-web-multidevice/blob/main/docs/openapi.yaml) في مستودع الخادم. يستخدم هذا الموقع نسخة متزامنة في `openapi.yml`، تتضمن `/send/interactive`. ويوثّق [دليل الرسائل التفاعلية](https://gowa-docs.mintlify.site/ar/examples/interactive-messages.md) القيود الحالية لهذه النقطة.

## الطلبات

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

## الاستجابات

```json theme={null}
{
  "code": "SUCCESS",
  "message": "Success",
  "results": {}
}
```

تكون قيمة `code` إما `SUCCESS` أو رمز خطأ؛ ويحتوي `results` على البيانات. انظر [الأخطاء](https://gowa-docs.mintlify.site/ar/api-reference/errors.md).

## مثال

```bash theme={null}
curl -u admin:changeme -X POST http://localhost:3000/send/message \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{"phone": "628123456789", "message": "Hello from GOWA"}'
```

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

`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`.

```bash theme={null}
curl -u admin:changeme -H "X-Device-Id: my-device" \
  http://localhost:3000/user/my/contacts/detailed
```

## واجهات أخرى

* **[WebSocket](https://gowa-docs.mintlify.site/ar/api-reference/websocket.md)** في `/ws` لأحداث لوحة التحكم المباشرة.
* **MCP** في `/mcp` لوكلاء AI ([MCP server](https://gowa-docs.mintlify.site/ar/integrations/mcp.md)).
* **Webhooks** دفع إلى عناوين URL الخاصة بك ([Webhooks](https://gowa-docs.mintlify.site/ar/concepts/webhooks.md)).


## Related topics

- [البداية السريعة](https://gowa-docs.mintlify.site/ar/quickstart.md)
- [GOWA: واجهة WhatsApp REST API](https://gowa-docs.mintlify.site/ar/index.md)
- [مصادقة API](https://gowa-docs.mintlify.site/ar/api-reference/authentication.md)
- [مرجع التكوين](https://gowa-docs.mintlify.site/ar/configuration.md)
- [أخطاء](https://gowa-docs.mintlify.site/ar/api-reference/errors.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.