Skip to content

Overview

Introduction

The REST API is a simple API designed to make it very easy for web developers to write telephony applications for Aculab Cloud using Python, C#, VB, Java, PHP or any other scripting language.

api-overview-img

A REST API application is a series of web pages that control how Aculab Cloud handles outbound and inbound calls. You host your application pages in a 3rd-party web server (e.g. IIS, Apache, Tomcat ...) or your own web server.

You can download one of our high-level language wrappers or use any language to interpret and respond to the json requests.

You configure Outbound and Inbound Services in Aculab Cloud to call the First Page of your application when a call is received or a call is made. Aculab Cloud sends an HTTP Request containing JSON information. Your pages send back an HTTP Response containing JSON representing a series of high-level telephony Actions for Aculab Cloud to perform, such as playing a file, asking the caller a question, or getting caller input.

Advanced features such as Call Recording or Far-end Classification are implemented by Aculab Cloud and you just switch them on when configuring your Outbound and Inbound Services.

If you are new to Aculab Cloud we recommend checking out the Quickstart Guides.

Guides

Reference

Download Packages

  • REST API Wrapper - contains several REST API sample applications to get you started.
  • Web Services Wrapper - contains a StartRESTOutbound sample that you can use to start your outbound REST API applications.

Actions

Any of the following actions can be added to the action array that you return in HTTP response. Also see sample applications.

Interact
Control Calls
Utilities

Support Classes

Support classes are used by various actions:

Examples

Code Bites

See the Code Bites page for a collection of small sections of code that illustrate the style and simplicity of the API.

Sample Applications

Included in the REST API wrapper packages are a number of inbound and outbound sample applications that illustrate the main features of the API:

Inbound Only:
Inbound or Outbound:
Outbound Only: