Pivot Request Parameters
Pivot sends some general parameters alongside call’s parameters to developer servers. Parameters are either passed as URL encoded query string
when req_body_format is set to form, or in the request body when req_body_format is set to json and method is post.
Parameters
These parameters are sent in every request. The table below shows the name of these parameters.
Pivot TwiML parameters are used when req_format is twiml, and Callflow parameters is used when req_format is kazoo.
| Callflow Parameters | Pivot TwiML Parameters | Description |
|---|---|---|
Account-ID | AccountSid | The account id receiving the call |
Api-Version | ApiVersion | The version of the API |
Call-ID | CallSid | The unique call identifier |
Caller-ID-Name | CallerName | Caller ID Name |
Caller-ID-Number | CallerNumber | Caller ID Number |
Direction | Direction | The direction of the call, relative to 2600Hz: outbound if 2600Hz originated the call, inbound otherwise |
From-Realm | FromRealm | From SIP realm |
From | From | Caller’s number, if available |
Language | - | The caller’s language preference |
To-Realm | ToRealm | To SIP realm |
To | To | Dialed number, SIP endpoint or user |
User-ID | - | The User ID(s) of the caller |
Optional Parameters
The request may include these parameters after certain callflow modules or Pivot TwiML terms are executed.
| Callflow Parameters | Pivot TwiML Parameters | Description |
|---|---|---|
Call-Status | CallStatus | Status of the call |
Custom-Application-Vars | - | Custom application variables set on the call channel |
Custom-SIP-Headers | - | Custom SIP Headers set on the call channel |
DialCallDuration | DialCallDuration | How many billable seconds in the call |
DialCallSid | DialCallSid | Call-ID of the b-leg |
DialCallStatus | DialCallStatus | Call status of the b-leg |
Digits | Digits | Any DTMF (or collection of DTMFs) pressed |
Recording-Duration | RecordingDuration | How long the recording is |
Recording-ID | RecordingSid | The recording id |
Recording-Url | RecordingUrl | The URL that can be used to retrieve the recorded media |
Request-Realm | - | |
Request | - | |
User-ID | - |