Page Comparison

\uD83D\uDCCB What’s about

This group provides the capabilities to connect the IVR application with a remote DB Schema to perform queries and operations.  

◾ Database

This box lets you perform a query to a DB schema. You must define a DB connection according to the instructions (please refer to the V3 ODBC section) 

• Variable: here you can choose a variable from a pick-up list where you want to store the query results. Please, consider the variable to be a matrix where the columns are mapped to the fields you put in the SELECT clause of your SQL statement, and the rows are the records returned by the query. The first row is addressed with the 0 index and the next ones are addressed with 1, 2, etc, etc

Built-in variables

We provide the following Asterisk channels variables named

• variable name + _ROWS_COUNT:shows the number of affected rows (only for SELECT statements).

Example: RESULT_ROWS_COUNT

Exit Arrows

This box provides just one arrow out to the next step

◾ SendMail

This box lets you send an email to a specified email address(es). Before using this block, please configure the email accounts under the Email channel or the SMTP section.

◾SendSMS

This box lets you send a text message (SMS) to one recipient

◾ SestekNDA

Status
colour Yellow title available from rel. 2.0.84

This box allows you to build a voice bot using the Sestek NDA* Integration.

Panel
bgColor #EAE6FF
An Internet connection is required for this box to work

Info
Remember: This software is managed by others. Check if it works properly.

◾ RestAPI

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

Panel
bgColor #EAE6FF
An Internet connection is required for this box to work

Info

About REST API A RESTful API (REST is an acronym for Representational State Transfer) is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data: the client requests the server for the required information, via an API, and then, the server sends a response to the client. The data returned by the server, in response to the client's request, is either in the format of JSON or XML. Both JSON and XML formats have a proper hierarchical structure of data. REST is an architectural style and an approach for communication purposes often used in various web services development (the architectural style of REST helps in leveraging the lesser use of bandwidth to make an application more suitable for the internet).

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 once 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

Related topics