Calls

A Call represents a voice connection between FreeClimb and a remote end point. This connection may be inbound (when a person calls a FreeClimb number) or outbound (when an application initiates the Call, either via the REST API or the OutDial PerCL command. The Calls list resource represents the set of all phone Calls made to and from an account.

FreeClimb currently does not support direct SIP user agent endpoints. If you are interested in SIP trunking, please contact support.

Resource properties

A Call resource is represented by the following properties:

Property

Type

Description

uri

string

URI for this resource, relative to /apiserver.

dateCreated

string date-time

Date that this resource was created (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).

dateUpdated

string date-time

Date that this resource was last updated (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).

dateCreatedISO

string date-time

Date that this resource was created (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).

dateUpdatedISO

string date-time

Date that this resource was last updated (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).

revision

integer

Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated.

callId

string

String that uniquely identifies this Call resource.

parentCallId

string

ID of the Call that created this leg (child Call).

accountId

string

ID of the account that owns this Call.

to

string

Phone number that received this Call.

from

string

Phone number that initiated this Call.

phoneNumberId

string

If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS).
If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI).

status

string

queued – Call is ready and waiting in line before going out.
ringing – Call is currently ringing.
inProgress – Call was answered and is currently in progress.
canceled – Call was hung up while it was queued or ringing.
completed – Call was answered and has ended normally.
busy – Caller received a busy signal.
failed – Call could not be completed as dialed, most likely because the phone number was non-existent.
noAnswer – Call ended without being answered.

startTime

string date-time

Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.

connectTime

string date-time

Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed.

endTime

string date-time

End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). This value is empty for queued, ringing, or inProgress Calls.

connectDuration

int integer

Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.

duration

int integer

Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls.

direction

string

Direction of the Call. inbound for Calls into FreeClimb, outboundAPI for Calls initiated via the REST API, outboundDial for Calls initiated by the OutDial PerCL command.

answeredBy

string

If this Call was initiated with answering machine detection, either human or machine. Empty otherwise. Note -- FreeClimb can detect standard answering machine/fax tones, but otherwise cannot guarantee an actual live human being answered the call.

applicationId

string

The applicationId of the Application the phoneNumber was attached to.

webRTC

boolean

Denotes if this Call was webRTC or not.

subresourceUris

object

The list of subresources for this Call. These include things like logs and recordings associated with the Call.