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

# أحداث WebSocket

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

يرسل GOWA أحداث الاقتران والأجهزة عبر `/ws`. يحتوي كل إطار على كائن JSON يتضمن `code` قابلًا للقراءة آليًا، و`message` مقروءة للمستخدم، و`result` تختلف بنيته بحسب الحدث.

## الاتصال

استخدم `/ws` ضمن `APP_BASE_PATH`، مثل `wss://gowa.example.com/gowa/ws`. اختر جهازًا باستخدام `?device_id=<id>`. عند تفعيل المصادقة الأساسية، تمرّر تطبيقات المتصفح قيمة `user:password` بترميز base64 ثم بترميز URL في `authorization`. ويمكن للتطبيقات القادرة على ضبط ترويسة `Authorization` استخدام المصادقة الأساسية عبر تلك الترويسة. استخدم `wss://` واحجب سلسلة الاستعلام في سجلات الوكيل. أضف مصدر لوحة التحكم إلى [مصادر المتصفح الموثوقة](https://gowa-docs.mintlify.site/ar/authentication.md#cors) في GOWA إذا كنت تستضيفها بشكل منفصل.

كل مقبس متصل يتلقى كل بث ، حتى عندما يحدد الاتصال جهازًا. استخدم `result.device_id` لتحديد الفتحة المتأثرة عند وجودها. منح WebSocket حق الوصول فقط إلى المتصلين الموثوق بهم مع جميع الأجهزة.

## حمولة الحدث

| `code` | عندما تصل | `result` |
| - | - | - |
| `LIST_DEVICES` | يرسل العميل `FETCH_DEVICES`. | قائمة الأجهزة مع إدخالات `name` و `device` و `jid`. |
| `LOGIN_SUCCESS` | WhatsApp يزوج الجهاز. | `null`. حدّث حالة الجهاز عبر REST. |
| `PASSKEY_REQUEST` | WhatsApp يطلب تأكيد مفتاح المرور. | `device_id`, `challenge` (WebAuthn Options). |
| `PASSKEY_CONFIRMATION` | WhatsApp يبلغ عن نتيجة انهاء مفتاح المرور. | `device_id`, `code`, `skip_handoff_ux`. عندما يكون `skip_handoff_ux` صحيحًا، فإن تدفق QR النشط يرسل التأكيد تلقائياً. وإلا قم بمقارنة الكود مع الهاتف واتصل بـ `POST /app/passkey/confirm`. |
| `PASSKEY_ERROR` | إقران كلمة المرور فشل. | `device_id`، `continuation`. اقرأ نص الخطأ من `message`. |
| `DEVICE_LOGGED_OUT` | الجهاز يسجل الخروج ويحتفظ بفتحته. | `device_id`، ومعه إما `reason` لتسجيل الخروج عن بُعد أو `devices` لتسجيل الخروج عبر API. تعتمد بنية القائمة على نقطة نهاية تسجيل الخروج. |
| `DEVICE_REMOVED` | تم حذف فتحة الجهاز. | `device_id`، `devices` (الخانات المتبقية). |
| `DEVICE_STREAM_REPLACED` | وهناك عميل آخر يتصل بنفس جلسة WhatsApp. | `device_id`. |
| `DEVICE_TEMPORARY_BAN` | WhatsApp يفيد بحظر مؤقت. | `device_id`, `code`, `reason`, `expires_in_seconds`, and `expires_at` عندما يقوم WhatsApp بإمداد انتهاء صلاحيته. |
| `DEVICE_REACHOUT_TIMELOCK` | WhatsApp يبلغ أو يرفع قيدا على بدء دردشة جديدة. | `device_id` و`is_active` و`enforcement_type` و`ends_at`. |
| `DEVICE_WEBHOOK_UPDATED` | يتغير رابط الويبهوك للجهاز. | `device_id`, `webhook_url`. |
| `DEVICE_WEBHOOK_CONFIG_UPDATED` | تغيير إعدادات الويبهوك للجهاز. | `device_id`. |

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

لطلب قائمة عبر اتصال المقبس، أرسل `{"code":"FETCH_DEVICES"}` كإطار نصي. يبث GOWA حدث `LIST_DEVICES` الناتج إلى جميع اتصالات المقابس. للحصول على الحالة الحالية بعد إعادة الاتصال أو الاقتران، استدعِ `GET /devices` أو `GET /devices/{device_id}/status`. أحداث WebSocket عابرة.

```javascript theme={null}
const url = new URL("wss://gowa.example.com/ws");
url.searchParams.set("device_id", "my-device");
url.searchParams.set("authorization", btoa("admin:changeme"));

const socket = new WebSocket(url);
socket.addEventListener("open", () => {
  socket.send(JSON.stringify({ code: "FETCH_DEVICES" }));
});
socket.addEventListener("message", ({ data }) => {
  const { code, result } = JSON.parse(data);
  if (code === "LIST_DEVICES") {
    console.log("Device list", result);
  }
  if (code === "DEVICE_LOGGED_OUT" && result?.device_id === "my-device") {
    console.log("Device logged out", result.device_id);
  }
});
```

راجع [زوج مفتاح المرور](https://gowa-docs.mintlify.site/ar/authentication.md#%D9%83%D9%84%D9%85%D8%A9-%D8%A7%D9%84%D9%85%D8%B1%D9%88%D8%B1) لمكالمات REST التي تكمل طلب مفتاح المرور. استخدم [webhooks](https://gowa-docs.mintlify.site/ar/concepts/webhooks.md) لمعالجة رسائل واتسآب والإيصالات.


## Related topics

- [المصادقة](https://gowa-docs.mintlify.site/ar/authentication.md)
- [مصادقة API](https://gowa-docs.mintlify.site/ar/api-reference/authentication.md)
- [الوب](https://gowa-docs.mintlify.site/ar/concepts/webhooks.md)
- [اختيار الأجهزة المتعددة و الأجهزة](https://gowa-docs.mintlify.site/ar/concepts/multidevice.md)
- [مرجع API](https://gowa-docs.mintlify.site/ar/api-reference/introduction.md)


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