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 |
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: |
direction | string | String describing the direction of the Call – |
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. |
parentCallId | string | ID of the Call that created this leg (child call). |