API Usage and Conventions

The Cisco Unified Customer Voice Portal Developer Guide uses REST-based API functions that are accessed over HTTP. Five API functions are supported; each is mapped to an HTTP operation.
Note

The API commands used in this guide are strictly for UCCE deployment model. For Packaged CCE deployment model, see https://developer.cisco.com/site/packaged-contact-center/documentation/

API Functions and Description

API Function

Description

create (http POST)

Creates an object in the database and returns a response that contains the URL reference to the newly created object.

delete (http DELETE)

Deletes the object.

get (http GET)

Returns data for an object. For objects with multiple records, GET takes an <id>.

update (http PUT)

Modifies an object.

list (http GET)

Returns a list of objects with multiple records.

The POST and PUT operations take a payload with an XML-based input. GET and DELETE calls do not take a payload. All output is provided as XML when there is a response other than HTTP headers.

XML is case sensitive. When XML data is sent to the server, the tag names must match. <Name> and <name> are two different XML elements. If a payload contains duplicate fields, only one is transmitted. The duplicate fields are ignored.