Skip to navigation

Live events of a rep call

Server-sent events, one EngineEvent JSON per data: line with its id: (call.ringing, call.answered, call.screening, call.voicemail_detected, call.beep, call.transcript, call.suggestion, call.voicemail_left, call.voicemail_failed, call.recording, call.ended, call.summary, call.completed), and a : ping comment every 15 seconds. A new stream starts with what the call has had so far (up to 500 events, for an hour); reconnect with Last-Event-ID (or ?lastEventId=) to get only what you missed.

Needs the calls:read scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The rep call id.

Query parameters

lastEventIdstringOptional

For clients that cannot send the Last-Event-ID header.

Response

A server-sent event stream of the call’s events, with a comment heartbeat every 15 seconds.

idstring

evt_…, unique.

typeenum
atdatetime
datamap from strings to any
callIdstringOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error