Live Server-Sent Events stream of a call's lifecycle

Server URLloading...

GET

/v1/calls/{id}/stream

Send

Authorization

Path

Opens a text/event-stream (SSE) connection that pushes call lifecycle transitions (ringing, answered, completed, failed, …) as they happen. Intended for the in-app dialer's live call view.

Past lifecycle events are also embedded inline on the Call resource (Call.events) — this endpoint is only for the live tail; there is no separate read endpoint for historical events.

The connection stays open until the call reaches a terminal state or the client disconnects.

The two id forms behave slightly differently by design. A session id (HD_…) attaches immediately — the browser dialer knows it before the call row exists, and subscribing early is the point, so no existence check is made; the channel is always scoped to the calling workspace, so an unknown session id simply yields a stream that never emits. A call UUID is looked up, and 404s when this workspace owns no such call. A call whose PBX session has not landed yet holds the request open for a few seconds rather than failing, since origination returns the UUID before the box calls back.

Path Parameters

Response Body

curl -X GET "https://example.com/v1/calls/string/stream"

"string"

{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ]  }}

{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ]  }}