Call Flow Sessions

List call flow sessions.

get

Returns one entry per incoming call that was handled by a call flow, most recent call first.

Authorizations

AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters

start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0

max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50

call-flowsinteger · int64[]Optional

call flow IDs of the call flow that handled the call

call-flow-numbersinteger · int64[]Optional

call flow number IDs of the number the call came in on

from-numberstringOptional

the phone number the call was made from, in E.164 format

fromstring · date-timeOptional

only return calls that started at or after this point in time

untilstring · date-timeOptional

only return calls that started before this point in time

Responses

200

The call flow sessions

application/json

idinteger · int64Optional

callSidstringOptional

The identifier of the call at the telephony provider.

createdAtstring · date-timeOptional

The point in time the call came in.

updatedAtstring · date-timeOptional

callEndedAtstring · date-timeOptional

The point in time the caller hung up.

flowEndedAtstring · date-timeOptional

The point in time the call flow finished running.

callFlowIdinteger · int64Optional

The call flow that handled the call.

numberIdinteger · int64Optional

The call flow number the call came in on.

statusstring · enumOptionalPossible values:

toNumberstringOptional

The number that was called, in E.164 format.

connectedToUserIdinteger · int64Optional

The user the call was connected to, if it was routed to one.

fromNumberstringOptional

The number the call was made from, in E.164 format.

fromCitystringOptional

fromZipstringOptional

fromStatestringOptional

fromCountrystringOptional

recordedMessageUrlstringOptional

Link to the voicemail recording, if the caller left one.

get/call-flow-sessions

GET /api/call-flow-sessions HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

The call flow sessions

[
  {
    "id": 1,
    "callSid": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "callEndedAt": "2026-01-01T00:00:00.000Z",
    "flowEndedAt": "2026-01-01T00:00:00.000Z",
    "callFlowId": 1,
    "numberId": 1,
    "status": "DEFAULT",
    "toNumber": "text",
    "connectedToUserId": 1,
    "fromNumber": "text",
    "fromCity": "text",
    "fromZip": "text",
    "fromState": "text",
    "fromCountry": "text",
    "recordedMessageUrl": "text"
  }
]

Get a call flow session.

get

Authorizations

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

200

The requested call flow session

application/json

idinteger · int64Optional

callSidstringOptional

The identifier of the call at the telephony provider.

createdAtstring · date-timeOptional

The point in time the call came in.

updatedAtstring · date-timeOptional

callEndedAtstring · date-timeOptional

The point in time the caller hung up.

flowEndedAtstring · date-timeOptional

The point in time the call flow finished running.

callFlowIdinteger · int64Optional

The call flow that handled the call.

numberIdinteger · int64Optional

The call flow number the call came in on.

statusstring · enumOptionalPossible values:

toNumberstringOptional

The number that was called, in E.164 format.

connectedToUserIdinteger · int64Optional

The user the call was connected to, if it was routed to one.

fromNumberstringOptional

The number the call was made from, in E.164 format.

fromCitystringOptional

fromZipstringOptional

fromStatestringOptional

fromCountrystringOptional

recordedMessageUrlstringOptional

Link to the voicemail recording, if the caller left one.

get/call-flow-sessions/{id}

GET /api/call-flow-sessions/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

The requested call flow session

{
  "id": 1,
  "callSid": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "callEndedAt": "2026-01-01T00:00:00.000Z",
  "flowEndedAt": "2026-01-01T00:00:00.000Z",
  "callFlowId": 1,
  "numberId": 1,
  "status": "DEFAULT",
  "toNumber": "text",
  "connectedToUserId": 1,
  "fromNumber": "text",
  "fromCity": "text",
  "fromZip": "text",
  "fromState": "text",
  "fromCountry": "text",
  "recordedMessageUrl": "text"
}

Get the data that was collected during a call flow session.

get

Returns the values the call flow collected while the call was running, for example a menu selection or a transcription. Which properties are present depends on the nodes the call passed through.

Authorizations

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

200

The collected data

application/json

objectOptional

The collected values, keyed by name.

get/call-flow-sessions/{id}/data

GET /api/call-flow-sessions/{id}/data HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

The collected data

{}