> ## 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イベント

> ダッシュボードをGOWAのWebSocketに接続し、デバイスとイベントのペアリングを行い、ログインの再接続または完了後にデバイスの状態を更新します。

GOWAはペアリングとデバイスイベントを `/ws` 上にプッシュします。 それぞれのフレームには、機械で読める`code`、人間が読める`message`、イベントによって形状が異なる`result`を含むJSONオブジェクトが含まれています。

## 接続する

`APP_BASE_PATH` 配下の `/ws`（例: `wss://gowa.example.com/gowa/ws`）を使用してください。`?device_id=<id>` でデバイスを選択します。Basic Auth が有効な場合、ブラウザークライアントは `user:password` の base64 値を URL エンコードし、`authorization` として渡します。`Authorization` ヘッダーを設定できるクライアントは、そのヘッダーで Basic Auth を利用できます。`wss://` を使用し、プロキシのログではクエリ文字列をマスクしてください。ダッシュボードを別の場所でホストする場合は、そのオリジンを GOWA の[信頼するブラウザーのオリジン](https://gowa-docs.mintlify.site/ja/authentication.md#cors)に追加してください。

接続された各ソケットは、接続がデバイスを指定する場合でも、各ブロードキャストを受け取ります。`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`がtrueの場合、アクティブなQRフローは自動的に確認を送信します。 そうでなければ、コードを電話機と比較し、`POST /app/passkey/confirm` を呼び出します。 |
| `PASSKEY_ERROR` | パスキーのペアリングに失敗しました。 | `device_id` 、 `continuation` 。`message` からエラーテキストを読み取る。 |
| `DEVICE_LOGGED_OUT` | デバイスはログアウトし、スロットを保持します。 | `device_id` に加え、リモートログアウトの場合は `reason`、API 経由のログアウトの場合は `devices` が含まれます。リストの形式はログアウトエンドポイントによって異なります。 |
| `DEVICE_REMOVED` | デバイス スロットが削除されました。 | `device_id`, `devices` (残りのスロット). |
| `DEVICE_STREAM_REPLACED` | 別のクライアントは、同じWhatsAppセッションに接続します。 | `device_id` |
| `DEVICE_TEMPORARY_BAN` | WhatsAppは一時的な禁止を報告します。 | `device_id`、`code`、`reason`、および WhatsApp が有効期限を提供する場合は `expires_in_seconds` と `expires_at`。 |
| `DEVICE_REACHOUT_TIMELOCK` | WhatsAppは、新しいチャットの開始に関する制限を報告または解除します。 | `device_id`、`is_active`、オプションの `enforcement_type` および `ends_at` 。 |
| `DEVICE_WEBHOOK_UPDATED` | デバイスの webhook の URL が変更されます。 | `device_id`, `webhook_url`. |
| `DEVICE_WEBHOOK_CONFIG_UPDATED` | デバイスのWebhook設定が変更されます。 | `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);
  }
});
```

パスキー要求を完了する REST 呼び出しについては、[パスキーのペアリング](https://gowa-docs.mintlify.site/ja/authentication.md#%E3%83%91%E3%82%B9%E3%83%AF%E3%83%BC%E3%83%89)を参照してください。WhatsAppメッセージとレシートを処理するには、 [webhooks](https://gowa-docs.mintlify.site/ja/concepts/webhooks.md)を使用してください。


## Related topics

- [認証](https://gowa-docs.mintlify.site/ja/authentication.md)
- [Webhooks](https://gowa-docs.mintlify.site/ja/concepts/webhooks.md)
- [マルチデバイスとデバイス選択](https://gowa-docs.mintlify.site/ja/concepts/multidevice.md)
- [APIリファレンス](https://gowa-docs.mintlify.site/ja/api-reference/introduction.md)
- [Production Best Practices](https://gowa-docs.mintlify.site/ja/advanced/best-practices.md)


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