Integration Server

On this page

RestAPI

Description

This box allows you to use Restful API to GET, POST, PUT, DELETE data from external applications or sources (for example: ticketing systems, CRM, order systems, and so on). The result of the API request (Body) can also be stored in a Variable.

Parameters

• Label: here you can type a brief description

• URL: request URL

• Method: HTTP method (GET, POST, PUT or DELETE)

• Timeout: request timeout (in seconds: it must be greater than 1 and the default value is 5)

• Computed Variables Script Path: absolute path of a NodeJS script able to compute variables to pass in the URL, Headers and Bod

• Headers: request headers (it must be in RAW JSON format, i.e. {"key": "value"})

• Body: request body (it must be in RAW JSON format, i.e. {"key": "value"})

• Variable: here you can choose a variable from a pick up list where you want to store the body of the response. The system will parse the body of the response and it will create a variable for each key-value pair using the format variable name + <key> (e.g. variablename.key, variablename.index.key or variablename.key[0].subkey if key is an array, and so on)

Custom script guidelines

You can valorize custom variables to use in you request using a nodejs script located on your server.

You can insert the absolute path to the script inside the Computed Variables Script Path input.

Remember to follow these important rules:

• insert the absolute path to the file

• write the path without quotes

• the motion user must have both read and write and execution privileges on the js file (or it won't work at all once it is required).

• The js script must be written in javascript ECMA5, and follow the NodeJs 6.x framework syntax based on this template:

module.exports = function({options_object}){

// custom code

const variables = { code output as object }; // it must be an object, not an array

return variables

}

The script also receives the options you inserted in the restAPI block, including URL and method, so you can use them in the script if needed.

e.g.

const { URL } = require('url');

module.exports = function(options){

const request = options;

const method = request.method;

const uri = request.uri;

const myURL = new URL(uri);

const host = myURL.host;

const hostname = myURL.hostname;

const href = myURL.href;

const pathname = myURL.pathname;

// etc...

// additional custom code

const variables = { code output as object };

return variables

}

Variables and custom (script) variables

To include asterisk variables in your URL, you must include them in curly brackets.

e.g.

https://myurl.com?phone={CALLERID(num)}

The same apply if you want to include them in the body of your request, or in your headers ( pay attention to the quotes "").

e.g.

{

"phone":"{CALLERID(num)}"

}

To include custom (script) variables, you must include them in double dollar $$ symbols.

e.g.

Your script returns an object like this:

{

key1: "value1",

key2: "value2"

}

To use them in your URL you can write:

https://myurl.com?myvar1=$$key1$$&myvar2=$$key2$$

and it will be completed like this:

https://myurl.com?myvar1=value1&myvar2=value2

The same apply if you want to include them in the body of your request, or in your headers ( pay attention to the quotes "").

So, if your body/header object is written like this:

{

"myvar1":"$$key1$$",

"myvar2":"$$key2$$"

}

it will be completed like this:

{

"myvar1":"value1",

"myvar2":"value2"

}

NOTE: All special chars in the returned strings from the script are escaped ( e.g. the slash / character is translated to &#x27, so if you want to avoid that you need to in clude an & symbol before the variable name:

e.g.

{

"myvar1":"$$&key1$$",

"myvar2":"$$&key2$$"

}

Built-in variables

We provide the following Asterisk channels variables named

• variable name + _STATUS_CODE: shows the HTTP request status code

• variable name + _STATUS_MESSAGE: shows the HTTP request status message

Example: RESULT_STATUS_CODE

Exit Arrows

This box provides just one arrow out to the next step