Incoming Calls

HTTP Post from CallAPI to your web server

Once you have the Incoming Call URL set, the web calls will come in normal HTTP post variables as displayed below. POST Objects - Incoming Post Request - New Incoming Call

POST fields in readable format:
    [CallSid]       => IDfbf7e812ere32hfhfg6e10-Cd5dacca0c-CA9d3572be-9f7a-11ea-97f4-5ffeb3239325
    [InstanceId]    => ID242258723hHds8fh29G4569b66e10
    [AccountSid]    => AC06bc1hjh293hFH9edjJ23539a9ddb1
    [From]          => 3035550000
    [To]            => 8044731212
    [CallStatus]    => ringing OR completed OR failed OR in-progress OR no-answer
    [ApiVersion]    => 2012-04-24
    [Direction]     => inbound
    [CallerName]    => 3035550000
    [ForwardedFrom] => null
    [CallTimestamp] => 2020-05-26T17:59:16.555Z
    [PostStatus]    => callback OR new

POST Objects - Status Update from an Outbound Call

    [CallSid]           => ID242253601re32hfhfg6e10-CAceda56a709534034ae7c0e3a304b4d96
    [InstanceId]        => ID242258723hHds8fh29G4569b66e10
    [AccountSid]        => AC06bc1hjh293hFH9edjJ23539a9ddb1
    [From]              => 8044735555
    [To]                => 3035551212
    [CallStatus]        => in-progress
    [ApiVersion]        => 2012-04-24
    [Direction]         => outbound-api
    [CallerName]        => 8044735896
    [ForwardedFrom]     => null
    [CallTimestamp]     => 2020-05-26T17:29:55.125Z
    [VoicemailDetector] => voicemail [or] person_found

3.4.1 Post Fields - Incoming Calls

Attribute	Description
CallSid	A string that uniquely identifies this call.
InstanceId	Server instance ID that this call came from.
AccountSid	The date that this call was created.
From	The party who initiated the call.
To	The party who received the call.
CallStatus	A descriptive status for the call. The value is one of these: completed, failed, ringing, in-progress, no-answer, queued, wait-for-answer, or initiated
ApiVersion	Always set to 2012-04-24.
Direction	Always inbound for inbound calls.
CallerName	If this call was an incoming call, the caller’s name. Empty otherwise.
ForwardedFrom	Where the call was forwarded from (null normally).
CallTimestamp	Timestamp when the call began: 2023-06-01T03:15:51.929Z.
PostStatus	Set to new or callback new - the call is coming in for the first time. callback - this is a callback notification / advancement of the call.

Incoming Call Actions

Once a call has been posted to your server, you can use the API Call Markup Language to process requests. A quick example:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Say voice="woman">Please hold while your call is connceted</Say>
    <Dial>18004444444</Dial>
</Response>

Click here to view the Markup Language documentation.