Events are delivered via WebSocket in real time. Applications subscribe using Subscription Sets.

Connecting to WebSocket

Step-by-step Flow

1. Open WebSocket → wss://<WebAdmin>/api/ws (with Basic Auth)
2. Receive WebSocket ID → {"webSocketId": "aa922613-78ad-..."}
3. Create Subscription Set → POST /api/v1/subscriptions/ws/{wsId}/subscriptionsets
4. Subscribe to events → PUT .../subscriptionsets/{ssId}/calleventaccounts/{account}

Keep-Alive

Send periodic messages (e.g., "hello") to prevent timeout. Server echoes back if alive.

• Public timeout: 1 hour idle
• Gracefully close WebSockets before reconnecting

Call Events

Call events track call lifecycle. Each event includes subscriptionSetId, event, callId, observedParty, timestamp, and version.

dial

Account has dialed a call.

{
  "subscriptionSetId": "12345",
  "event": "dial",
  "callId": 1,
  "observedParty": "100@Windstream",
  "timestamp": "2015-05-11T14:06:52-04",
  "version": "v1",
  "from": "100@Windstream",
  "to": "101@Windstream",
  "sipCallId": "[email protected]",
  "dialingDeviceId": 1
}

ringback

Dialed call is ringing at remote end.

offer