outDialApiConnect

An outbound call initiated by the REST API has connected and the callConnectUrl specified in the API request is being invoked. A PerCL response is expected if the call was successfully connected (with status of inProgress).

Request Parameter

Type

Description

requestType

string

Context or reason why this request is being made. Will be outDialApiConnect - An outbound call spawned by the REST API has connected and the callConnectUrl specified in the API request is being invoked.

callId

string

Unique identifier for this Call, generated by FreeClimb

accountId

string

Account ID associated with your account.

from

string

Phone number of the party that initiated the Call (in E.164 format).

to

string

Phone number or SIP URL of the party that is receiving the call (phone number in E.164 format).

callStatus

string

Descriptive status for the Call. Valid values are:
ringing - Call is currently ringing.
inProgress - Call was answered and is currently in progress (not queued, not in conference).
completed - Call 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.
canceled - Call was canceled via the REST API while queued or ringing.

direction

string

String describing the direction of the Call – inbound for inbound calls, outboundAPI for Calls initiated via the REST API, or outboundDial for Calls initiated by the OutDial command.

conferenceId

string

This is only populated if request pertains to a conference. Otherwise, it is set to null.

queueId

string

This is only populated if the request pertains to a queue. Otherwise, it is set to null.

dialCallStatus

string

Note - this is duplicate of callStatus. Use is not recommended as this will be deprecated in the future.
Outcome of the dial attempt. Valid values are:
inProgress - Called party answered the Call.
busy - FreeClimb received a busy signal when trying to connect to the called party.
noAnswer - Called party did not pick up before the timeout period passed.
failed - FreeClimb was unable to route to the given phone number. This is frequently caused by dialing a properly formatted but non-existent phone number.
canceled - Call was canceled via the REST API before it was answered.

parentCallId

string

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