Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
calls

Find a specific call

Returns a single Call instance for a given call id.

get/calls/{id}

Path parameters

idinteger required

An id of a call

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Response

successful operation

idinteger

An id of an action

fromNumberstring

A sender's phone number in E.164 (11-digit) format

toNumberstring

A recipient's phone number in E.164 (11-digit) format

attributesobject

Map of user-defined string attributes associated with an action

state'READY' | 'SELECTED' | 'CALLBACK' | 'FINISHED' | 'DISABLED' | 'SKIPPED' | 'DNC' | 'DUP' | 'INVALID' | 'TIMEOUT' | 'PERIOD_LIMIT' | 'RESTRICTED_NUMBER'

State of an action (READY, SELECTED, CALLBACK, DISABLED, FINISHED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT). See call states and results

campaignIdinteger

An id of broadcast associated with an action if call is sent as part of call broadcast

batchIdinteger

An id of contact batch associated with an action

inboundboolean

Is action inbound

createdinteger

The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

modifiedinteger

The time when the given resource was modified, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

labelsstring[]

Labels associated with action or broadcast for this action

finalCallResult'LA' | 'AM' | 'BUSY' | 'DNC' | 'XFER' | 'NO_ANS' | 'XFER_LEG' | 'INTERNAL_ERROR' | 'CARRIER_ERROR' | 'CARRIER_TEMP_ERROR' | 'UNDIALED' | 'SD' | 'POSTPONED' | 'ABANDONED' | 'SKIPPED'

Result of a call (LA, AM, BUSY, DNC, XFER, NO_ANS, XFER_LEG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED, SD, POSTPONED, ABANDONED, SKIPPED). See call states and results

agentCallboolean

An internal call to an agent