Pivot

About PivotCopied

Execute an HTTP request to a web server about the call, expecting more callflow instructions in the response.

| cdr_url | URL to send the CDR (Call Data Record) to at the end of the call. If used, CDRs for for the initial all and any additional calls connected during the pivot session will be sent to this URL at the end of the call.
The body is encoded in application/x-www-form-urlencoded format.
Note that 2600Hz always stores CDRs accessible through the CDRs API. This parameter allows for the CDRs to additionally be sent to developer servers.

No Default | | debug | Store debug logs of the requests and responses to your application. These logs are then available via the Pivot API

Defaults to false | | req_timeout_ms | How long, in milliseconds, to wait for a Pivot response from the developer server. maximum value is 5 seconds. 2600Hz highly recommends that your application respond to requests under 5 seconds to avoid call quality issues.

Defaults to 5000 | | req_body_format | Format to encode the request body, including request parameters when using POST, valid options are

* form: request body will be encoded in application/x-www-form-urlencoded format as a query string
* json: request bdoy will be formatted in application/json

Defaults to form | | custom_request_headers | Custom HTTP headers to include on each Pivot request to the voice_url. 2600Hz expects these headers to conform to the HTTP protocol spec. For example, header names must be prefixed with X-
Used to pass additional data to developer servers.

No Default |

Schema

Validator for the Pivot callflow element

Key	Description	Type	Default	Required	Support Level
cdr_url	Optional URL to send the CDR to at the end of the call	string(7..)		false
`custom_request_headers./^[x	X]-/`	Include a custom X- header	string()		false
custom_request_headers	Custom HTTP X- headers to be included on each Pivot request to the voice_url	object()		false
debug	Store debug logs related to processing this Pivot call	boolean()	false	false
method	What HTTP verb to send the request(s) with	string('get' | 'post' | 'GET' | 'POST')	get	false
req_body_format	What format should the request body have when using POST	string('form' | 'json')	form	false
req_format	What format of Pivot will the your server respond with	string('kazoo' | 'twiml')	kazoo	false
req_timeout_ms	How long, in milliseconds, to wait for a Pivot response from the HTTP server	integer(..5000)		false
skip_module	When set to true this callflow action is skipped, advancing to the wildcard branch (if any)	boolean()		false
voice_url	What URL to request the initial Pivot callflow	string(7..)		true

TwiML

TwiML support is limited at the moment; 2600Hz JSON is highly encouraged.

Handling failuresCopied

The Pivot request can fail for a number of reasons:

• DNS resolution of the web server fails
• Connection (TLS or clear) to the web server fails
• Response is not of a known content-type
• Response is not valid callflow JSON

The pivot callflow action waits until either

1. The Pivot response is processed successfully, in which case the pivot callflow action exits quietly
2. The Pivot response fails (for whatever reason), in which case the pivot callflow action goes to the default _ child branch (if any).

In the example below, if an error occurs when getting a response from {SERVER_URL}, the caller will hear the media at {MEDIA_ID} played and the call will end.

"flow": {
    "data": {
        "method": "GET",
        "req_timeout": "5",
        "req_format": "kazoo",
        "voice_url": "{SERVER_URL}"
    },
    "module": "pivot",
    "children": {
        "_": {
            "module": "play",
            "data": {
                "id": "{MEDIA_ID}"
            },
            "children": {}
        }
    }
}