inbound

An inbound Call to a number registered on FreeClimb will trigger a request to the voiceUrl of the application the number is assigned to. FreeClimb expects to receive PerCL in response to this request in order to process the Call. The following parameters are sent as the POST body.

Request Parameter

Type

Description

requestType

string

Context or reason why this request is being made. Will be inboundCall - An inbound call was received and the voiceUrl 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 provisioned to you and to which this Call is directed (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. Will be inbound.

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.

parentCallId

Null