Pivot Requests

Pivot can send requests to developer servers with parameters in either the request URL query string when req_body_format is set to form, or in the request body when req_body_format is set to json.

Payload

These parameters are sent in every request. Pivot TwiML style parameters are used when req_format is twiml, Kazoo Callflow is used otherwise.

Kazoo Callflow ParametersPivot TwiML ParametersDescription
Call-IDCallSidThe unique call identifier
Account-IDAccountSidThe account id receiving the call
Api-VersionApiVersionThe version of the API
DirectionDirectionThe direction of the call, relative to Kazoo
Caller-ID-NameCallerNameCaller ID Name
Caller-ID-NumberCallerNumberCaller ID Number
User-ID-The Kazoo User identifier(s) of the caller
Language-The caller’s language preference
DirectionDirectionDirection of the call (outbound if Kazoo originated the call, inbound otherwise)
ToTo-UserDialed number, SIP endpoint or user
FromFrom-UserCaller’s number, if available
ToRealmTo-RealmTo SIP realm
FromRealmFrom-RealmFrom SIP realm

Optional Payload

These parameters may be sent after certain callflow modules or Pivot TwiML terms.

Kazoo Callflow ParametersPivot TwiML ParametersDescription
DigitsDigitsAny DTMF (or collection of DTMFs) pressed
Call-StatusCallStatusStatus of the call
Recording-UrlRecordingUrlWhere a recording is sent when using external storage
Recording-DurationRecordingDurationHow long the recording is
Recording-IDRecordingSidThe recording id
RecordingSidMedia-Namerecording filename
DialCallDurationBilling-SecondsHow many billable seconds in the call
DialCallSidOther-Leg-Unique-IDCall-ID of the b-leg
DialCallStatus-Call status of the b-leg

On this page