IVR HTTP Request step

This step starts a HTTP request (or HTTPS) to an external server. Using this step Accolades can send data to the server, using the methods available in the protocol (GET or POST).

If it is the case, then Accolades can process the answer received from the server, if the answer is JSON formatted. If the answer is valid and the resulting object contains properties that have the same name as some of the IVR variables (defined in the configuration step) then those values will be imported to the current call.

Properties

This type of step has the following properties:

Protocol

defines the protocol used for the connection (http or https);

Server (URL)

the address of the destination server (IP or FQDN) without any delimiter at the end (example.com is valid but example.com/ is invalid);

Port

the port for the connection (80 is the default one for http and 443 for https);

Path

the path to the destination file, that must start with a forward slash "/" (for example "/" or "/processing.php");

Method

sthe method for sending variables to the server (POST or GET), used only if there are any variables to send;

Variables

the parameters that will be sent to the server, using an URL type encoding: name1=value1&name2=value2 (this format is used regardless of the selected method for sending);

Wait for confirmation

if set to No then after the HTTP request has been initiated, the call will move to the next step (without waiting for the server response), if the parameter is set to Yes then the call will move to the next step only after the server response has been processed;

JSON response processing

(available only if the "Wait for confirmation parameter" is set to Yes) if it is set to Yes then Accolades will parse the server response as an JSON object and if the result is valid then all the variables that have identical names with the IVR ones (defined during the configuration step) will be imported as values to the current call.

The parameters that have the dollar sign ($) in their name (server, port, path and variables) can contain variables (defined during the configuration step) using the format $variableName. When the step is being processed, the variables will be replaced with their current values.

Step options

Edit

The option allows the administrator to edit the parameters for this step.

Folders

The folder management is made using the "Folders" option. A description for this set of options has been made inside the "Common options" section of this chapter.

Continue

After the step has been finished, the call will move further into the IVR structure, by accessing the step defines in the "Ok" option.