Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table Of Contents

Introduction

Supported Operations

Failure Response Codes

CORS

Business Calendars

Get Service Status (of business calendars)

Request Params

Response Params

Sample Success Responses

Easy Announcements

Get GENERAL Announcements

Request Params

Response Params

Sample Success Response

Get Service Status Announcements

Request Params

Response Params

Sample Success Response

Callers

Get caller

Request Params

Response Params

Sample Success Response

Introduction

...

Introduction

ST offers RESTful APIs for integration with UCCX IVR. Each object supports five methods (except where documented otherwise) that can be invoked on the URL which is associated with the object. 

The structure of the URL is

http://<adminpanel<st-server>:<port>/eabc/<object>/<instanceId>

URL Structure

Description                  

<adminpanel-server>

Routable address (IP address) of the CCAdmin Server.

<port>

Tomcat port

<object>

One of the supported objects.  

<instanceId>

Optional component needed for GET, DELETE,PUT methods referring to a specific instance of the object. 

Supported Operations

Operation

HTTP

Method

Description                  

Input

Output

LIST

GET

List all the instances of an object

None

List of objects

GET

GET

Get details of an instance specified by instanceId

ID/Name

Single Object instance

SAVE

POST

Create a new instance object 

New instance data

None

UPDATE

PUT

Modify the instance specified by the instanceId

Modified instance data


DELETE

DELETE

Delete the instance specified by the instanceId

ID

None


All methods support Application/JSON as input MIME types.

...