Retrieve all Routing Applications

This function retrieves all routing applications from a client account.

URL


GET {baseURL}/routingApplications


Parameters

None

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the following fields:

FieldTypeData
filterStringThe applied filter. This is reserved for future use.
limitStartIntegerThe first record index. Currently 0, reserved for future use.
limitPageSizeIntegerThe number of records. -1 indicates all records. Reserved for future use.
recordsRoutingApplication []An array of RoutingApplication records.
countIntegerThe number of records returned.
orderByStringThe field used to sort the records. 
ascendingBooleanWhether the array of records is sorted ascending or descending.
statusIntegerThe return code (also provided by the http status code).

Example


{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "TestCLI": null,
            "RoutingApplicationTypesID": null,
            "RoutingApplicationFilesActiveID": 2705,
            "RoutingApplicationFilesTestID": 2705,
            "dtCallLogStart": null,
            "ClientsID": 1,
            "ID": 2793,
            "WorkFlowApplicationTypesID": 1,
            "bOverflowLicense": false,
            "Name": "Test Routing Application"
        },
...
        {
            "TestCLI": "49111",
            "RoutingApplicationTypesID": null,
            "RoutingApplicationFilesActiveID": 2688,
            "RoutingApplicationFilesTestID": 2688,
            "dtCallLogStart": null,
            "ClientsID": 1,
            "ID": 2786,
            "WorkFlowApplicationTypesID": 1,
            "bOverflowLicense": false,
            "Name": "IVR Menu"
        }
    ],
    "count": 85,
    "orderBy": "Name",
    "ascending": true,
    "status": 200
}


Run a Routing Application as a Daemon Process

This function runs a routing application as a daemon (background) process in a client account waiting (for a maximum of 10 seconds) for the result of running the application.

URL


POST {baseURL}/routingApplications/run/{routingApplicationsID}


Parameters

Parameter

Where

Type

Data

routingApplicationsIDURLIntegerThe ID of the routing application to run.

Data

Data can be passed as content type application/json to the routing application. This will be parsed into variables which will be available in the routing application using the usual $ notation.

The variables will be named with the dotted notation, each additional level in the json structure will result in an additional dot in the variable name.

Example:

{
   "myVar1" : "123",
   "myStruct1": 
   {
      "field1" : "value1",
      "field2" : 2
   }
}

Will result in the following variables being declared:

$myVar1 = "123"
$myStruct1.field1 = "value1"
$myStruct1.field2 = "2"


Note, all variables in the jtel routing engine are treated as strings, though in most cases they can be used as numeric values.

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

The routing result object in the IVR is used to return data from the application.

The format and content of the data returned is up to the application programmer, and can be specified freely in the object parameters: