Introduction

Cisco Unified Contact Center Express Configuration APIs offer REST APIs for configuration of Unified Contact Center Express.

Each object supports five methods (except where documented otherwise) that can be invoked on the URL that is associated with the object.

The structure of the URL is <protocol>://<uccx-server>/adminapi/<object>/<instanceId>.

URL Structure Description

<protocol>

HTTP and HTTPS are the supported protocols.

<uccx-server>

Routable address (name or IP address) of the Unified CCX Server.

<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 HTTPS Method URL Description Input Output

LIST

GET

<protocol>://<uccx-server>/
adminapi/<object>

List all the instance of this object

None

List of objects

GET

GET

<protocol>://<uccx-server>/
adminapi/<object>/<instanceId>

Get details of the instances specified by instanceId.

None

Single object instance

CREATE

POST

<protocol>://<uccx-server>/
adminapi/<object>

Create a new instance of the object.

New instance data

URL of the new object

MODIFY

PUT

<protocol>://<uccx-server>/
adminapi/<object>

Modify the instance specified by instanceId.

Modified instance data

None

DELETE

DELETE

<protocol>://<uccx-server>/
adminapi/<object>/<instanceId>

Delete the instance specified by instanceId.

None

None

All methods support Application/XML and Application/JSON as input MIME types.

Note
You can modify the attributes that you edit in AppAdmin through Rest APIs.

Security

Users with only administration credentials on Unified CCX can invoke the methods. However, if application management capability is assigned to supervisors, the specific APIs and methods can be invoked by supervisors also. The API uses Basic Authentication mechanism of HTTPS and the credentials (user ID and password) must be sent with every request in the Authorization header.

User IDs are case-sensitive when logging into the Unified CCX Administration through REST APIs. To make them case-insensitive, you must install 12.5(1) SU1 ES02

Note

The specific API sections mention methods that can be invoked by supervisors.

If an API operation fails, a detailed error is returned in the HTTPS response message body. The error, in XML format, is as follows: 


 <ApiErrors>
		<ApiError>
				<ErrorType>type</ErrorType>
				<ErrorMessage>message</ErrorMessage>
				<ErrorData>data</ErrorData>
		</ApiError>
 </ApiErrors>

Unsupported Unicode Noncharacters

REST API does not allow unicode noncharacters in the request because security polices restrict their use.

When you enter unicode noncharacters in the request, an error is returned in the HTTPS response message body. The error, in XML format, is as follows: 


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <ApiErrors>
    <ApiError>
      <ErrorType>InvalidInput</ErrorType>
      <ErrorMessage>The attempted action violates security policies because of invalid input.</ErrorMessage>
      <ErrorData></ErrorData>
    </ApiError>
  </ApiErrors>

Failure Response Codes

The failure response codes for Unified CCX REST APIs are listed here:

  • 207 Multi Status

  • 400 Bad Request

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 405 Method Not Allowed

  • 409 Conflict

  • 412 Precondition Failed

  • 424 Failed Dependency

  • 500 Internal Server Error

  • 503 Service Unavailable