Cisco Unified Contact Center Express Developer Guide

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)First Published: 2018-08-08

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000

800 553-NETS (6387)Fax: 408 527-0883

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version ofthe UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHERWARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERSHAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, networktopology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentionaland coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.comgo trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and anyother company. (1721R)

© 2018 Cisco Systems, Inc. All rights reserved.

www.cisco.com/go/trademarks

www.cisco.com/go/trademarks

C O N T E N T S

Preface xiiiP R E F A C E

Change History xiii

About This Guide xiii

Conventions xiii

Related Documents xv

Documentation and Support xv

Documentation Feedback xvi

Cisco Unified Contact Center Express Configuration APIs 1C H A P T E R 1

Introduction 1

System Configuration APIs 5C H A P T E R 2

Agent Statistics 6

Data Structure for Agent Statistics 6

Get Agent Statistics 6

Application 6

Data Structure for Application 7

Data Structure for ICMPostRouting 7

Data Structure for ICMTranslationRouting 8

Data Structure for ScriptApplication 8

Get List of Applications 9

Get Application 10

Create Application 10

Modify Application 11

Delete Application 11

Area Code 12

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)iii

Data Structure for Area Code 12

Get List of Area Codes 13

Get Area Code 13

Create Area Code 14

Modify Area Code 14

Delete Area Code 15

Call Control Group 15

Data Structure for Call Control Group 16

Data Structure for Port Group Configuration Type 17

Simple Data Structure Used in Call Control Group 22

Data Structure for Call Control Group Job Status 24

Get List of Call Control Groups 24

Get Call Control Group 25

Create Call Control Group 28

Modify Call Control Group 31

Delete Call Control Group 34

Check Status of POST/PUT/DELETE 34

Campaign 36

Data Structure for Campaign 36

Common Data Structure for IVR-Based and Agent-Based Campaigns 37

Common Data Structure for Outbound IVR - Progressive and Predictive Campaigns 39

Data Structure for Outbound IVR - Predictive Campaign 39

Data Structure for Preview Campaign 40

Common Data Structure for Outbound Agent - Progressive and Predictive Campaigns 40

Data Structure for Outbound Agent - Predictive Campaign 41

Get List of Campaigns 42

Get Campaign 43

Create Campaign 45

Modify Campaign 50

Delete Campaign 55

Modify Campaign State 56

Campaign Contacts 56

Data Structure for Campaign Contacts 56

Get List of Pending Contacts for Campaign 57

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)iv

Contents

Get List of Pending Contacts for Campaign with Specific Call Status 58

Add Contacts to Campaign 59

Delete All Contacts from Campaign 60

Channel Parameters 60

Data Structure for Channel Parameters 61

Get Channel Parameters Information 62

Put Channel Parameters Information 62

Channel Provider 63

Data Structure for Channel Provider 63

Get List of Channel Providers 65

Get List of Channel Providers by Type 66

Get a Channel Provider 66

Create a Channel Provider 67

Modify a Channel Provider 68

Delete a Channel Provider 68

Chat Widget 69

Data Structure for Chat Widget 69

Problem Statement CSQ Data Structure 72

Bubble Style Data Structure 73

Bubble Message Data Structure 74

Schedule Configuration Details Data Structure 77

Create Chat Widget 79

Get List of Chat Widgets 82

Get Chat Widget (XML) 82

Get Chat Widget (HTML) 84

Modify Chat Widget 87

Delete Chat Widget 89

Contact Service Queue 89

CSQ Data Structure 89

Email CSQ Data Structure 92

Skill or Resource Group Data Structure 93

Skill Competency Data Structure 93

Skill Details Data Structure 94

Resource Group Lists Data Structure 94

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)v

Contents

Resource Order Data Structure 95

Get List of CSQs 95

Get CSQ 101

Create CSQ 103

Modify CSQ 104

Delete CSQ 106

Context Service 107

Data Structure for ContextService Configuration 107

Get ContextService Configuration 107

Update Context Service Configuration 108

Data Source 108

Data Structure for Data Source 108

Get List of Data Sources 110

Get Data Source 110

Create Data Source 111

Modify Data Source 111

Delete Data Source 112

Test Connection for Data Source 112

DB Purge Schedule Configuration 113

Data Structure for DB Purge Schedule Configuration 113

Get Purge Configuration Information 114

Update Purge Configuration Information 114

DB Purge Now Configuration 115

Data Structure for DB Purge Now Configuration 115

Update Purge Now Configuration 115

DB Purge Configuration Status 116

Data Structure for DB Purge Configuration Status 116

Get Purge Configuration Status 116

Dialog Group 117

Data Structure for Dialog Group 117

Get List of Dialog Groups 118

Get Dialog Group 119

Create Dialog Group 119

Modify Dialog Group 119

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)vi

Contents

Delete Dialog Group 120

Email SMTP Server Configuration 120

Datastructure for Email SMTP Server Configuration 121

Get Email SMTP Server Configuration 121

Create Email SMTP Server Configuration 121

Modify Email SMTP Server Configuration 122

Delete Email SMTP Server Configuration 122

Files (Script, Prompt, Grammar, and Document) 123

Data Structure for Files 123

Create a New Language for Prompt 124

Create a New Language for Document 125

Create a New Language for Grammar 125

Create a New Folder 126

Create a New Folder for Script 126

Create a New Folder for Prompt 127

Create a New Folder for Document 127

Create a New Folder for Grammar 128

Upload Files to a Temporary Folder 128

Upload Files to a Temporary Folder for Script 129

Upload Files to a Temporary Folder for Prompt 129

Upload Files to a Temporary Folder for Document 130

Upload Files to a Temporary Folder for Grammar 130

Store Files in Database from a Temporary folder 130

Store Files in Database from a Temporary Folder for Script 130

Store Files in Database from a Temporary Folder for Prompt 131

Store Files in Database from a Temporary Folder for Document 132

Store Files in Database from a Temporary Folder for Grammar 132

Get List for Script Files and Folder 133

Get List for Prompt Files and Folder 134

Get List for Grammar Files and Folder 134

Get List for Document Files and Folder 135

Get Script Files and Folder 135

Get Prompt Files and Folder 136

Get Grammar Files and Folder 137

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)vii

Contents

Get Document Files and Folder 137

Get FreeSpace and UsedSpace for Script/Prompt/Grammar/Document 138

Download Script/Prompt 139

Modify Script Folder Name 139

Modify File 139

Modify Prompt Folder Name or Language Name 140

Modify Grammar Folder Name or Language Name 141

Modify Document Folder Name or Language Name 142

Delete Script Files and Folder 143

Delete Prompt Files and Folder 143

Delete Grammar Files and Folder 144

Delete Document Files and Folder 144

HTTPS Trigger 145

Data Structure for HTTPS Trigger 145

Get List of HTTPS Triggers 146

Get HTTPS Trigger 147

Create HTTPS Trigger 148

Modify HTTPS Trigger 148

Delete HTTPS Trigger 149

Outbound General Configuration 149

Data Structure for Outbound General Configuration 149

Get List of Skills for Outbound General Configuration 151

Modify Outbound General Configuration 152

System Configuration 153

Data Structure for System Configuration 153

Get System Configuration 153

Update System Configuration 153

Proxy Configuration 154

Data Structure for Proxy Configuration 154

Get Proxy Configuration 154

Update Proxy Configuration 155

Recording Configuration 156

Data Structure for Recording Configuration 156

Get Recording Configuration Information 156

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)viii

Contents

Modify Recording Configuration Information 157

Resource 158

Data Structure for Resource 158

Get List of Resources 160

Get List of Resources by CSQ 161

Get Resource with CSQs 162

Get Modified Information of Resources by CSQ 163

Get Resource 164

Modify Resource 165

Resource Group 166

Data Structure for Resource Group 166

Get List of Resource Groups 166

Get Resource Group 167

Create Resource Group 167

Modify Resource Group 168

Delete Resource Group 168

Skill 169

Data Structure for Skill 169

Get List of Skills 169

Get Skill 170

Create Skill 170

Modify Skill 171

Delete Skill 172

Sip Gateway Configuration 172

Data Structure for Sip Gateway Configurations 173

Get List of Sip Gateway Configurations 174

Update SIP Gateway Configurations 175

Standalone Cisco Unified Intelligence Center 175

Data Structure for Standalone CUIC 176

Configuration of Standalone CUIC 176

Sample Input XML - Modify CUIC Configuration (PUT) 176

Team 177

Data Structure for Team 177

Get List of Teams 177

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)ix

Contents

Get Team 178

Create Team 178

Modify Team 179

Delete Team 180

Trigger 180

Trigger Data Structure 180

Simple Data Structure and Elements Used in Trigger 183

Complex Data Structure Defined for forwardBusy 184

Get list of triggers 185

Get a Trigger by Directory Number 185

Create a New Trigger 185

Modify a Trigger by ID 186

Delete a Trigger by ID 187

TTS Provider 187

Data Structure for TTS Provider 187

Get list of TTS Providers 188

Get a TTS Provider 188

Create TTS Provider 189

Modify TTS Provider 189

Delete TTS Provider 190

TTS Server 190

Data Structure for TTS Server 190

Get list of TTS Servers 191

Get a TTS Server 192

Create TTS Server 193

Modify TTS Server 193

Delete TTS Server 194

WrapupCategory 194

Data Structure for WrapupCategory 194

Get list of WrapupCategory 195

Get WrapupCategory 197

Create WrapupCategory 197

Modify WrapupCategory 198

Delete WrapupCategory 199

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)x

Contents

Cisco Finesse Desktop and Configuration APIs 201A P P E N D I X A

Cisco SocialMiner APIs 203A P P E N D I X B

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)xi

Contents

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)xii

Contents

Preface

• Change History, on page xiii• About This Guide, on page xiii• Conventions, on page xiii• Related Documents, on page xv• Documentation and Support, on page xv• Documentation Feedback, on page xvi

Change HistoryThis table lists changes made to this guide. Most recent changes appear at the top.

DateSeeChange

August 2018Initial Release of Document for Release 11.6(2)

About This GuideThis document introduces RESTApplication Program Interface (API) use and conventions for Unified ContactCenter Express (Unified CCX) and provides details about each REST API.

ConventionsThis manual uses the following conventions.

DescriptionConvention

Boldface font is used to indicate commands, such asuser entries, keys, buttons, and folder and submenunames. For example:

• Choose Edit > Find

• Click Finish.

boldface font

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)xiii


Italic font is used to indicate the following:

• To introduce a new term. Example: A skill groupis a collection of agents who share similar skills.

• For emphasis. Example: Do not use thenumerical naming convention.

• An argument for which you must supply values.

Example:

IF (condition, true-value, false-value)

• A book title. Example:

See the Cisco Unified Contact Center ExpressInstallation Guide.

italic font

Window font, such as Courier, is used for thefollowing:

• Text as it appears in code or information that thesystem displays. Example:

<html><title> Cisco Systems,Inc.

</title></html>

• File names. Example:tserver.properties.

• Directory paths. Example:

C:\Program Files\Adobe

window font

Nonquoted sets of characters (strings) appear inregular font. Do not use quotation marks around astring or the string will include the quotation marks.

string

Optional elements appear in square brackets.[ ]

Alternative keywords are grouped in braces andseparated by vertical bars.

{ x | y | z }

Optional alternative keywords are grouped in bracketsand separated by vertical bars.

[ x | y | z ]

Angle brackets are used to indicate the following:

• For arguments where the context does not allowitalic, such as ASCII output.

• A character string that the user enters but thatdoes not appear on the window such as apassword.

< >

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)xiv

PrefacePreface


The key labeled Control is represented in screendisplays by the symbol ^. For example, the screeninstruction to hold down the Control key while youpress the D key appears as ^D.

^

Related DocumentsLinkDocument or Resource

https://www.cisco.com/en/US/products/sw/custcosw/ps1846/products_documentation_roadmaps_list.html

Cisco Unified Contact Center ExpressDocumentation Guide

https://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.html

cisco.com site for Cisco Unified CCXdocumentation

https://www.cisco.com/en/US/products/ps9755/tsd_products_support_series_home.html

cisco.com site for Cisco UnifiedIntelligence Center documentation


cisco.com site for Cisco Finessedocumentation

https://www.cisco.com/c/en/us/support/customer-collaboration/socialminer/tsd-products-support-series-home.html

cisco.com site for Cisco SocialMinerdocumentation

https://www.cisco.com/c/en/us/support/customer-collaboration/mediasense/tsd-products-support-series-home.html

cisco.com site for Cisco Mediasensedocumentation

https://www.cisco.com/c/dam/en/us/td/docs/voice_ip_comm/uc_system/virtualization/virtualization-cisco-unified-contact-center-express.html

cisco.com site for Cisco Unified CCXVirtualization Information

https://www.cisco.com/c/en/us/support/customer-collaboration/unified-contact-center-express/products-device-support-tables-list.html

cisco.com site for Cisco Unified CCXCompatibility Information

Documentation and SupportTo download documentation, submit a service request, and find additional information, seeWhat's New inCisco Product Documentation at https://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html.

You can also subscribe to theWhat's New in Cisco Product Documentation RSS feed to deliver updatesdirectly to an RSS reader on your desktop. The RSS feeds are a free service. Cisco currently supports RSSVersion 2.0.

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)xv

PrefaceRelated Documents



















https://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Documentation FeedbackTo provide your feedback for this document, send an email to:

[email protected]

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)xvi

PrefaceDocumentation Feedback

mailto:[email protected]

C H A P T E R 1Cisco Unified Contact Center ExpressConfiguration APIs

• Introduction, on page 1

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

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

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

DescriptionURL Structure

HTTP and HTTPS are the supported protocols.<protocol>

Routable address (name or IP address) of the UnifiedCCX Server.

<uccx-server>

One of the supported objects.<object>

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

<instanceId>

Supported Operations

OutputInputDescriptionURLHTTPSMethod

Operation

List of objectsNoneList all theinstance of thisobject

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

GETLIST

Cisco Unified Contact Center Express Developer Guide, Release 11.6(2)1

OutputInputDescriptionURLHTTPSMethod

Operation

Single objectinstance

NoneGet details of theinstancesspecified byinstanceId.

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

GETGET

URL of the newobject

Newinstancedata

Create a newinstance of theobject.


POSTCREATE

NoneModifiedinstancedata

Modify theinstancespecified byinstanceId.


PUTMODIFY

NoneNoneDelete theinstancespecified byinstanceId.

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

DELETEDELETE

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

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

Security

If an API operation fails, a detailed error is returned in the HTTPS response message body. The error, in XMLformat, 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 messagebody. 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>


Cisco Unified Contact Center Express Configuration APIsIntroduction

</ApiError></ApiErrors>

Failure Response Codes

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

• 400 Bad Request

• 401 Unauthorized

• 403 Forbidden

• 404 Not Found

• 405 Method Not Allowed

• 409 Conflict

• 500 Internal Server Error

• 503 Service Unavailable

CORS

Cross-origin resource sharing (CORS) is supported that allows you to place requests to configuration APIsfrom any origin.





C H A P T E R 2System Configuration APIs

• Agent Statistics, on page 6• Application, on page 6• Area Code, on page 12• Call Control Group, on page 15• Campaign, on page 36• Campaign Contacts, on page 56• Channel Parameters, on page 60• Channel Provider, on page 63• Chat Widget, on page 69• Contact Service Queue, on page 89• Context Service, on page 107• Data Source, on page 108• DB Purge Schedule Configuration, on page 113• DB Purge Now Configuration, on page 115• DB Purge Configuration Status, on page 116• Dialog Group, on page 117• Email SMTP Server Configuration, on page 120• Files (Script, Prompt, Grammar, and Document), on page 123• HTTPS Trigger, on page 145• Outbound General Configuration, on page 149• System Configuration, on page 153• Proxy Configuration, on page 154• Recording Configuration, on page 156• Resource, on page 158• Resource Group, on page 166• Skill, on page 169• Sip Gateway Configuration, on page 172• Standalone Cisco Unified Intelligence Center , on page 175• Team, on page 177• Trigger, on page 180• TTS Provider, on page 187• TTS Server, on page 190• WrapupCategory, on page 194


Agent StatisticsAgentstats provides reports about the resources.

Data Structure for Agent StatisticsDescriptionRestrictionsBase TypeAttribute Name

Number of resources currently logged in.—unsignedIntloggedIn

Number of resources currently ready.—unsignedIntready

Number of resources currently not ready.—unsignedIntnotReady

Number of resources currently talking.—unsignedInttalking

Get Agent StatisticsGETHTTPS Method

https://<server>/adminapi/agentstatsURI

https://uccx-server/adminapi/agentstatsExample URI

Application/XML, Application/JSONAccept

200HTTPS Success Code

401, 405HTTPS Failure Codes

—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><agentStats ><loggedIn>0</loggedIn><ready>0</ready><notReady>0</notReady><talking>0</talking>

</agentStats>

ApplicationApplication provides information about the application.


System Configuration APIsAgent Statistics

Data Structure for ApplicationDescriptionRestrictionsBase TypeAttribute Name

Type of scriptNoneICMPostRouting(choice)

ICMPostRouting

Type of scriptNoneICMTranslationRouting(choice)

ICMTranslationRouting

Type of scriptNoneScriptApplication(choice)

ScriptApplication

Numeric identifier of theapplication

0 to 65535(mandatory,unique)

intid

Name that uniquely identifiesthe application

max length = 30(mandatory,unique)

min length = 1

Application namecontains alphanumericcharacters, specialcharacters, spaces,underscores (_), andhyphens (-) withoutleading or trailing whitespaces.

applicationNameapplicationName

Maximum number of sessions1 to 2147483647(mandatory )

intmaxsession

true | false (mandatory)stringenabled

Data Structure for ICMPostRoutingDescriptionRestrictionsBase TypeAttribute

Initial script of the Unified CCX postroutingapplication.

Example for system script:<initialScript>aa.aef</initialScript>

Examples for user script:<initialScript>SCRIPT[user.aef]</initialScript>

<initialScript>SCRIPT[user/user.aef]</initialScript>

NoneStringinitialScript

Time in milliseconds that the system waitsbefore it rejects the request for the application.

1 to 2147483647Inttimeout


System Configuration APIsData Structure for Application

DescriptionRestrictionsBase TypeAttribute

Default script of the Unified CCX postroutingapplication.

Example for system script:<defaultScript>aa.aef</defaultScript>

Examples for user script:<defaultScript>SCRIPT[user.aef]</defaultScript>

<defaultScript>SCRIPT[user/user.aef]</defaultScript>

NoneStringdefaultScript

Data Structure for ICMTranslationRoutingDescriptionRestrictionsBase TypeAttribute

Time in milliseconds that the system waitsbefore it rejects the request for the application.

1 to 2147483647Inttimeout






Data Structure for ScriptApplicationDescriptionRestrictionsBase TypeAttribute

For system script, specify the script.

Example for system script:<sscript>aa.aef</sscript> or aa.aef

For user script, specify the script with the relativepath.

Examples for user script:<script>SCRIPT[user.aef]</script>

<script>SCRIPT[user/user.aef]</script>

Mandatory

Regex = ([A-Za-z0-

9\-_,\s]+(\.aef))|(((S

SCRIPT\[)|(SCRIPT

\[))[A-Za-z0-9\-_,\s/]

+(\.aef)+(\]))

Stringscript


System Configuration APIsData Structure for ICMTranslationRouting







Parameters of the script.

An optional flag isDefaultValue in the APIresponse indicates whether the value displayedagainst a parameter is a default value defined inthe script.

NoneVariablescriptParams

NoneVariabledefaultScriptParams

Get List of ApplicationsGETHTTPS Method

https://<server>/adminapi/applicationURI

https://uccx-server/adminapi/applicationExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><applications><application><self>https://uccx-server/adminapi/application/Auto_Sanity_App_ICD</self><id>0</id><applicationName>Auto_Sanity_App_ICD</applicationName><type>Cisco Script Application</type><description>Automated test application</description><maxsession>10</maxsession><enabled>true</enabled></application><application><self>https://uccx-server/adminapi/application/Auto_Sanity_App_AA</self><id>1</id><applicationName>Auto_Sanity_App_AA</applicationName>


System Configuration APIsGet List of Applications

<type>Cisco Script Application</type><description>Automated test application for AA</description><maxsession>10</maxsession><enabled>true</enabled></application><application><self>https://uccx-server/adminapi/application/Auto_Application</self><id>2</id><applicationName>Auto_Application</applicationName><type>Cisco Script Application</type><description>Automated test application</description><maxsession>10</maxsession><enabled>true</enabled></application></applications>

Get ApplicationGETHTTPS Method

https://<server>/adminapi/application/{applicationName}URI

https://uccx-server/adminapi/application/application1Example URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><application><self>https://uccx-server/adminapi/application/Auto_Sanity_App_AA</self><ScriptApplication><script>aa.aef</script></ScriptApplication><id>1</id><applicationName>Auto_Sanity_App_AA</applicationName><type>Cisco Script Application</type><description>Automated test application for AA</description><maxsession>10</maxsession><enabled>true</enabled></application>

Create ApplicationPOSTHTTPS Method

https://<server>/adminapi/applicationURI

https://uccx-server/adminapi/applicationExample URI

Application/XML, Application/JSONContent Type


System Configuration APIsGet Application


401, 405, 412HTTPS Failure Code

—Error Codes

Success Response

HTTPS/1.1 201 Created

Modify ApplicationPUTHTTPS Method





401, 405, 412HTTPS Failure Codes

—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Request

<application><ScriptApplication><script>SCRIPT[ICDSystemTestScriptCS7.aef]</script><scriptParams><name>QueuePrompt</name><value>SP[ICD\ICDQueue.wav]</value><type>com.cisco.prompt.Playable</type></scriptParams><scriptParams></scriptParams></ScriptApplication><id>19</id><applicationName>ICDSystemApp7</applicationName><type>Cisco Script Application</type><description>ICDSystemApp7_modified</description><maxsession>100</maxsession><enabled>true</enabled></application>

Delete ApplicationDELETEHTTPS Method


System Configuration APIsModify Application





401, 404, 405, 412HTTPS Failure Codes

—Error Codes

Success Response

HTTPS/1.1 200 OK

Area CodeThe area code determines the geographical location of the phone number you dial, which provides theGreenwich Meridian Time (GMT) zone. The db_cra database contains a mapping of the area codes to thetime zones. The U.S. area code mappings are provided along with the product. International customers shouldprovide their own data and add it to the database.

Data Structure for Area CodeDescriptionRestrictionsBase TypeAttribute Name

The area code of the callminlength = 1

maxlength = 10

occurrences = 1

The valid characters forthis field are “\d+”.

stringareaCode

Uses the same data as that ofgmtzone

minOccurs = 1

maxOccurs = 1

intregion

Daylight Savings Timeminoccurs = 0

maxOccurs = 1

Default = False

Any value other than“True ” is considered asFalse.

booleandst


System Configuration APIsArea Code

Get List of Area CodesGETHTTPS Method

https://<server>/adminapi/areaCodeURI

https://uccx-server/adminapi/areaCodeExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><areaCodes><areaCode><self>https://uccx-server/adminapi/areaCode/219</self><areacode>219</areacode><regioncode>158</regioncode><dst>false</dst></areaCode><areaCode><self>https://uccx-server/adminapi/areaCode/615</self><areacode>615</areacode><regioncode>92</regioncode><dst>true</dst></areaCode><areaCode><self>https://uccx-server/adminapi/areaCode/607</self><areacode>607</areacode><regioncode>158</regioncode><dst>true</dst></areaCode></areaCodes>

Get Area CodeGETHTTPS Method

https://<server>/adminapi/areaCode/{areacode}URI

https://uccx-server/adminapi/areaCode/760Example URI




—Error Codes


System Configuration APIsGet List of Area Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><areaCode><self>https://uccx-server/adminapi/areaCode/219</self><areaCode>219</areaCode><regioncode>158</regioncode><dst>false</dst></areaCode>

Create Area CodePOSTHTTPS Method

https://<server>/adminapi/areacodeURI

https://uccx-server/adminapi/areacodeExample URI


201HTTPS Success code


ConfigNotFoundException

SQLException

Error Codes

Success Response


Sample Input XML—POST

<?xml version="1.0" encoding="UTF-8"?><AreaCode><self>https://uccx-server/adminapi/areacode</self><areacode>9111</areacode><regioncode>140</regioncode><dst>true</dst>

</AreaCode>

Modify Area CodePUTHTTPS Method

https://<server>/adminapi/areacode/{areacode}URI

https://uccx-server/adminapi/areacode/760Example URI





System Configuration APIsCreate Area Code

—Error Codes

Success Response

—

Sample Input XML—PUT

<?xml version="1.0" encoding="UTF-8"?><AreaCode><self>https://uccx-server/adminapi/areaCode/</self><areacode>9111</areacode><regioncode>140</regioncode><dst>false</dst>

</AreaCode>

Delete Area CodeDELETEHTTPS Method

https://<server>/adminapi/areacode/{areacode}URI

https://uccx-server/adminapi/areacode/760Example URI




HTTPS/1.1 404 Not FoundError Codes

Success Response

HTTPS/1.1 200 OK

Call Control GroupCall Control Group allows you to control the use of CTI ports. Unified CCX uses Unified CM Telephony callcontrol groups to pool together a series of CTI ports, which the system uses to serve calls as they arrive fromthe Unified CCX server. You can create multiple Unified CM Telephony call control groups to share andlimit the resources to be used by specific applications. You can reserve more ports for higher-priorityapplications or provide access to fewer ports for applications with less traffic.


System Configuration APIsDelete Area Code

Data Structure for Call Control GroupDescriptionRestrictionsBase TypeAttribute Name

Unique identifier for the CallControl Group.

minOccurs = 0

maxOccurs = 1

nillable = false

intid

Description of the Call ControlGroup.

minOccurs = 1

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 30

Description containsalphanumeric characters andcan have white space betweencharacters.

stringdescription

Number of CTI ports that areassigned to the Call ControlGroup.

minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1

maxLength = 65535

intnumOfCTIPorts

Checks for the inbound oroutbound group that is associatedwith the Call Control Group.

minOccurs = 1

maxOccurs = 1

nillable = false

default = false

booleanoutboundGroup

Enables auto creation of mediatermination groups.

minOccurs = 1

maxOccurs = 1

nillable = false

default = false

booleanmediaTerminationSupport


System Configuration APIsData Structure for Call Control Group

DescriptionRestrictionsBase TypeAttribute Name

Prefixed to the name that will begiven to all of the CTI ports inthe group.

minOccurs = 1

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 5

Device name prefix containsalphanumeric characters,underscores (_), hyphens (-),and periods (.) without leadingor trailing white spaces.

stringdeviceNamePrefix

Data Structure for Port Group Configuration TypeDescriptionRestrictionsBase TypeAttribute Name

IP address or domainname.

minOccurs = 0

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 255

Hostname containsalphanumericcharacters.

stringhostName

List of CTI portsassigned to the CallControl Group.

minOccurs = 0

maxOccurs = 1

nillable = false

stringlistOfCTIPorts


System Configuration APIsData Structure for Port Group Configuration Type


Specified number ofports are createdstarting from thevalue that is specifiedin this field orstarting from the nextavailable directorynumber.

minOccurs = 1

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 24

Starting directorynumber containsnumerals and canhave asterisk (*) orhash (#) or both as aprefix or a suffix.

To support E.164compliance, UnifiedCCX allows you toadd plus sign (+)before the directorynumber.

stringstartingDirectoryNumber

Set of commonparameters likeregion, location,SRST reference, etcthat can be appliedfor a device.

minOccurs = 1

maxOccurs = 1

nillable = false

CCMCommonObjectNamedevicePool

Collection ofpartitions that issearched to determinehow to route a dialednumber.

minOccurs = 0

maxOccurs = 1

nillable = false

CCMCommonObjectNamednCallingSearchSpace

The Cisco UnifiedCommunicationsManager phonelocation settingspecifies the totalbandwidth that isavailable for calls toand from thislocation.

minOccurs = 1

maxOccurs = 1

nillable = false

CCMCommonObjectNamelocation

The partition towhich the DirectoryNumber belongs.

minOccurs = 0

maxOccurs = 1

nillable = false

CCMPartitionNamepartition




Media ResourceGroup List providesa prioritized groupingof media resourcegroups. Applicationchooses the requiredmedia resourceaccording to thepriority order that isdefined in a MediaResource Group List.

minOccurs = 0

maxOccurs = 1

nillable = false

CCMCommonObjectNamemediaResourceGroupList

List of profilesdefined in the VoiceMail ProfileConfiguration. VoiceMail Profile allowsyou to define anyline-relatedvoice-messaginginformation that isassociated to adirectory number.

minOccurs = 0

maxOccurs = 1

nillable = false

CCMCommonObjectNamevoiceMailProfile

Presence groupcontrols thedestinations that canbe monitored by thewatchers in thegroup.

minOccurs = 1

maxOccurs = 1

nillable = false

CCMCommonObjectNamepresenceGroup

Automated AlternateRouting (AAR)group provides theprefix digits that areused to route callsthat are otherwiseblocked due toinsufficientbandwidth.

minOccurs = 0

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 20

AAR group containsalphanumericcharacters, spaces,underscores (_),hyphens (-), andperiods (.) withoutleading or trailingwhite spaces.

stringAARGroup




Audio source heardby the caller whenthe Unified CCXscript places thecaller on hold.

minOccurs = 0

maxOccurs = 1

nillable = false

CCMHoldAudioSourceNameuserHoldAudioSource

Audio source that isheard by the callerwhen Unified CCXperforms a ConsultTransfer.

minOccurs = 0

maxOccurs = 1

nillable = false

CCMHoldAudioSourceNamenetworkHoldAudioSource

Call pickup groupallows you to answera call that comes inon a directorynumber other thanyour own. When youhear an incoming callringing on anotherphone, you canredirect the call toyour phone by usingthis feature.

minOccurs = 0

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 24

Call pickup groupcontains numerals(0-9), alphabets(A-D), plus (+),pound (#) andasterisk (*).

Slash (\)must beprecedeplus (+).

Note

stringcallPickUpGroup

Name that isdisplayed during analert to a shareddirectory number.Devices that do notsupport Unicode(internationalized)characters display theAlerting NameASCII field.

minOccurs = 0

maxOccurs = 1

CCMAlertingNameASCIIalertingNameAscii




Collection ofpartitions that aresearched to determinehow a redirected callis routed.

Redirect CallingSearch Spaceoptions:

• DN CallingSearchSpace—Enablesthe CTI Port touse its directorynumber CSSwhenperforming aredirect / consulttransfer.

• CallingParty—Enablesthe CTI Port touse the callingparty's CSSwhenperforming aredirect / consulttransfer.

• RedirectParty—Enablesthe CTI Port touse the CTIRoute Point'sCSS whenperforming aredirect / consulttransfer.

minOccurs = 1

maxOccurs = 1

nillable = false

CCMRedirectCallingSearchSpaceredirectCallingSearchSpace




Username or thedirectory number thatis configured.

minOccurs = 1

maxOccurs = 1

minLength = 0

maxLength = 30

Display containsalphanumericcharacters andsymbols except tab(\t;), new line (\n;),double quotationmarks (“), brackets (<>, { }, [ ]), percent(%), and ampersand(&).

stringdisplay

Phone number that isused to send caller IDinformation when acall is placed fromthis line.

minOccurs = 0

maxOccurs = 1

CCMExternalPhoneMaskNumberexternalPhoneMaskNumber

Simple Data Structure Used in Call Control GroupDescriptionRestrictionsBase TypeAttribute Name

Data type that is used inUnified CommunicationsManager forAlertingNameASCII.

minLength = 0

maxLength = 30

CCM Alerting NameASCII can include allspecial characters exceptdouble quotation marks("), angle brackets (< >),ampersand (&), andpercent (%).

Do not use the followingkeywords that arereserved in UnifiedCommunicationsManager: Conference,Park Number, Barge,CBarge, Monitor, andRecord.

stringCCMAlertingNameASCII


System Configuration APIsSimple Data Structure Used in Call Control Group


Data type that is used inUnified CommunicationsManager forCommonObjectName.

minLength = 1

maxLength = 50

CCMCommonObjectNamecontains alphanumericcharacters, spaces,underscores (_), hyphens(-), and periods (.)without leading ortrailing white spaces.

stringCCMCommonObjectName

Data type that is used inUnified CommunicationsManager forHoldAudioSourceName.

minLength = 1

maxLength = 50

CCMHoldAudioSourceNamecontains numbers from 1to 51 followed by hyphen(-) and alphanumericcharacters with periods(.), hyphens (-),underscores (_) or spaces.

stringCCMHoldAudioSourceName

Data type that is used inUnified CommunicationsManager for PartionName.

minLength = 1

maxLength = 50

CCMPartionNamecontains alphanumericcharacters, spaces,underscores (_), periods(.), and hyphens (-).

stringCCMPartionName

Data type that is used inUnified CommunicationsManager forRedirectCallingSearchSpace.

enumeration = RedirectParty, Calling Party, DNCalling Search Space.

stringCCMRedirectCallingSearchSpace

Data type that is used inUnified CommunicationsManager forCCMExternalPhoneMaskNumber.

minLength = 0

maxLength = 24

CCM external phonemask number containsnumerals (0-9), hashes(#), asterisks (*), and X.

stringCCMExternalPhoneMaskNumber


System Configuration APIsSimple Data Structure Used in Call Control Group

Data Structure for Call Control Group Job StatusDescriptionRestrictionsBase TypeAttribute Name

Total number of CTI ports.minOccurs = 1

maxOccurs = 1

nillable = false

inttotalPorts

Total number of updated ports.minOccurs = 1

maxOccurs = 1

nillable = false

intupdatePorts

The last-updated port.minOccurs = 1

maxOccurs = 1

nillable = false

stringlastUpdatedPort

Job type—Creation, deletion, modification.minOccurs = 1

maxOccurs = 1

nillable = false

stringtype

Any exception that occurs while performingPOST, PUT, or DELETE.

minOccurs = 1

maxOccurs = 1

nillable = false

stringexception

Job is complete.minOccurs = 1

maxOccurs = 1

nillable = false

booleancompleted

Get List of Call Control GroupsGETHTTPS Method

https://<server>/adminapi/callControlGroupURI

https://uccx-server/adminapi/callControlGroupExample URI



401, 404, 412, 500, 503HTTPS Failure Codes

—Error Codes


System Configuration APIsData Structure for Call Control Group Job Status

Success Response

For LAN<?xml version="1.0" encoding="UTF-8" standalone="yes"?><callControlGroups>

<callControlGroup><self type="callControlGroup" href="https://uccx-server/adminapi/callControlGroup/102"

rel="self"/><id>102</id><outboundGroup>false</outboundGroup><description>description</description>

<deviceNamePrefix>cti</deviceNamePrefix><numOfCTIPorts>10</numOfCTIPorts>

<mediaTerminationSupport>false</mediaTerminationSupport></callControlGroup><callControlGroup>

<self type="callControlGroup" href="https://uccx-server/adminapi/callControlGroup/107"rel="self"/>

<id>107</id><outboundGroup>false</outboundGroup>

<deviceNamePrefix>cti</deviceNamePrefix><description>testccg</description>

<numOfCTIPorts>5</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport>

</callControlGroup></callControlGroups>

For WAN<?xml version="1.0" encoding="UTF-8" standalone="yes"?><callControlGroups>

<callControlGroup><self type="callControlGroup" href="https://uccx-server/adminapi/callControlGroup/4"

rel="self"/><id>4</id><outboundGroup>false</outboundGroup><description>sdf</description>

<deviceNamePrefix>cti</deviceNamePrefix><numOfCTIPorts>2</numOfCTIPorts>

<mediaTerminationSupport>false</mediaTerminationSupport></callControlGroup><callControlGroup>

<self type="callControlGroup" href="https://uccx-server/adminapi/callControlGroup/2"rel="self"/>

<id>2</id><outboundGroup>false</outboundGroup><description>TEST</description>

<deviceNamePrefix>cti</deviceNamePrefix><numOfCTIPorts>1</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport>

</callControlGroup></callControlGroups>

Get Call Control GroupGETHTTPS Method

https://<server>/adminapi/callControlGroup/{id}URI

https://uccx-server/adminapi/callControlGroup/12Example URI


System Configuration APIsGet Call Control Group




—Error Codes

Success Response

For LAN<?xml version="1.0" encoding="UTF-8" standalone="yes"?><callControlGroup>

<self href="https://uccx-server/adminapi/callControlGroup/107" rel="self"type="callControlGroup"/>

<id>107</id><outboundGroup>false</outboundGroup><description>testccg</description>

<deviceNamePrefix>testc</deviceNamePrefix><numOfCTIPorts>5</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration>

<listOfCTIPorts>testc_68900,testc_68907,testc_68908,testc_68909,testc_68910,testc_68911,testc_68912,testc_68913,testc_68914,testc_68915</listOfCTIPorts>

<startingDirectoryNumber>68900</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii></alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display></display><externalPhoneMaskNumber></externalPhoneMaskNumber>

</portGroupConfiguration></callControlGroup>

For WAN—When CTI ports are configured for both nodes<?xml version="1.0" encoding="UTF-8" standalone="yes"?><callControlGroup>


<id>2</id><outboundGroup>false</outboundGroup><description>TEST</description>

<deviceNamePrefix>VISH1</deviceNamePrefix><numOfCTIPorts>1</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration><hostName>ccx-94-80</hostName><listOfCTIPorts>VISH1_1000</listOfCTIPorts><startingDirectoryNumber>1000</startingDirectoryNumber>



<devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii></alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display></display><externalPhoneMaskNumber></externalPhoneMaskNumber>

</portGroupConfiguration><portGroupConfiguration>

<hostName>ccx-94-81</hostName><listOfCTIPorts>VISH1_576</listOfCTIPorts><startingDirectoryNumber>576</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii></alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display></display><externalPhoneMaskNumber></externalPhoneMaskNumber>


For WAN—When CTI ports are configured for only one node<?xml version="1.0" encoding="UTF-8" standalone="yes"?><callControlGroup>


<id>2</id><outboundGroup>false</outboundGroup><description>TEST</description><deviceNamePrefix>VISH1</deviceNamePrefix><numOfCTIPorts>1</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration>

<hostName>ccx-94-80</hostName><listOfCTIPorts>VISH1_1000</listOfCTIPorts><startingDirectoryNumber>1000</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource>



<networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii></alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display></display><externalPhoneMaskNumber></externalPhoneMaskNumber>


Create Call Control GroupPOSTHTTPS Method

https://<server>/adminapi/callControlGroupURI

https://uccx-server/adminapi/callControlGroupExample URI


201, 202, 206HTTPS Success Code

400, 401, 404, 405, 412, 415, 500, 503HTTPS Failure Codes

—Error Codes

Sample Input XML—Create a New Call Control Group in WAN with All Parameters (POST) to Configure CTIPorts on Both Nodes

<?xml version="1.0" encoding="UTF-8"?><callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd"><outboundGroup>false</outboundGroup><description>description</description><deviceNamePrefix>c11</deviceNamePrefix><numOfCTIPorts>10</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration>

<hostName>hostName1</hostName><startingDirectoryNumber>100012</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii>alteringNameAscii</alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display>display</display><externalPhoneMaskNumber>12345</externalPhoneMaskNumber>


<hostName>hostName1</hostName>


System Configuration APIsCreate Call Control Group

<startingDirectoryNumber>100012</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii>alteringNameAscii</alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display>display</display><externalPhoneMaskNumber>12345</externalPhoneMaskNumber>


Sample Input XML — Create a New Call Control Group in WAN with All Parameters (POST) to Configure CTIPorts on One Node



<hostName>hostName1</hostName><startingDirectoryNumber>100012</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii>alteringNameAscii</alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display>display</display><externalPhoneMaskNumber>12345</externalPhoneMaskNumber>


Sample Input XML—Create a New Call Control Group in WAN with Default Parameters (POST) to ConfigureCTI Ports on Both Nodes

<?xml version="1.0" encoding="UTF-8"?><?xml version="1.0" encoding="UTF-8"?><callControlGroup xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd"><outboundGroup>false</outboundGroup><description>description</description><deviceNamePrefix>c1</deviceNamePrefix>



<numOfCTIPorts>10</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration>

<startingDirectoryNumber>999001</startingDirectoryNumber><devicePool>Default</devicePool><location>Hub_None</location><presenceGroup>Standard Presence group</presenceGroup><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><hostName>ccx-94-80</hostName>




Sample Input XML—Create a New Call Control Group in WAN with Default Parameters (POST) to ConfigureCTI Ports on One Node





Sample Input XML—Create a New Call Control Group in LAN with All Parameters (POST)



<hostName>hostName1</hostName><startingDirectoryNumber>100012</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList>



<voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii>alteringNameAscii</alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display>display</display><externalPhoneMaskNumber>12345</externalPhoneMaskNumber>


Sample Input XML—Create a New Call Control Group in LAN with Default Parameters (POST)



<startingDirectoryNumber>999001</startingDirectoryNumber><devicePool>Default</devicePool><location>Hub_None</location><presenceGroup>Standard Presence group</presenceGroup><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception>


Modify Call Control GroupPUTHTTPS Method





400, 401, 404, 405, 412, 500, 503HTTPS Failure Codes

—Error Codes

Sample Input XML—Modify Common Parameters of an Existing Call Control Group in WAN when CTI Portsare Configured for Both Nodes (PUT)


xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd"><id>7</id>

<outboundGroup>false</outboundGroup><description>description</description>


System Configuration APIsModify Call Control Group

<deviceNamePrefix>mod1</deviceNamePrefix><numOfCTIPorts>10</numOfCTIPorts><mediaTerminationSupport>true</mediaTerminationSupport><portGroupConfiguration>

<startingDirectoryNumber>999001</startingDirectoryNumber><devicePool>Default</devicePool><location>Hub_None</location><presenceGroup>Standard Presence group</presenceGroup><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>false</requireDTMFReception><hostName>ccx-94-80</hostName>


<startingDirectoryNumber>999001</startingDirectoryNumber><devicePool>mod_DP</devicePool><location>Hub_None</location><presenceGroup>Standard Presence group</presenceGroup><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><hostName>ccx-94-81</hostName>


Sample Input XML—Modify Node-Specific Parameters of an Existing Call Control Group for One Node inWAN when CTI Ports are Created for Both Nodes (PUT)



<outboundGroup>false</outboundGroup><description>description</description><deviceNamePrefix>mod1</deviceNamePrefix><numOfCTIPorts>10</numOfCTIPorts><mediaTerminationSupport>true</mediaTerminationSupport><portGroupConfiguration>

<startingDirectoryNumber>999001</startingDirectoryNumber><devicePool>Default</devicePool><location>Hub_None</location><presenceGroup>Standard Presence group</presenceGroup><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>false</requireDTMFReception><hostName>ccx-94-80</hostName>


Sample Input XML—Modify an Existing Call Control Group in WAN with All Parameters (PUT)



<outboundGroup>false</outboundGroup><description>description</description><deviceNamePrefix>c11</deviceNamePrefix><numOfCTIPorts>10</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration>

<hostName>hostName1</hostName><startingDirectoryNumber>100012</startingDirectoryNumber><devicePool>mod_De</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location>



<partition>Mod_Part</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii>alteringNameAscii</alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display>display</display><externalPhoneMaskNumber>12345</externalPhoneMaskNumber>


<hostName>hostName1</hostName><startingDirectoryNumber>100012</startingDirectoryNumber><devicePool>Default</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>Mod_Part</partition><mediaResourceGroupList>Mod_MRGL</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii>alteringNameAscii</alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception><display>display</display><externalPhoneMaskNumber>12345</externalPhoneMaskNumber>


Sample Input XML—Modify an Existing Call Control Group in LAN with All Parameters (PUT)


xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/callControlGroup.xsd"><id>23</id><outboundGroup>false</outboundGroup>

<description>description</description><deviceNamePrefix>c11</deviceNamePrefix><numOfCTIPorts>10</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration>

<hostName>hostName1</hostName><startingDirectoryNumber>100012</startingDirectoryNumber><devicePool>ModDevPool</devicePool><dnCallingSearchSpace>None</dnCallingSearchSpace><location>Hub_None</location><partition>None</partition><mediaResourceGroupList>None</mediaResourceGroupList><voiceMailProfile>None</voiceMailProfile><presenceGroup>Standard Presence group</presenceGroup><AARGroup>None</AARGroup><userHoldAudioSource>None</userHoldAudioSource><networkHoldAudioSource>None</networkHoldAudioSource><callPickUpGroup>None</callPickUpGroup><alertingNameAscii>alteringNameAscii</alertingNameAscii><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception>



<display>display</display><externalPhoneMaskNumber>12345</externalPhoneMaskNumber>


Sample Input XML—Modify an Existing Call Control Group in LAN with Default Parameters (PUT)



<outboundGroup>false</outboundGroup><description>description</description><deviceNamePrefix>mod</deviceNamePrefix><numOfCTIPorts>10</numOfCTIPorts><mediaTerminationSupport>false</mediaTerminationSupport><portGroupConfiguration>

<startingDirectoryNumber>999001</startingDirectoryNumber><devicePool>Default</devicePool><location>Hub_None</location><presenceGroup>Standard Presence group</presenceGroup><redirectCallingSearchSpace>Redirect Party</redirectCallingSearchSpace><requireDTMFReception>true</requireDTMFReception>


Delete Call Control GroupDELETEHTTPS Method





401, 404, 405, 412, 500, 503HTTPS Failure Codes

—Error Codes

Check Status of POST/PUT/DELETEGETHTTPS Method

https://<server>/adminapi/callControlGroup/{id}/statusURI

https://uccx-server:8080/adminapi/callControlGroup/12/statusExample URI


201, 206HTTPS Success Code



System Configuration APIsDelete Call Control Group

—Error Codes

After a POST, PUT or DELETE, perform a GET for the status of the job. If you do not perform a GET requestwith in 5 minutes, a PUT or DELETE request on the same Call ControlGroup is not allowed.

Attention

Success Response

For Create

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ccgJobStatus><totalPorts>120</totalPorts><updatePorts>5</updatePorts><lastUpdatedPort>V11_840024</lastUpdatedPort><type>created</type><completed>true</completed>

</ccgJobStatus>

After the last port is created and the Call Control Group is saved, the completed field will be true.Note

For Modify

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ccgJobStatus><totalPorts>120</totalPorts><updatePorts>5</updatePorts><lastUpdatedPort>V11_840024</lastUpdatedPort><type>modified</type><completed>true</completed>

</ccgJobStatus>

After the last port is modified and the Call Control Group is saved, the completed field will be true.Note

For Delete

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ccgJobStatus><totalPorts>120</totalPorts><updatePorts>5</updatePorts><lastUpdatedPort>V11_840024</lastUpdatedPort><type>deleted</type><completed>true</completed>

</ccgJobStatus>

After the last port is deleted and the Call Control Group is saved, the completed field will be true.Note


System Configuration APIsCheck Status of POST/PUT/DELETE

CampaignCampaigns are logical entities that group a set of contacts together in a dialing list. Campaigns deliver outgoingcalls to agents. Typical applications include appointment and bill payment reminders.

If you select the IVR-based option for a campaign, the outbound calls are handled by the IVR scripts.

If you select the Agent-based option for a campaign, the outbound calls are handled by the available agents.

Data Structure for CampaignDescriptionRestrictionsBase TypeAttribute Name

Unique identifier for the campaign.1 to 2147483647baseIdIntcampaignId

Unique name for the campaign.

PUT operation cannotmodify the campaign name.If you try to modify thename, REST API throws400 Bad Request error.

Note

minLength value = 1

maxLength value = 40

Campaign name containsalphanumeric characters,spaces, underscores (_), andhyphens (-) without leadingor trailing white spaces.

stringcampaignName

Indicates if the campaign is currentlyactive.

default = falsebooleanenabled

Description of the campaign.minLength value = 0


stringdescription

Campaign start time.Between 00:00 to 23:59inclusive

default = 08:00

timeType, stringstartTime

Campaign end time.Between 00:00 to 23:59inclusive

default = 21:00

timeType, stringendTime

Time zone of the campaign.

When you create acampaign, the time zone ifgiven is ignored and theserver time zone isconsidered by default.

This field is read only andcannot be modified throughPUT operation.

Note

—stringtimeZone


System Configuration APIsCampaign


Type of campaign to be used foroutbound calls. You can specify one ofthe following two campaign types:

• Agent-based—All the outboundcalls in the campaign are handledby the available agents.

• IVR-based—All the outboundcalls in the campaign are handledby the IVR scripts.

enum values = AGENT,IVR

enumcampaignType

The dialer type options available for acampaign vary depending on thecampaign type.

For Agent-based campaign type:

• Direct Preview

• Progressive

• Predictive

For IVR-based campaign type:

• Progressive

• Predictive

enum values =DIRECT_PREVIEW,PROGRESSIVE,PREDICTIVE

enumdialerType

Indicates the number of contacts thatare yet to be dialed, contacts thatrequest a callback, and contacts thatwill be tried again because ofunsuccessful prior attempts.

default = 0unsignedIntpendingContacts

Indicates a campaign to which asupervisor is associated with.

minOccurs = 0

maxOccurs = 1

nillable = false

For the supervisor element,

minOccurs = 1

maxOccurs = 1

nillable = false

sequence(supervisor :nameUrlPair)

associatedSupervisors

Common Data Structure for IVR-Based and Agent-Based CampaignsDescriptionRestrictionsBase TypeAttribute Name


System Configuration APIsCommon Data Structure for IVR-Based and Agent-Based Campaigns

The campaign calling number is thenumber that appears to the contact.This number is used by the dialer.

minLength value = 1


The calling number canhave up to 15 digits withan optional plus (+) prefix.

Matches the E.164standard.

stringcampaignCallingNum

Themaximum number of times to diala contact beyond which the call statusis marked as Closed.

minInclusive value = 1

maxInclusive value = 3

default = 3

unsignedIntmaxDialAttempts

The duration before and after thescheduled callback time during whicha callback is attempted.



default = 15

unsignedIntcallbackTimeLimit

Determineswhether a low-volume callis treated as voice or disconnected.

default = truebooleantreatLowVolAsVoice

The duration for which theProgressive/Predictive dialer allowsthe phone to ring before disconnectingan unanswered call.



default = 15

unsignedIntnoAnswerRingLimit

If the customer disconnects the callwithin the time that is here, then thecall is classified as customerabandoned.



default = 2

unsignedIntabandonedCallWaitTime

Duration for which the dialer waitsbefore calling back a no-answer call.


maxInclusive value =65535

default = 60

unsignedIntretryNoAnswerDelay

Duration for which the dialer waitsbefore calling back a busy telephonenumber.



default = 60

unsignedIntretryBusySignalDelay

If a customer abandons a call, theduration after which the dialer callsback the customer.



default = 0

unsignedIntretryCustAbandonedDelay


System Configuration APIsCommon Data Structure for IVR-Based and Agent-Based Campaigns

If the dialer abandons a call, theduration after which the dialer callsback the customer.



default = 0

unsignedIntretryDialerAbandonedDelay

Common Data Structure for Outbound IVR - Progressive and PredictiveCampaigns


The JTAPI trigger that is associated withthe campaign.

—nameUriPairapplicationTrigger

Number of dedicated IVR ports that youwant to reserve for this campaign.

—unsignedIntnumDedicatedPorts

Number of lines to be dialed for eachport.

minInclusive value = 1.0

maxInclusive value = 3.0

default = 1.0

floatlinesPerPort

Data Structure for Outbound IVR - Predictive CampaignDescriptionRestrictionsBase TypeAttribute Name

Maximum number of lines to be dialed foreach port.

minInclusive = 1.0

maxInclusive = 3.0

default = 3.0

floatmaxLinesPerPort

The number of calls that were answeredby live voice that the predictive algorithmconsiders for each iteration.

minInclusive = 10

maxInclusive = 1000

default = 100

unsignedIntpredictiveCorrectionPace

Controls the size of the lines-per-portcorrections.

minEnclusive = 0.0

maxInclusive = 1.0

default = 1.0

floatpredictiveGain

Call abandon percentage.minEnclusive = 0.0

maxInclusive = 100.0

default = 3.0

floatcallAbandonLimit


System Configuration APIsCommon Data Structure for Outbound IVR - Progressive and Predictive Campaigns

Data Structure for Preview CampaignDescriptionRestrictionsBase TypeAttribute Name

The maximum number of times acontact is dialed.

minInclusive = 1

maxInclusive = 3

default = 3

unsignedIntmaxDialAttempts

The number of contact records that areretrieved from the database in bulk fordialing.

minInclusive = 1

maxInclusive = 100

default = 20

unsignedIntcacheSize

If this attribute is enabled, the phonenumber is dialed again at a later time ifan answering machine is reached thefirst time.

default = falsebooleanansMachineRetry

The customer-specified callback time.minInclusive = 1

maxInclusive = 60

default = 15

unsignedIntcallbackTimeLimit

The callback action if a callback ismissed.

enum values =NEXT_DAY, RETRY,CLOSE

default = NEXT_DAY

stringmissedCallbackAction

The Contact Service Queues (CSQs)from which agents are selected foroutbound calls for the campaign.

minLength value = 1stringassignedCSQs

Common Data Structure for Outbound Agent - Progressive and PredictiveCampaigns


Number of lines to be dialed for eachagent.

minInclusive value = 1.0

maxInclusive value = 3.0

default = 1.0

floatlinesPerAgent

The Contact Service Queues (CSQs)from which agents are selected foroutbound calls for the campaign.

minLength value = 1stringassignedCSQs


System Configuration APIsData Structure for Preview Campaign


Specifies how to handle an outboundcall if an answeringmachine is reached.

enum values =TRANSFER_TO_IVR,END_CALL

default =TRANSFER_TO_IVR

stringansMachineTreatment


Application trigger is usedonly when you choose thetransfer to IVR option for anoutbound call.

Note

minOccurs= 0nameUriPairanswerMachineTreatmentTrigger

Specifies how to handle an outboundcall if agents are not available.

enum values =TRANSFER_TO_IVR,ABANDON_CALL

default =TRANSFER_TO_IVR

stringabandonedCallTreatment


Application trigger is usedonly when you choose thetransfer to IVR option for anoutbound call.

Note

minOccurs= 0nameUriPairabandonedCallTreatmentTrigger

The callback action if a callback ismissed.

enum values =NEXT_DAY, RETRY,CLOSE

default = NEXT_DAY

stringmissedCallbackAction

Data Structure for Outbound Agent - Predictive CampaignDescriptionRestrictionsBase TypeAttribute Name

Maximum number of lines to be dialed foreach agent.

minInclusive = 1.0

maxInclusive = 3.0

default = 3.0

floatmaxLinesPerAgent

The number of calls that were answeredby live voice that the predictive algorithmconsiders for each iteration.

minInclusive = 10

maxInclusive = 1000

default = 100

unsignedIntpredictiveCorrectionPace


System Configuration APIsData Structure for Outbound Agent - Predictive Campaign


Controls the size of the lines-per-portcorrections.

minEnclusive = 0.0

maxInclusive = 1.0

default = 1.0

floatpredictiveGain

Call abandon percentage.minEnclusive = 0.0

maxInclusive = 100.0

default = 3.0

floatcallAbandonLimit

Get List of CampaignsGETHTTPS Method

https://<server>/adminapi/campaignURI

https://uccx-server/adminapi/campaignExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><campaigns>

<campaign><self>https://uccx-server/adminapi/campaign/202</self><campaignId>202</campaignId><campaignName>IVRPredictive</campaignName><enabled>false</enabled><description>This is IVR Predictive campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>IVR</campaignType><dialerType>PREDICTIVE</dialerType><pendingContacts>0</pendingContacts>

</campaign><campaign>

<self>https://uccx-server/adminapi/campaign/201</self><campaignId>201</campaignId><campaignName>IVRProgressive</campaignName><enabled>false</enabled><description>This is IVR Progressive campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>IVR</campaignType><dialerType>PROGRESSIVE</dialerType>


System Configuration APIsGet List of Campaigns

<pendingContacts>0</pendingContacts></campaign><campaign>

<self>https://uccx-server/adminapi/campaign/200</self><campaignId>200</campaignId><campaignName>OBPreview</campaignName><enabled>false</enabled><description>This is Outbound Preview campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>DIRECT_PREVIEW</dialerType><pendingContacts>0</pendingContacts>


<self>https://uccx-server/adminapi/campaign/200</self><campaignId>200</campaignId><campaignName>Agent progressive</campaignName><enabled>false</enabled><description>This is Outbound Preview campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>PROGRESSIVE</dialerType><pendingContacts>0</pendingContacts>


<self>https://uccx-server/adminapi/campaign/200</self><campaignId>200</campaignId><campaignName>Agent predictive</campaignName><enabled>false</enabled><description>This is Outbound Preview campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>PREDICTIVE</dialerType><pendingContacts>0</pendingContacts>

</campaign></campaigns>

Get CampaignGETHTTPS Method

https://<server>/adminapi/campaign/{id}URI

https://uccx-server/adminapi/campaign/200Example URI




—Error Codes


System Configuration APIsGet Campaign

Success Response

<?xml version="1.0" encoding="UTF-8"?><campaign>

<self>https://uccx-server/adminapi/campaign/200</self><campaignId>200</campaignId><campaignName>OBPreview</campaignName><enabled>false</enabled><description>This is Outbound Preview campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>DIRECT_PREVIEW</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obPreview><maxDialAttempts>3</maxDialAttempts><cacheSize>20</cacheSize><ansMachineRetry>false</ansMachineRetry><callbackTimeLimit>15</callbackTimeLimit><missedCallbackAction>NEXT_DAY</missedCallbackAction><assignedCSQs>

<csq name="1"><refURL>https://uccx-server/adminapi/csq/1</refURL>

</csq></assignedCSQs>

</obPreview></typeSpecificInfo>

</campaign>

If a campaign is associated with a supervisor, the sample response would be as below:<?xml version="1.0" encoding="UTF-8"?><campaign>

<self></self><campaignId>200</campaignId><campaignName>OBPreview</campaignName><enabled>false</enabled><description>This is Outbound Preview campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>DIRECT_PREVIEW</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>




</obPreview></typeSpecificInfo><associatedSupervisors>

<supervisor name="OBAgent101"><refURL>https://uccx-server/adminapi/csq/1</refURL>

</supervisor>


System Configuration APIsGet Campaign

</associatedSupervisors></campaign>

Create CampaignPOSTHTTPS Method

https://<server>/adminapi/campaignURI

https://uccx-server/adminapi/campaignExample URI




—Error Codes

When Cisco Finesse is deactivated, new agent predictive and agent progressive campaigns cannot be created.Note

Success Response



System Configuration APIsCreate Campaign

Sample Input XML—Outbound IVR - Progressive Campaign


<self>https://uccx-server/adminapi/campaign/201</self><campaignId>201</campaignId><campaignName>IVRProgressive</campaignName><enabled>false</enabled><description>This is IVR Progressive campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>IVR</campaignType><dialerType>PROGRESSIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obIvrProgressive><campaignCallingNum>12345</campaignCallingNum><applicationTrigger name="5657656">

<refURL>https://uccx-server/adminapi/trigger/5657656</refURL></applicationTrigger><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><numDedicatedPorts>0</numDedicatedPorts><linesPerPort>1.0</linesPerPort><treatLowVolAsVoice>true</treatLowVolAsVoice><ansMachineTreatment>TRANSFER_TO_IVR</ansMachineTreatment><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>30</retryCustAbandonedDelay><retryDialerAbandonedDelay>60</retryDialerAbandonedDelay>

</obIvrProgressive></typeSpecificInfo>

</campaign>



Sample Input XML—Outbound IVR - Predictive Campaign


<self>https://uccx-server/adminapi/campaign/202</self><campaignId>202</campaignId><campaignName>IVRPredictive</campaignName><enabled>false</enabled><description>This is IVR Predictive campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>IVR</campaignType><dialerType>PREDICTIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obIvrPredictive><campaignCallingNum>112233</campaignCallingNum><applicationTrigger name="464355">

<refURL>https://uccx-server/adminapi/trigger/464355</refURL></applicationTrigger><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><numDedicatedPorts>0</numDedicatedPorts><linesPerPort>1.5</linesPerPort><treatLowVolAsVoice>true</treatLowVolAsVoice><ansMachineTreatment>TRANSFER_TO_IVR</ansMachineTreatment><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>30</retryCustAbandonedDelay><retryDialerAbandonedDelay>60</retryDialerAbandonedDelay><maxLinesPerPort>3.0</maxLinesPerPort><predictiveCorrectionPace>100</predictiveCorrectionPace><predictiveGain>1.0</predictiveGain><callAbandonLimit>3.0</callAbandonLimit>

</obIvrPredictive></typeSpecificInfo>

</campaign>



Sample Input XML—Preview Campaign







</campaign>



Sample Input XML—Outbound Agent - Progressive Campaign


<self>https://uccx-server/adminapi/campaign/105</self><campaignId>105</campaignId><campaignName>Agent Progressive</campaignName><enabled>false</enabled><description>description</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>PROGRESSIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obAgentProgressive><campaignCallingNum>7777</campaignCallingNum><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><treatLowVolAsVoice>true</treatLowVolAsVoice><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>0</retryCustAbandonedDelay><retryDialerAbandonedDelay>0</retryDialerAbandonedDelay><linesPerAgent>1.0</linesPerAgent><assignedCSQs>

</csq><csq name="37"><refURL>https://uccx-server/adminapi/csq/37</refURL>

</csq></assignedCSQs><answerMachineTreatment>TRANSFER_TO_IVR</answerMachineTreatment><answerMachineTreatmentTrigger name="4600">

<refURL>https://uccx-server/adminapi/trigger/4600</refURL></answerMachineTreatmentTrigger><abandonedCallTreatment>TRANSFER_TO_IVR</abandonedCallTreatment><abandonedCallTreatmentTrigger name="4800">

<refURL>https://uccx-server/adminapi/trigger/4800</refURL></abandonedCallTreatmentTrigger><missedCallbackAction>NEXT_DAY</missedCallbackAction>

</obAgentProgressive></typeSpecificInfo>

</campaign>



Sample Input XML—Outbound Agent - Predictive Campaign


<self>https://uccx-server/adminapi/campaign/114</self><campaignId>114</campaignId><campaignName>Agent predictive</campaignName><enabled>false</enabled><description>description</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>PREDICTIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obAgentPredictive><campaignCallingNum>7777</campaignCallingNum><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><treatLowVolAsVoice>true</treatLowVolAsVoice><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>0</retryCustAbandonedDelay><retryDialerAbandonedDelay>0</retryDialerAbandonedDelay><linesPerAgent>2.0</linesPerAgent><assignedCSQs>




<refURL>https://uccx-server/adminapi/trigger/4800</refURL></abandonedCallTreatmentTrigger><missedCallbackAction>NEXT_DAY</missedCallbackAction><maxLinesPerAgent>2.0</maxLinesPerAgent><predictiveCorrectionPace>100</predictiveCorrectionPace><predictiveGain>1.0</predictiveGain><callAbandonLimit>0.0</callAbandonLimit>

</obAgentPredictive></typeSpecificInfo>

</campaign>

Modify CampaignPUTHTTPS Method

https://<server>/adminapi/campaign /{id}URI




System Configuration APIsModify Campaign



—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML—Outbound IVR - Progressive Campaign


<self>https://uccx-server/adminapi/campaign/201</self><campaignId>201</campaignId><campaignName>IVRProgressive</campaignName><enabled>false</enabled><description>This is IVR Progressive campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>IVR</campaignType><dialerType>PROGRESSIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obIvrProgressive><campaignCallingNum>12345</campaignCallingNum><applicationTrigger name="5657656">

<refURL>https://uccx-server/adminapi/trigger/5657656</refURL></applicationTrigger><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><numDedicatedPorts>0</numDedicatedPorts><linesPerPort>1.0</linesPerPort><treatLowVolAsVoice>true</treatLowVolAsVoice><ansMachineTreatment>TRANSFER_TO_IVR</ansMachineTreatment><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>30</retryCustAbandonedDelay><retryDialerAbandonedDelay>60</retryDialerAbandonedDelay>

</obIvrProgressive></typeSpecificInfo>

</campaign>



Sample Input XML—Outbound IVR - Predictive Campaign


<self>https://uccx-server/adminapi/campaign/202</self><campaignId>202</campaignId><campaignName>IVRPredictive</campaignName><enabled>false</enabled><description>This is IVR Predictive campaign</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>IVR</campaignType><dialerType>PREDICTIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obIvrPredictive><campaignCallingNum>112233</campaignCallingNum><applicationTrigger name="464355">

<refURL>https://uccx-server/adminapi/trigger/464355</refURL></applicationTrigger><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><numDedicatedPorts>0</numDedicatedPorts><linesPerPort>1.5</linesPerPort><treatLowVolAsVoice>true</treatLowVolAsVoice><ansMachineTreatment>TRANSFER_TO_IVR</ansMachineTreatment><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>30</retryCustAbandonedDelay><retryDialerAbandonedDelay>60</retryDialerAbandonedDelay><maxLinesPerPort>3.0</maxLinesPerPort><predictiveCorrectionPace>100</predictiveCorrectionPace><predictiveGain>1.0</predictiveGain><callAbandonLimit>3.0</callAbandonLimit>

</obIvrPredictive></typeSpecificInfo>

</campaign>



Sample Input XML—Preview Campaign







</campaign>



Sample Input XML—Outbound Agent - Progressive Campaign


<self>https://uccx-server/adminapi/campaign/105</self><campaignId>105</campaignId><campaignName>Agent Progressive</campaignName><enabled>false</enabled><description>description</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>PROGRESSIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obAgentProgressive><campaignCallingNum>7777</campaignCallingNum><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><treatLowVolAsVoice>true</treatLowVolAsVoice><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>0</retryCustAbandonedDelay><retryDialerAbandonedDelay>0</retryDialerAbandonedDelay><linesPerAgent>1.0</linesPerAgent><assignedCSQs>




<refURL>https://uccx-server/adminapi/trigger/4800</refURL></abandonedCallTreatmentTrigger><missedCallbackAction>NEXT_DAY</missedCallbackAction>

</obAgentProgressive></typeSpecificInfo>

</campaign>



Sample Input XML—Outbound Agent - Predictive Campaign


<self>https://uccx-server/adminapi/campaign/114</self><campaignId>114</campaignId><campaignName>Agent predictive</campaignName><enabled>false</enabled><description>description</description><startTime>08:00</startTime><endTime>21:00</endTime><timeZone>India Standard Time</timeZone><campaignType>AGENT</campaignType><dialerType>PREDICTIVE</dialerType><pendingContacts>0</pendingContacts><typeSpecificInfo>

<obAgentPredictive><campaignCallingNum>7777</campaignCallingNum><maxDialAttempts>3</maxDialAttempts><callbackTimeLimit>15</callbackTimeLimit><treatLowVolAsVoice>true</treatLowVolAsVoice><noAnswerRingLimit>15</noAnswerRingLimit><abandonedCallWaitTime>2</abandonedCallWaitTime><retryNoAnswerDelay>60</retryNoAnswerDelay><retryBusySignalDelay>60</retryBusySignalDelay><retryCustAbandonedDelay>0</retryCustAbandonedDelay><retryDialerAbandonedDelay>0</retryDialerAbandonedDelay><linesPerAgent>2.0</linesPerAgent><assignedCSQs>




<refURL>https://uccx-server/adminapi/trigger/4800</refURL></abandonedCallTreatmentTrigger><missedCallbackAction>NEXT_DAY</missedCallbackAction><maxLinesPerAgent>2.0</maxLinesPerAgent><predictiveCorrectionPace>100</predictiveCorrectionPace><predictiveGain>1.0</predictiveGain><callAbandonLimit>0.0</callAbandonLimit>

</obAgentPredictive></typeSpecificInfo>

</campaign>

Delete CampaignDELETEHTTPS Method

https://<server>/adminapi/campaign /{id}URI




System Configuration APIsDelete Campaign



—Error Codes

Success Response

HTTPS/1.1 200 OK

Modify Campaign StatePUTHTTPS Method

https://<server>/adminapi/campaign /{id}/state/{enable or disable}URI

https://uccx-server/adminapi/campaign/200/state/enable

https://uccx-server/adminapi/campaign/200/state/disable

Example URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Campaign ContactsCampaign contacts are contacts that are associated with the campaigns as campaign members.

Data Structure for Campaign ContactsDescriptionRestrictionsBase TypeAttribute Name

The campaign towhich thecontacts are associated.

—nameUriPaircampaign

Importing of duplicatecontacts is permitted.Duplicate contacts can bein the same contact file orit can be in differentcontact files.

This is an optional attribute. Only oneoccurrence of this attribute is permitted.

booleanallowDuplicateContacts


System Configuration APIsModify Campaign State


List of contacts withrelevant information foreach contact in acomma-separated text file.

• The first non-empty line is treated asheader line.

• The following case-insensitive headersare supported:

• Account Number

• First Name

• Last Name

• Phone1

• Phone2

• Phone3

• Dial Time

• Phone1 is mandatory and must bespecified.

• Dial Time field is applicable only forUCCX Agent Direct Previewcampaigns.

• Tomcat has a 3 MB size restriction,so GET operation returns a maximumof 10,000 records.

stringcsvdata

Get List of Pending Contacts for CampaignGETHTTPS Method

https://<server>/adminapi/campaign/{id}/contactsURI

https://uccx-server/adminapi/campaign/200/contactsExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><campaignContacts>

<campaign name="previewCampaign"><link href="https://uccx-server/adminapi/campaign/932"


System Configuration APIsGet List of Pending Contacts for Campaign

rel="campaign" type="campaign"/></campaign><csvdata>account number, first name, last name, phone1,

phone2, phone3, dial time

, , , 1000, , , 10:45, , , 1001, , , 10:45, , , 1002, , , 10:45, , , 1003, , , 10:45, , , 1004, , , 10:45</csvdata>

</campaignContacts>


<campaign name="previewCampaign"><refURL>https://uccx-server/adminapi/campaign/932</refURL>

</campaign><csvdata>account number, first name, last name, phone1,

phone2, phone3, dial time, call result, callback number, call status, call result01, call result 02, call result 03, last number dialled, calls made to phone 01, calls madeto phone 02, calls made to phone 03, retry, num missed call back

, , , 1000, , , 10:45, 0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1001, , , 10:45, 0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1002, , , 10:45, 0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1003, , , 10:45, 0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1004, , , 10:45, 0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0</csvdata>

</campaignContacts>

Get List of Pending Contacts for Campaign with Specific Call StatusThis API allows you to provide a specific call status to list the pending contacts for a campaign that exists inthe system. The following call statuses are supported:

• PENDING

• CALLBACK

• RETRY

• RETRIES_WITH_DELAY

• MAX_CALLS

• UNKNOWN

GETHTPS Method

https://<server>/adminapi/campaign/{id}/contacts?q={callstatus}URI

https://uccx-server/adminapi/campaign/200/contacts?q=CALLBACKExample URI


200HTPS Success Code


System Configuration APIsGet List of Pending Contacts for Campaign with Specific Call Status

401, 404, 405HTPS Failure Codes

—Error Codes

Success Response


<campaign name="previewCampaign"><refURL>https://uccx-server/adminapi/campaign/200</refURL></campaign><csvdata>account number, first name, last name, phone1,

phone2, phone3, dial time, , , 1000, , , 10:45, , , 1001, , , 10:45, , , 1002, , , 10:45, , , 1003, , , 10:45, , , 1004, , , 10:45</csvdata>

</campaignContacts>


<campaign name="previewCampaign"><refURL>https://uccx-server/adminapi/campaign/200</refURL>

</campaign><csvdata>account number, first name, last name, phone1,

phone2, phone3, dial time, call result, callback number, call status, call result01, call result 02, call result 03, last number dialled, calls made to phone 01, calls madeto phone 02, calls made to phone 03, retry, num missed call back

, , , 1000, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1001, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1002, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1003, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0, , , 1004, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0</csvdata>

</campaignContacts>

Add Contacts to CampaignPOSTHTPS Method

https://<server>/adminapi/campaign/{id}/contactsURI



200HTPS Success Code

401, 405HTPS Failure Codes

—Error Codes


System Configuration APIsAdd Contacts to Campaign

Success Response


<campaign name="Campaign1"><refURL>https://uccx-server/adminapi/campaign/200</refURL>

</campaign><csvdata/>

</campaignContacts>

Sample Input XML

<?xml version="1.0" encoding="UTF-8"?><campaignContacts xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="campaignContacts.xsd">

<campaign name="Campaign1"><refURL>https://uccx-server/adminapi/campaign/200</refURL>

</campaign><allowDuplicateContacts>true</allowDuplicateContacts><csvdata>

Account Number, First Name, Last Name ,Phone1, Phone2, Phone3, Dial TimeABCD1234, John , Doe, 1401111, 1402222, 1403333, 12:35ABCD1235, Jane , Smith, 1504444, 1505555, 1506666, 12:35

</csvdata></campaignContacts>

Dial Time field is applicable only for UCCX Agent Direct Preview campaigns.Note

Delete All Contacts from CampaignDELETEHTTPS Method

https://<server>/adminapi/campaign /{id}/contactsURI





—Error Codes

Success Response

HTTPS/1.1 200 OK

Channel ParametersChannel parameters are parameters that are associated with chat and email contact channels.


System Configuration APIsDelete All Contacts from Campaign

Data Structure for Channel ParametersDescriptionRestrictionsBase

TypeAttribute Name

Specifies the time in seconds for an agent torespond to the chat request after which, the chatrequest is routed back to the chat queue. Thisattribute is also used for the chat toaster fadeout time.

When you use Chrome or Firefox,the browser overrides the chattoaster notification to fade out in 20seconds, even if it is configured toa higher value.

Note

minInclusive =10

maxInclusive =3600

nillable=false

default =15

intagentNoAnswerTimeout

Specifies the time in seconds after which, thecustomer initiates a chat and, if an agent is notjoined, the customer gets a custom errormessage.

minInclusive =60

maxInclusive =3600

nillable=false

default =60

intagentJoinTimeout

Specifies the customer inactivity time inseconds after which, the system ends the chat.This timeout is on the customer side only.

minInclusive =60

maxInclusive =3600

nillable=false

default =300

intinactivityTimeout

Enables or disables the option to offer a chatcontact to an agent who is on a voice call.

nillable="false"

default="true"

booleanofferChatWhenOnVoice

Enables or disables the option to offer a voicecall to an agent who is on chat.

nillable="false"

default="true"

booleanofferVoiceWhenOnChat

Specifies themaximumnumber of chat sessionsconfigured per agent.

minInclusive =1

maxInclusive =5

nillable=false

default =1

intmaxChatSessionsPerAgent

Specifies the maximum number of emailsessions configured per agent.

minInclusive =1

maxInclusive =5

nillable=false

default =5

intmaxEmailSessionsPerAgent


System Configuration APIsData Structure for Channel Parameters

DescriptionRestrictionsBaseType

Attribute Name

Specify the amount of time (in hours) for whichan email messagewaits in a specific agent CSQ.

minInclusive =1

maxInclusive =120

nillable=false

default =4

intstickyTimeout

Get Channel Parameters InformationGETHTTPS Method

https://<server>/adminapi/channelParametersURI

https://uccx-server/adminapi/channelParametersExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><channelParameters><chatParameters><agentNoAnswerTimeout>12</agentNoAnswerTimeout><agentJoinTimeout>60</agentJoinTimeout><inactivityTimeout>300</inactivityTimeout><offerChatWhenOnVoice>false</offerChatWhenOnVoice><offerVoiceWhenOnChat>false</offerVoiceWhenOnChat><maxChatSessionsPerAgent>2</maxChatSessionsPerAgent>

</chatParameters><emailParameters><maxEmailSessionsPerAgent>3</maxEmailSessionsPerAgent><stickyTimeout>100</stickyTimeout>

</emailParameters></channelParameters>

Put Channel Parameters InformationPUTHTTPS Method

https://<server>/adminapi/channelParametersURI

https://uccx-server/adminapi/channelParametersExample URI



System Configuration APIsGet Channel Parameters Information



—Error Codes

Success Response

HTTPS/1.1 200OK

Sample Input XML—PUT

<?xml version="1.0" encoding="UTF-8"?><channelParameters><chatParameters><agentNoAnswerTimeout>12</agentNoAnswerTimeout><agentJoinTimeout>60</agentJoinTimeout><inactivityTimeout>360</inactivityTimeout><offerChatWhenOnVoice>false</offerChatWhenOnVoice><offerVoiceWhenOnChat>false</offerVoiceWhenOnChat><maxChatSessionsPerAgent>2</maxChatSessionsPerAgent></chatParameters><emailParameters><maxEmailSessionsPerAgent>3</maxEmailSessionsPerAgent></emailParameters>

</channelParameters>

Channel ProviderChannel provider is used to configure the noninteractive channels in Unified CCX. Email is the onlynon-interactive channel that is supported.

Data Structure for Channel ProviderDescriptionRestrictionsBase

TypeAttribute Name

Type of contact channel.minOccurs = 1

maxOccurs = 1

nillable = false

Enumeration = email

stringtype


System Configuration APIsChannel Provider


Attribute Name

Fully qualified domain name (FQDN) ofthe channel provider. FQDN is acombination of the channel serverhostname and domain name. Do not enterthe IP address.

Example:

host.example.com

minOccurs = 1

maxOccurs = 1

nillable = false

Regex = (?=^.{1,255}$)(^(((?!-)[a-zA-Z0-9-]{1,63}(?<!-))|((?!-)[a-zA-Z0-9-]{1,63}(?<!-)\.)+[a-zA-Z]{2,63})$)

stringfqdn

Protocol that is used to communicate withthe channel provider.

minOccurs = 1

maxOccurs = 1

nillable = false

Enumeration

• IMAP for receiving

• SMTP for sending

stringprotocol

Valid 16-bit port number on the channelprovider to establish communication.

minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1

maxInclusive = 65535

intport

Description of the channel provider. Thisfield is optional .

minOccurs = 0

maxOccurs = 1

nillable = false

minLength = 1

maxLength = 100

Description can contain up to100 UTF-8 characters.

stringdescription

Determines if the socks proxy should beused to connect to the channel providerserver or not

socks or none

default = none

Regex = [Ss][Oo][Cc][Kk][Ss]|[Nn][Oo][Nn][Ee]

stringproxyType


System Configuration APIsData Structure for Channel Provider


Attribute Name

Determines the type of the mail server.

To configure IMAP foldervalues, see imapFolderConfigin the Cisco SocialMinerDeveloper Guide available at,https://developer.cisco.com/site/socialminer/documentation/.

Note

minOccurs = 0

maxOccurs = 1

default = microsoft

Regex = gmail|microsoft

stringmailserverType

Get List of Channel ProvidersGETHTTPS Method

https://<server>/adminapi/channelProviderURI

https://uccx-server/adminapi/channelProviderExample URI



500HTTPS Failure Codes

—Error Codes

Success Response

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?><channelProviders>

<channelProvider><self>https://uccx-server/adminapi/channelProvider/8</self><id>8</id><type>email</type><mailserverType>microsoft</mailserverType><proxyType>none</proxyType><send>

<fqdn>host.example.com</fqdn><port>465</port><protocol>SMTP</protocol>

</send><receive>

<fqdn>host.example.com</fqdn><port>993</port><protocol>IMAP</protocol>

</receive><description>This is a channel provider.</description>

</channelProvider></channelProviders>


System Configuration APIsGet List of Channel Providers

https://developer.cisco.com/site/socialminer/documentation/

https://developer.cisco.com/site/socialminer/documentation/

Get List of Channel Providers by TypeGETHTTPS Method

https://<server>/adminapi/channelProvider?type=<type>URI

https://uccx-server/adminapi/channelProvider?type=emailExample URI




—Error Codes

Success Response

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?><channelProvider>

<self>https://uccx-server/adminapi/channelProvider/8</self><id>8</id><type>email</type><mailserverType>microsoft</mailserverType><proxyType>none</proxyType><send>


</send><receive>



</channelProvider>

Get a Channel ProviderGETHTTPS Method

https://<server>/adminapi/channelProvider/<ID>URI

https://uccx-server/adminapi/channelProvider/8Example URI




—Error Codes


System Configuration APIsGet List of Channel Providers by Type

Success Response


<self>https://uccx-server/adminapi/channelProvider/8</self><id>8</id><type>email</type><mailserverType>microsoft</mailserverType><proxyType>none</proxyType><send>


</send><receive>



</channelProvider>

Create a Channel ProviderPOSTHTTPS Method

https://<server>/adminapi/channelProviderURI

https://uccx-server/adminapi/channelProviderExample URI




—Error Codes

Success Response

HTTPS/1.1 201 CREATED

https://uccx-server/adminapi/channelProvider/8

Restriction

You can create only one channel provider of a given type in Unified CCX.

Sample Input XML— POST


<type>email</type><mailserverType>microsoft</mailserverType><proxyType>none</proxyType>

<send><fqdn>host.example.com</fqdn><port>465</port><protocol>SMTP</protocol>


System Configuration APIsCreate a Channel Provider

</send><receive>



</channelProvider>

Modify a Channel ProviderPUTHTTPS Method






—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML— POST


<type>email</type><mailserverType>microsoft</mailserverType><proxyType>none</proxyType>

<send><fqdn>host.example.com</fqdn><port>465</port><protocol>SMTP</protocol>

</send><receive>



</channelProvider>

Delete a Channel ProviderDELETEHTTPS Method




System Configuration APIsModify a Channel Provider




—Error Codes

Success Response

HTTPS/1.1 200 OK

Restriction

You can delete a channel provider only if there are no email Contact Service Queues (CSQs) associated withthe channel provider.

Chat WidgetChat Widget is a chat program that is run by Unified CCX.

Data Structure for Chat WidgetDescriptionRestrictionsBase TypeAttribute Name

Unique ID for each widget.minOccurs = 0

minValue = 1

maxValue =2147483647

intid

Name of the chat widget.minLength = 1

maxLength = 50

occurrences = 1

Regex = ([^<>~`!@#$%?&*()=[]{};,/ '+:.,"])+

stringname

Description of the widgetthat is configured in UnifiedCCX Administration.

minLength = 1

maxLength = 50

occurrences = 1

Regex = ([^<>~`!@#$%?&*()=[]{};,/ '+:.,"])+

stringdescription


System Configuration APIsChat Widget


Valid fieldsets that will beentered by the Admin whileconfiguring the chat widgets.

Note • Fieldsets arecommaseparatedstrings inthe formatfieldset1,fieldset2(forexample:cisco.base.pod,cisco.ccx.pod).

• All theSelectedUser FormFieldsexceptName andEmailshould bepart of theFieldSetsspecified,otherwiseContextServiceoperationsfor chat willfail.

• To performContextServiceLookupCustomerfor chat, theEmail fieldismandatoryin the chatform.

minLength = 1

maxLength = 1024

maxOccurs = 1

minOccurs = 0

Regex = ([0-9a-zA-Z]+([,._-][0-9a-zA-Z]+)*)*

stringcontextServiceFieldsets


System Configuration APIsData Structure for Chat Widget


Fields that are present in theform.

minLength = 1

maxLength = 50

minOccurs = 1

maxOccurs = 10

Regex = ([^<>~`!@#$%?&*()=[]{};,/ '+:.,"])+

stringformField

Location of the logo file thatis displayed in the widget.

minLength = 1

maxLength = 255

minOccurs = 0

maxOccurs = 1

Regex = ([^<>&#*@!`()|{}[]':,;"])+

stringlogoURL

Message that is displayed tothe customer when the chatform is submitted.

minLength = 1

maxLength = 90

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

Default = “Thank youfor contacting us. Acustomer carerepresentative wouldassist you soon.”

stringwelcomeMessage

Message that is displayed tothe customer when a chatrequest is not handled withinthe set time.

minLength = 1

maxLength = 90

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

Default = “All ourcustomer carerepresentatives arebusy. You may wait ortry again later.”

stringagentJoinTimeoutMsg


System Configuration APIsData Structure for Chat Widget


Message that is displayed tothe customer when UnifiedCCX or chat service is notavailable to handle chatrequests.

minLength = 1

maxLength = 90

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

Default = “Chatservice is currentlyunavailable. Try later.”

stringchatErrorMsg

Schedule configuration forbusiness hours, holidays, andspecial days of the chatwidget.

nillable = truescheduleConfigurationDetailsscheduleConfiguration

Definition of the problem.minOccurs = 1

maxOccurs =Unbounded

problemStatementcsqproblemStatementCSQPair

Indicates the type of widget:

• Default : classic

• bubble

minOccurs = 0

maxOccurs = 1

stringtype

Provides styling informationof the chat bubble.

minOccurs = 0

maxOccurs = 1

bubbleStylebubbleStyle

Text messages displayed onthe chat bubble.

minOccurs = 0

maxOccurs = 1

bubbleMessagesbubbleMessages

Problem Statement CSQ Data Structure


minOccurs = 1

maxOccurs = 1

minLength = 1

maxLength = 100

Regex = ([^\|'])+

stringproblemStatement

minOccurs = 1

maxOccurs = 1

nameUriPaircsq


System Configuration APIsProblem Statement CSQ Data Structure

Bubble Style Data Structure


Text displayed on thechat web form andchat bubble.

minOccurs = 1

maxOccurs = 1

minLength = 1

maxLength = 24

stringtitleText

Color of the title text.minOccurs = 1

maxOccurs = 1

Regex = #[A-Fa-f0-9]{6}

colorCodeHextitleTextColor

Text displayed on thebutton of the chatweb form.

minOccurs = 1

maxOccurs = 1

minLength = 1

maxLength = 15

stringbuttonText

Color of the textdisplayed on thebutton.

minOccurs = 1

maxOccurs = 1

Regex = #[A-Fa-f0-9]{6}

colorCodeHexbuttonTextColor

Color of the button.minOccurs = 1

maxOccurs = 1

Regex = #[A-Fa-f0-9]{6}

colorCodeHexbuttonBackgroundColor

Label that asks theuser to choose aproblem statement.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 30

Default = Choose a problemstatement

stringproblemStmtCaption

Whether post-chatrating is available forthe chat.

minOccurs = 0

maxOccurs = 1

nillable = false

Default = false

booleanratingEnabled

Color of the agentmessage text

minOccurs = 1

maxOccurs = 1

Regex = #[A-Fa-f0-9]{6}

colorCodeHexagentMessageTextColor


System Configuration APIsBubble Style Data Structure


Background color ofthe agent message inthe chat window.

minOccurs = 1

maxOccurs = 1

Regex = #[A-Fa-f0-9]{6}

colorCodeHexagentMessageBackgroundColor

Font family used forthe text in the chatweb form and chatwindow.

minOccurs = 1

maxOccurs = 1

maxLength = 30

stringfontType

Bubble Message Data Structure


Text displayed toprompt the user totype message.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 40

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = Type your messageand press enter.

stringtextForTypingMsg

Text indicating thatthe agent has joinedthe chat.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 46

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = ${agent_alias} hasjoined the chat.

stringagentJoinedMsg


System Configuration APIsBubble Message Data Structure


Text indicating thatthe agent has left thechat.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 46

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = ${agent_alias} hasleft the chat.

stringagentLeftMsg

Text on the pop-upthat notifies the userto download the chattranscript.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 75

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = "Chat has ended. Doyou want to download the chattranscript?"

stringtranscriptPopupMsg

Text on the button(on the pop-up) thatallows the user toaccept the transcriptdownload.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 7

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = "No"

stringtranscriptPopupNegativeMsg




Text on the button(on the pop-up) thatallows the user toreject the transcriptdownload.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 7

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = "Yes"

stringtranscriptPopupPositiveMsg

Text on the pop-upthat confirms if theuser wants to closethe chat.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 35

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = "Do you want toclose the chat?"

stringcloseChatPopupMsg

Text on the button(on the pop-up) thatallows the user toreject the chatclosure.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 7

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = "No"

stringcloseChatPopupNegativeMsg

Text on the button(on the pop-up) thatallows the user toaccept the chatclosure.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 7

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = "Yes"

stringcloseChatPopupPositiveMsg




Text indicating thatthe chat wasdisconnected due toconnectivity issues.

minOccurs = 0

maxOccurs = 1

minLength = 1

maxLength = 75

Regex = ([^<>\|&

quot;()/=!\[\]"#%&

amp;*;'+:/\-@])+

Default = "Chat disconnecteddue to inactivity timeout orconnection failure."

stringconnectivityErrorMsg

Schedule Configuration Details Data Structure


A message to be displayed forthe Off Hours.

minLength = 1

maxLength = 255

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

Default = “Sorry, weare not available at themoment ”

stringoffHoursMessage

Indicates the routine businesshours.

minOccurs = 0

maxOccurs = 7

routineBusinessHourroutineBusinessHour

Indicates the business holidays.minOccurs = 0

maxOccurs =unbounded

businessHolidaybusinessHoliday

Indicates the special businessdays.

minOccurs = 0


specialBusinessDayspecialBusinessDay


System Configuration APIsSchedule Configuration Details Data Structure

Routine Business Hour Data Structure


A day of a week.minOccurs = 1

maxOccurs = 1

Enumerations = MON,TUE, WED, THU,FRI,SAT, SUN

stringdayOfWeek

Start time of business hour.minOccurs = 1

maxOccurs = 1

Between 00:00 to 23:59inclusive

stringstartTime

End time of business hour.minOccurs = 1

maxOccurs = 1


stringendTime

Business Holiday Data Structure


Name of occasion.minLength = 1

maxLength = 255

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

stringoccasionName

Date of occasion.minOccurs = 1

maxOccurs = 1

dateString format:yyyy-mm-dd

stringdate

Special Holiday Data Structure


Name of occasion.minLength = 1

maxLength = 255

minOccurs = 0

maxOccurs = 1

Regex = ([^<>|()"])+

stringoccasionName


System Configuration APIsRoutine Business Hour Data Structure


Date of occasion.minOccurs = 1

maxOccurs = 1

dateString format:yyyy-mm-dd

stringdate

Start time of occasion.minOccurs = 1

maxOccurs = 1


stringstartTime

End time of occasion.minOccurs = 1

maxOccurs = 1


stringendTime

Create Chat WidgetPOSTHTTPS Method

https://<server>/adminapi/chatWidgetURI

https://uccx-server/adminapi/chatWidgetExample URI




-Error Codes

Success Response



System Configuration APIsCreate Chat Widget

Sample Input XML for Chat Classic— POST

<?xml version="1.0" encoding="UTF-8"?><chatWidget><self href=https://uccx-server:8080/adminapi/chatWidget rel="self" type="chatWidget"/>

<name>ChatWidget1</name><description>ChatWidget1</description><formField>Name</formField><contextServiceFieldsets>test</contextServiceFieldsets><logoURL>./img/ciscoLogoColor.png</logoURL><welcomeMessage>Thank you for contacting us. A customer care representative would assist

you soon.</welcomeMessage><agentJoinTimeoutMsg>All our customer care representatives are busy. You may wait or

try again later.</agentJoinTimeoutMsg><chatErrorMsg>Chat service is currently unavailable. Try later.</chatErrorMsg><scheduleConfiguration>

<offHoursMessage>Sorry, we are not available at the moment.</offHoursMessage></scheduleConfiguration><problemStatementCSQPair>

<problemStatement>chatTest</problemStatement><csq name="chatCSQ1">

<refURL>https://uccx-server/adminapi/csq/1</refURL></csq>

</problemStatementCSQPair><type>classic</type></chatWidget>



Sample Input XML for Chat Bubble— POST

<?xml version="1.0" encoding="UTF-8"?><chatWidget><self href=https://uccx-server:8080/adminapi/chatWidget rel="self" type="chatWidget"/>

<name>ChatWidget7</name><description>ChatWidget7</description><formField>Name</formField><contextServiceFieldsets>test</contextServiceFieldsets><logoURL>./img/ciscoLogoColor.png</logoURL><welcomeMessage>Thank you for contacting us. A customer care representative would assist

you soon.</welcomeMessage><agentJoinTimeoutMsg>All our customer care representatives are busy. You may wait or

try again later.</agentJoinTimeoutMsg><chatErrorMsg>Chat service is currently unavailable. Try later.</chatErrorMsg><scheduleConfiguration>



<refURL>https://uccx-server/adminapi/csq/1</refURL></csq>

</problemStatementCSQPair><type>bubble</type><bubbleStyle>

<titleText>chat bubble 1</titleText><titleTextColor>#EBEBEC</titleTextColor><buttonText>chat button 1</buttonText><buttonTextColor>#EBEBEC</buttonTextColor><buttonBackgroundColor>#EBEBEC</buttonBackgroundColor><resumeButtonText>Resume Chat</resumeButtonText>

<agentMessageTextColor>#EBEBEC</agentMessageTextColor><agentMessageBackgroundColor>#EBEBEC</agentMessageBackgroundColor><fontType>Arial</fontType>

</bubbleStyle><bubbleMessages>

<textForTypingMsg>Type your message and press enter</textForTypingMsg><agentJoinedMsg>${agent_alias} has joined the chat</agentJoinedMsg><agentTypingMsg>${agent_alias} is typing</agentTypingMsg><agentLeftMsg>${agent_alias} has left the chat</agentLeftMsg><afterChatSessionTranscriptPopupMsg>

<transcriptPopupMsg>Chat has ended. Do you want to download the chattranscript?</transcriptPopupMainMsg>

<transcriptPopupNegativeMsg>No</transcriptPopupNegativeMsg><transcriptPopupPositiveMsg>Yes</transcriptPopupPositiveMsg>

</afterChatSessionTranscriptPopupMsg><closeChatConfirmationPopupMsg>

<closeChatPopupMsg>Do you want to close the chat?</closeChatPopupMainMsg><closeChatPopupNegativeMsg>No</closeChatPopupNegativeMsg><closeChatPopupPositiveMsg>Yes</closeChatPopupPositiveMsg>

</closeChatConfirmationPopupMsg><connectivityErrorMsg>Chat disconnected due to inactivity timeout or connection

failure.</connectivityErrorMsg></bubbleMessages><postChatRating>

<ratingEnabled>true</ratingEnabled><ratingLabel>Rate your chat experience</ratingLabel><ratingButtonText>Submit</ratingButtonText>

</postChatRating></chatWidget>



Get List of Chat WidgetsGETHTTPS Method

https://<server>/adminapi/chatWidgetURI

https://uccx-server/adminapi/chatWidgetExample URI




—Error Codes

Get Chat Widget (XML)GETHTTPS Method

https://<server>/adminapi/chatWidget/<chatWidget id>URI

https://uccx-server/adminapi/chatWidget/2Example URI




—Error Codes


System Configuration APIsGet List of Chat Widgets

Success Response

<?xml version="1.0" encoding="UTF-8"?><chatWidget>

<self href="https://uccx-server:8080/adminapi/chatWidget/2" rel="self" type="chatWidget"/>

<id>2</id><name>TestchatWidget0</name><description>TestchatWidget0</description><formField>Name</formField><contextServiceFieldsets>test</contextServiceFieldsets><logoURL>./img/ciscoLogoColor.png</logoURL>

<welcomeMessage>Thank you for contacting us. A customer care representative would assistyou soon.</welcomeMessage>

<agentJoinTimeoutMsg>All our customer care representatives are busy. You may wait ortry again later.</agentJoinTimeoutMsg>

<chatErrorMsg>Chat service is currently unavailable. Try later.</chatErrorMsg><scheduleConfiguration>



<link href="https://uccx-server:8080/adminapi/csq/1" rel="used by" type="csq"/>

</csq></problemStatementCSQPair><type>bubble</type><bubbleStyle>

<titleText>chat bubble 1</titleText><titleTextColor>#FF0000</titleTextColor><buttonText>chat button 1</buttonText><buttonTextColor>#FF0000</buttonTextColor><buttonBackgroundColor>#EBEBEC</buttonBackgroundColor><resumeButtonText>Resume Chat</resumeButtonText><agentMessageTextColor>#FF0000</agentMessageTextColor><agentMessageBackgroundColor>#FF0000</agentMessageBackgroundColor><fontType>Arial</fontType>








failure.</connectivityErrorMsg></bubbleMessages>

</chatWidget>


System Configuration APIsGet Chat Widget (XML)

Get Chat Widget (HTML)GETHTTPS Method



text/htmlAccept



—Error Codes


System Configuration APIsGet Chat Widget (HTML)

Success Response



<html> <head><meta https-equiv="Content-Type" content="text/html; charset=utf-8"><script language="JavaScript">

function updateAuthor(theForm){if(theForm.extensionField_Name){if(theForm.extensionField_Name.value!=""){theForm.author.value=theForm.extensionField_Name.value;theForm.extensionField_Name.name='extensionField_h_Name';return(true);}}if(theForm.extensionField_Email){if(theForm.extensionField_Email.value!=""){theForm.author.value=theForm.extensionField_Email.value;theForm.extensionField_Email.name='extensionField_h_Email';return(true);}}return(true);}

</script></head><body><form action="https://server.com/chatproxy/api/chat/form/100000" method="post"onsubmit="return updateAuthor(this)"><style type="text/css">span { display: inline-block; width: 120px; }</style>

<span>NAME:</span><input type="text" name="extensionField_NAME" /><br/><span>EMAIL:</span><input type="text" name="extensionField_EMAIL" /><br/><span>ADDRESS:</span><input type="text" name="extensionField_ADDRESS" /><br/><span>CITY:</span><input type="text" name="extensionField_CITY" /><br/><span>AGE:</span><input type="text" name="extensionField_AGE" /><br/><span>Problem:</span><select name="extensionField_ccxqueuetag"><br/>

<option value="Chat_Csq1">problemStatement 0</option></select><br/>

<input type="submit" value="Submit"/><input type="hidden" name="author"value="Customer"/><br/><input type="hidden" name="title" value="ccx chat"/><br/><input type="hidden" name="extensionField_h_widgetName123456" value="TESTCHATWIDGET0"/><br/><input type="hidden" name="extensionField_chatLogo" value="./img/ciscoLogoColor.png"><br/><input type="hidden" name="extensionField_chatWaiting" value="Thank you for contacting us.A customer care representative would assist you soon."><input type="hidden" name="extensionField_chatAgentJoinTimeOut" value="All our customercare representatives are busy. You may wait or try again later."><input type="hidden" name="extensionField_chatError" value="Chat service is currentlyunavailable. Try later."></form>

<script type="application/javascript">function startChat2(){

if(typeof initiateChat === "undefined"){var bubbleChatScript = document.createElement("script");var bubbleChatScript.type = "application/javascript";var bubbleChatScript.src = "https://server.com/ccp/js/bubblechat.js";document.head.appendChild(bubbleChatScript);

}initiateChat("server.com",2);

}</script>



</body></html>



Modify Chat WidgetPUTHTTPS Method






—Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsModify Chat Widget

Sample Input XML— PUT

<?xml version="1.0" encoding="UTF-8"?><chatWidget><self href="https://uccx-server:8080/adminapi/chatWidget/2" rel="self" type="chatWidget"/>

<name>chatWidget7</name><description>chatWidget7</description><formField>Name</formField><contextServiceFieldsets>test</contextServiceFieldsets><logoURL>./img/myLogo.png</logoURL><welcomeMessage>Thank you for contacting us. A customer care representative would assistyou soon.</welcomeMessage><agentJoinTimeoutMsg>All customer care representatives are busy. You may wait or try againlater.</agentJoinTimeoutMsg><chatErrorMsg>Chat service is currently unavailable. Try later.</chatErrorMsg><scheduleConfiguration> <offHoursMessage>Sorry, we are not available at themoment.</offHoursMessage></scheduleConfiguration><problemStatementCSQPair><problemStatement>chatTest</problemStatement><csq name="chatCSQ1"><link href="https://uccx-server/adminapi/csq/2" rel="" type=""/></csq></problemStatementCSQPair>

<type>bubble</type><bubbleStyle>

<titleText>chat bubble 1</titleText><titleTextColor>#EBEBEC</titleTextColor><buttonText>chat button 1</buttonText><buttonTextColor>#EBEBEC</buttonTextColor><buttonBackgroundColor>#EBEBEC</buttonBackgroundColor><resumeButtonText>Resume Chat</resumeButtonText>

<agentMessageTextColor>#EBEBEC</agentMessageTextColor><agentMessageBackgroundColor>#EBEBEC</agentMessageBackgroundColor><fontType>Arial</fontType>








failure.</connectivityErrorMsg></bubbleMessages><postChatRating>

<ratingEnabled>true</ratingEnabled><ratingLabel>Rate your chat experience</ratingLabel><ratingButtonText>Submit</ratingButtonText>

</postChatRating></chatWidget>


System Configuration APIsModify Chat Widget

Delete Chat WidgetDELETEHTTPS Method






HTTPS/1.1 400 Bad RequestFailure Response

—Error Codes

Success Response

HTTPS/1.1 200 OK

Contact Service QueueThe Contact Service Queue (CSQ) controls incoming calls by determining where an incoming call is placedin the queue and to which agent the call is sent.

CSQ Data StructureDescriptionRestrictionsBase TypeAttribute Name

Name of the CSQ as set up inUnified CCX Administration

minLength = 1

maxLength = 50

minOccurs = 1

maxOccurs = 1

nillable = false

Name containsalphanumericcharacters, specialcharacters, spaces,underscores (_), andhyphens (-) withoutleading or trailing whitespaces.

stringname


System Configuration APIsDelete Chat Widget


A type of the CSQ.

Possible values:

0—voice CSQ

1—email CSQ

2—chat CSQ

minOccurs = 1

maxOccurs = 1

nillable = false

Enumerations =VOICE, EMAIL,CHAT

stringqueueType

Criterion that specifies howcontacts are queued, as set up inUnified CCX Administration.

minOccurs = 1

maxOccurs = 1

nillable = false

Enumerations = FIFO

stringqueueAlgorithm

Whether an agent goes to WorkState after handling a call fromthis CSQ:

f —No

t —Yes

minOccurs = 0

maxOccurs = 1

nillable = false

default = false

booleanautoWork

Time in seconds that agent isplaced in Work state.

Possible values:

1—7200

0—disabled

minOccurs = 0

maxOccurs = 1

nillable = false

minInclusive = 0

maxInclusive = 7200

intwrapupTime

Type of resource pool that is setup in Unified CCXAdministration:

1—Resource groups

2—Resource skills

minOccurs = 1

maxOccurs = 1

nillable = false

Enumerations =skillGroup,ResourceGroup

stringresourcePoolType

Goal, in seconds, for themaximum time that a callerspends in the queue before thecall is answered by an agent, asset up in Unified CCXAdministration.

minOccurs = 0

maxOccurs = 1

nillable = false

default = 5

baseIdIntserviceLevel


System Configuration APIsCSQ Data Structure


Goal for the percentage of callsthat meet the service level thatis shown in the serviceLevelfield, as set up in Unified CCXAdministration.

minOccurs = 0

maxOccurs = 1

nillable = false

default = 70

minInclusive = 1

maxInclusive = 100

intserviceLevelPercentage

Specific information about thepool, such as Skill Group orResources Group.

minOccurs = 1

maxOccurs = 1

skillorResourceGrouppoolSpecificInfo

The Routing Type element ismandatory for the Email CSQand it should be set to"NONINTERACTIVE".

For all other media typesincluding the Voice and Chat, itis not mandatory to specify therouting type.

minOccurs = 0

maxOccurs = 1

nillable = false

Enumerations: VOICE,INTERACTIVE, andNONINTERACTIVE

stringRoutingType

Mapping Between the CSQ Types and Routing Types That Are Used

Routing TypeCSQ Type

VOICEVOICE

NONINTERACTIVEEMAIL

INTERACTIVECHAT

The support for Routing Type "EMAIL" has been ended from Unified CCX 11.0(1) release onward. If CSQtype is "EMAIL", then the Routing Type can only be specified as "NONINTERACTIVE".

Note


System Configuration APIsCSQ Data Structure

Email CSQ Data StructureDescriptionRestrictionsBase TypeAttribute Name

Email account userid fromwhich emails are retrieved forthis CSQ.

One email address is associatedwith only one Email CSQ.

This field is mandatory for theEmail CSQ.

minLength = 5

maxLength = 75

minOccurs = 0

maxOccurs = 1

nillable = false

Name containsalphanumericcharacters, specialcharacters, spaces, dots(.), underscores (_), andhyphens (-) withoutleading or trailing whitespaces.

The account user IDcannot have consecutivedots.

The domain can haveup to four characters.

stringaccountUserId

Password for the account userID.


minLength = 1

maxLength = 128

minOccurs = 0

maxOccurs = 1

nillable = false

stringaccountPassword

Stores information about thesource of the contacts.

In case of email, it is the mailserver.


minOccurs = 0

maxOccurs = 1

nillable = false

nameUriPairchannelProvider

Frequency to fetch emails fromthe server in seconds.


The pollingInterval is specifiedin seconds.

minOccurs = 0

maxOccurs = 1

nillable = false

minInclusive = 10


default = 600

intpollingInterval


System Configuration APIsEmail CSQ Data Structure


The folder that holds the emailmessages in the email account.


minLength = 1

maxLength = 255

minOccurs = 0

maxOccurs = 1

nillable = false

default = "Inbox"

stringfolderName

Specify the time inminutes fromwhen the emails are to befetched.


The snapshotAge is specified inminutes.

minOccurs = 0

maxOccurs = 1

nillable = false

minInclusive = 10


default = 120

intsnapshotAge

Skill or Resource Group Data StructureDescriptionRestrictionsBase TypeAttribute Name

Unique identifier that isused to locate theassociated skill group inthe Skill Group table.

minOccurs = 1

maxOccurs = 1

(choice)skillCompetencyList

skillGroup

Unique identifier that isused to locate theassociated resource groupin the Resource Grouptable.

minOccurs = 1

maxOccurs = 1

(choice) resourceGrouplistresourceGroup

Skill Competency Data StructureDescriptionRestrictionsBase TypeAttribute Name

Minimum acceptable skilllevel for agents with thisskill, as set up in theUnified CCXAdministration. Valuesrange from 1 (lowest) to10 (highest).

minOccurs = 0

maxOccurs = 50

skillDetailsskillCompetency


System Configuration APIsSkill or Resource Group Data Structure


Resource pool selectionmodel that is set up in theUnified CCXAdministration.

minOccurs = 1

maxOccurs = 1

Enumerations = LongestAvailable, Most HandledContacts, ShortestAverage Handle Time,Most Skilled, LeastSkilled, Most Skilled byWeight, Least Skilled byWeight, Most Skilled byOrder, Least Skilled byOrder.

stringselectionCriteria

Skill Details Data StructureDescriptionRestrictionsBase TypeAttributes

minOccurs = 0

maxOccurs = 1

(extension)skillCompetency

Skills within a CSQ canbe assigned weights. Thisfield is used in theweighted skill calculationof the skill-based resourceselection algorithm.

Default value is 1.

minOccurs = 0

maxOccurs = 1

nillable = false

default = 1

minInclusive = 1

maxInclusive = 1000

intweight

Skills within a CSQ canbe ordered. This field isused in the order skillcalculation of theskill-based resourceselection algorithm.

Default value is 1.

minOccurs = 0

maxOccurs = 1

nillable = false

baseIdIntorder

Resource Group Lists Data StructureDescriptionRestrictionsBase TypeAttribute

Name of the resourcegroup, as set up in theUnified CCXAdministration.

minOccurs = 1

maxOccurs = 1

nillable = false

nameUriPairresourceGroupNameUriPair


System Configuration APIsSkill Details Data Structure


Resource pool selectionmodel that is set up in theUnified CCXAdministration.

minOccurs = 1

maxOccurs = 1

Enumerations=LongestAvailable, Linear,Circular, Most HandledContacts, and ShortestAverage Handle Time.

stringselectionCriteria

Order in which theresource resides within theresource group.

minOccurs = 0

maxOccurs = unbounded

nillable = false

resourceOrderresourceAndOrder

Resource Order Data StructureDescriptionRestrictionsBase TypeAttributes

Name of the resource.

Resource groups arecollections of agents thatyour CSQ uses to handleincoming calls.

minOccurs = 1

maxOccurs = 1

nillable = false

nameUriPairresource

Order in which theresource resides within theresource group.

minOccurs = 0

maxOccurs = 1

nillable = false

baseIdIntorder

Get List of CSQsGETHTTPS Method

https://<server>/adminapi/csqURI

https://uccx-server/adminapi/csqExample URI




—Error Codes


System Configuration APIsResource Order Data Structure

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><csqs><csq><self>https://uccx-server/adminapi/csq/1</self><id>1</id><name>Auto_Sanity_CSQ</name><queueType>VOICE</queueType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><wrapupTime>0</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="chat"><refURL>https://<uccxip>/adminapi/Skill/2</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo></csq><csq><self>https://uccx-server/adminapi/csq/2</self><id>2</id><name>icdcsq</name><queueType>VOICE</queueType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><wrapupTime>0</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="icd"><refURL>https://uccx-server/adminapi/Skill/3</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo></csq><csq><self>https://uccx-server/adminapi/csq/3</self><id>3</id><name>outboundCsq</name><queueType>VOICE</queueType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><wrapupTime>0</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo>


System Configuration APIsGet List of CSQs

<skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="ob_skill"><refURL>https://uccx-server/adminapi/Skill/4</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo></csq>

</csqs><csq>

<self></self><id>60</id><name>EmailCSQ1</name><queueType>EMAIL</queueType><routingType>NONINTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo>

<skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="S1"><refURL></refURL>

</skillNameUriPair><weight>1</weight>

</skillCompetency><selectionCriteria>Longest Available</selectionCriteria>

</skillGroup></poolSpecificInfo><accountUserId>[email protected]</accountUserId><accountPassword>accountpassword</accountPassword><reviewQueue name="RevQueue1"><refURL></refURL>

</reviewQueue><channelProvider name="1"><refURL>https://uccx-server/adminapi/channelServer/1</refURL>

</channelProvider><pollingInterval>600</pollingInterval><folderName>Inbox</folderName><snapahotAge>120</snapshotAge>

</csq><csq>

<self href="https://uccx-server/adminapi/csq/23" rel="self" type="csq" /><id>23</id><name>csq1weitorder</name><queueType>VOICE</queueType> <routingType>VOICE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><wrapupTime>0</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo>

<skillGroup><skillCompetency>

<competencelevel>4</competencelevel><skillNameUriPair name="aa">



<link href="https://uccx-server/adminapi/Skill/2" rel="selectedSkill"

type="Skill" /></skillNameUriPair><weight>1</weight>

</skillCompetency><skillCompetency>

<competencelevel>5</competencelevel><skillNameUriPair name="bb"><link href="https://uccx-server/adminapi/Skill/3" rel="selectedSkill"

type="Skill" /></skillNameUriPair><weight>1</weight>

</skillCompetency><selectionCriteria>Least Skilled by Order</selectionCriteria>

</skillGroup></poolSpecificInfo>

</csq></csqs>

GETHTTPS Method

https://<server>/adminapi/csq?detail=fullURI

https://uccx-server/adminapi/csq?detail=fullExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><csqs><csq><self>https://uccx-server/adminapi/csq/1</self><id>1</id><name>chatcsq1</name><queueType>CHAT</queueType><routingType>INTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="chatskill1"><refURL>https://uccx-server/adminapi/skill/2</refURL></skillNameUriPair><weight>1</weight>

</skillCompetency><skillCompetency><competencelevel>5</competencelevel>



<skillNameUriPair name="chatskill2"><refURL>https://uccx-server/adminapi/skill/3</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria>

</skillGroup></poolSpecificInfo></csq>

<csq><self>https://uccx-server/adminapi/csq/4</self><id>4</id><name>QueueEmail</name><queueType>EMAIL</queueType><routingType>NONINTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="email1"><refURL>https://uccx-server/adminapi/skill/4</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo><accountUserId>[email protected]</accountUserId><accountPassword></accountPassword><channelProvider name="2">

<refURL>https://uccx-server/adminapi/channelProvider/2</refURL></channelProvider><pollingInterval>600</pollingInterval><folderName>Inbox</folderName><snapshotAge>120</snapshotAge></csq><csq><self>https://uccx-server/adminapi/csq/5</self><id>5</id><name>QueueEmail2</name><queueType>EMAIL</queueType><routingType>NONINTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="email1"><refURL>https://uccx-server/adminapi/skill/4</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo><accountUserId>[email protected]</accountUserId><accountPassword></accountPassword><channelProvider name="2"><refURL>https://uccx-server/adminapi/channelProvider/2</refURL></channelProvider><pollingInterval>600</pollingInterval><folderName>Inbox</folderName><snapshotAge>120</snapshotAge>

</csq>



<csq><self>https://uccx-server/adminapi/csq/7</self><id>7</id><name>sad</name><queueType>VOICE</queueType><routingType>VOICE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><wrapupTime>0</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="chatskill2"><refURL>https://uccx-server/adminapi/skill/3</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo>

</csq><csq><self>https://uccx-server/adminapi/csq/6</self><id>6</id><name>test_chat</name><queueType>CHAT</queueType><routingType>INTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="chatskill1"><refURL>https://uccx-server/adminapi/skill/2</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo></csq></csqs>

GETHTTPS Method

https://<server>/adminapi/csq?detail=<string>URI

https://uccx-server/adminapi/csq?detail=<string>Example URI




—Error Codes



<string> can be any other string except full and fetchRequeueCsqList.Note

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><results><names><name name="chatcsq1"><refURL>https://uccx-server/adminapi/csq/1</refURL></name><name name="QueueEmail"><refURL>https://uccx-server/adminapi/csq/4</refURL></name><name name="QueueEmail2"><refURL>https://uccx-server/adminapi/csq/5</refURL></name><name name="CSQ1"><refURL>https://uccx-server/adminapi/csq/7</refURL></name><name name="CSQ2"><refURL>https://uccx-server/adminapi/csq/6</refURL></name></names></results>

GETHTTPS Method

https://<server>/adminapi/csq?detail=fetchRequeueCsqList&mediaType=chatURI

https://uccx-server/adminapi/csq?detail=fetchRequeueCsqList&mediaType=chatExample URI




—Error Codes

Users with Agent and Supervisor Roles can also access this get list. However, Users with Agent roles havelimited access to this URI with only chat and email media types.

Note

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><results><names><name name="chatcsq1"><refURL>https://uccx-server/adminapi/csq/1</refURL></name><name name="chatcsq2"><refURL>https://uccx-server/adminapi/csq/6</refURL></name></names></results>

Get CSQGETHTTPS Method

://<server>/adminapi/csq/{id}URI

://uccx-server/adminapi/csq/22Example URI




System Configuration APIsGet CSQ


—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><csq><self>https://uccx-server/adminapi/csq/3</self><id>3</id><name>outboundCsq</name><queueType>VOICE</queueType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>false</autoWork><wrapupTime>0</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo><skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="ob_skill"><refURL>https://uccx-server/adminapi/Skill/4</refURL></skillNameUriPair><weight>1</weight></skillCompetency><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo></csq>

Success Response—New Email CSQ

<?xml version="1.0" encoding="UTF-8"?><csq><self></self><id>28</id><name>Email_Csq26</name><queueType>EMAIL</queueType><routingType>NONINTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><resourcePoolType>SKILL_GROUP</resourcePoolType><poolSpecificInfo><skillGroup><selectionCriteria>Longest Available</selectionCriteria></skillGroup></poolSpecificInfo><accountUserId>[email protected]</accountUserId><accountPassword>accountpassword</accountPassword><channelProvider name="2"><refURL></refURL></channelProvider><pollingInterval>600</pollingInterval><folderName>Inbox</folderName><snapshotAge>120</snapshotAge></csq>


System Configuration APIsGet CSQ

Create CSQPOSTHTTPS Method

https://<server>/adminapi/csqURI

https://uccxserver/adminapi/csqExample URI




—Error Codes

Success Response


Sample Input XML—Create a CSQ (POST)

<csq xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="csq.xsd">

<self href="" rel="" type="" /><name>vcsq1</name><queueType>VOICE</queueType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>true</autoWork><wrapupTime>1</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo>


<competencelevel>5</competencelevel><skillNameUriPair name="skill1">

<refURL>URL</refURL></skillNameUriPair><weight>1</weight></skillCompetency><skillCompetency>


<refURL>URL</refURL></skillNameUriPair><weight>1</weight>



</csq>


System Configuration APIsCreate CSQ

Sample Input XML—New Email CSQ


<self href="" rel="" type="" /><name>newEmail73</name><queueType>EMAIL</queueType><routingType>NONINTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>true</autoWork><wrapupTime>1</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo>

<skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="skill1">

<refURL></refURL></skillNameUriPair><weight>1</weight>



<accountUserId>[email protected]</accountUserId><accountPassword>abc123</accountPassword><reviewQueue name="test_CSQ_1"><refURL></refURL></reviewQueue><channelProvider name="3"><refURL>https://uccx-server/adminapi/channelServer/3</refURL></channelProvider><pollingInterval>600</pollingInterval><folderName>Inbox</folderName><snapshotAge>120</snapshotAge></csq>

Modify CSQPUTHTTPS Method

https://<server>/adminapi/csq/{id}URI

https://uccxserver/adminapi/csq/22Example URI




—Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsModify CSQ

Sample Input XML—Modify a CSQ (PUT)


<self href="" rel="" type="" /><name>Modifiedchatcsq</name><queueType>CHAT</queueType><queueAlgorithm>FIFO</queueAlgorithm><resourcePoolType>SKILL_GROUP</resourcePoolType><poolSpecificInfo>




</skillCompetency><skillCompetency>





</csq>


System Configuration APIsModify CSQ

Sample Input XML—New Email CSQ


<self href="" rel="" type="" /><name>modifiedEmailCsq</name><queueType>EMAIL</queueType><routingType>NONINTERACTIVE</routingType><queueAlgorithm>FIFO</queueAlgorithm><autoWork>true</autoWork><wrapupTime>1</wrapupTime><resourcePoolType>SKILL_GROUP</resourcePoolType><serviceLevel>5</serviceLevel><serviceLevelPercentage>70</serviceLevelPercentage><poolSpecificInfo>

<skillGroup><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="skill1">

<refURL></refURL></skillNameUriPair><weight>1</weight>



<accountUserId>[email protected]</accountUserId><accountPassword>abc123</accountPassword><reviewQueue name="test_CSQ_1"><refURL></refURL></reviewQueue><channelProvider name="3"><refURL>https://uccx-server/adminapi/channelServer/3</refURL></channelProvider><pollingInterval>600</pollingInterval><folderName>Inbox</folderName><snapshotAge>120</snapshotAge></csq>

Delete CSQDELETEHTTPS Method

https://<server>/adminapi/csq/{id}URI

https://uccxserver/adminapi/csq/22Example URI




—Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsDelete CSQ

Context ServiceCisco Context Service is a cloud-based omnichannel solution for Cisco Contact Center Express and ContactCenter Enterprise. It enables you to capture your customer’s interaction history by providing flexible storageof customer-interaction data across any channel.

Context Service works with Cisco Customer Collaboration products. Context Service also provides an SDKinterface for integration with your own applications or third-party applications to capture end-to-endcustomer-interaction data.

For more information about Context Service and to check service availability, see https://cisco.com/go/contextservice.

Data Structure for ContextService ConfigurationDescriptionRestrictionsBase TypeAttribute Name

Indicates if the Context Service is inproduction mode or lab mode.

default = falsebooleanlabMode

The number of milliseconds (ms) thesystem should wait before rejecting theContext Service cloud connectivity.

200 to 5000

default = 5000

intrequestTimeoutMillis

Determines if the https proxy is usedfor Context Service connectivity.

https or none

default = none

stringproxyType

Get ContextService ConfigurationGETHTTPS Method

https://<server>/adminapi/contextserviceconfigurationURI

https://uccx-server/adminapi/contextserviceconfigurationExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><contextServiceConfiguration><labMode>false</labMode><requestTimeoutMillis>5000</requestTimeoutMillis><proxyType>none</proxyType></contextServiceConfiguration>


System Configuration APIsContext Service

https://cisco.com/go/contextservice

https://cisco.com/go/contextservice

Update Context Service ConfigurationPUTHTTPS Method

https://<server>/adminapi/contextserviceconfigurationURI

https://uccx-server/adminapi/contextserviceconfigurationExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML — Modify ContextService Configuration (PUT)

<?xml version="1.0" encoding="UTF-8"?><contextServiceConfiguration><labMode>false</labMode><requestTimeoutMillis>5000</requestTimeoutMillis><proxyType>none</proxyType></contextServiceConfiguration>

Proxy Parameters should be configured prior to choosing Proxy Type for Context Service.Note

Data SourceData sources are databases that are configured to communicate with the Unified CCX system.

Data Structure for Data SourceDescriptionRestrictionsBase TypeAttribute Name

Unique identifier for the data sourceminOccurs = 0

maxOccurs = 1

nillable = false

intid


System Configuration APIsUpdate Context Service Configuration


Unique name for the data sourceminLength value = 1


minOccurance = 1

maxOccurance = 1

Data source name containsalphanumeric characters, spaces,underscores (_), hyphens (-), plussigns (+), pipes (|), colons (:),periods (.), and slashes (/) withoutleading or trailing white spaces.

stringname

Username that is defined forconnecting to the enterprisedatabase

minLength value = 1


minOccurences = 1

maxOccurences = 1

Special characters like | , {, }, <, >,', \", (, ), \\ , /, %, \+, ?, \*, &, andcomma are not allowed.

stringuserName

Password that is defined forconnecting to the enterprisedatabase

minLength value = 1


minOccurences = 1

Special characters like &, \", <, >,\', %, and comma are not allowed.

stringpassword

Maximum number of connectionsthat are allowed to connect to thedatabase



minOccurences = 1

intmaxConnection

Driver for this data source tocommunicate to the enterprisedatabase

enumeration

• oracle.jdbc.driver.OracleDriver

• com.ibm.db2.jcc.DB2Driver

• net.soureforge.jtds.jdbc.Driver

• com.sysbase.jdbc2.jdbc.SybDriver

stringdriver

JDBC URL that is used to obtain aconnection to the enterprisedatabase

minLength value = 1


minOccurences = 1

stringjdbcURL


System Configuration APIsData Structure for Data Source

Get List of Data SourcesGETHTTPS Method

https://<server>/adminapi/datasourceURI

https://uccx-server/adminapi/datasourceExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><datasources><datasource><self>URL</self><id>15</id><name>oracle1</name><userName>System</userName><password>MTJDY2J1MTI=</password><maxConnection>10</maxConnection><driver>oracle.jdbc.driver.OracleDriver</driver><jdbcURL>jdbc:oracle:thin://@uccx-server:1521/XE</jdbcURL></datasource></datasources>

Get Data SourceGETHTTPS Method

https://<server>/adminapi/dataSource/{id}URI

https://uccx-server/adminapi/dataSource/21Example URI





Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><DataSource><self>https://uccx-server/adminapi/dataSource/</self><id>15</id><name>oracle1</name><userName>System</userName>


System Configuration APIsGet List of Data Sources

<password>MTJDY2J1MTI=</password><maxConnection>10</maxConnection><driver>oracle.jdbc.driver.OracleDriver</driver><jdbcURL>jdbc:oracle:thin://@uccx-server:1521/XE</jdbcURL></DataSource>

Create Data SourcePOSTHTTPS Method

https://<server>/adminapi/dataSourceURI

https://uccx-server/adminapi/dataSourceExample URI




HTTPS/1.1 400 Bad RequestError Codes

Success Response


Sample Input XML—Create DataSource (POST)

<?xml version="1.0" encoding="UTF-8"?><DataSource>

<name>oracle1</name><userName>System</userName><password>MTJDY2J1MTI=</password><maxConnection>10</maxConnection><driver>oracle.jdbc.driver.OracleDriver</driver><jdbcURL>jdbc:oracle:thin://@uccx-server:1521/XE</jdbcURL>

</DataSource>

Modify Data SourcePUTHTTPS Method





400, 401, 404, 405HTTPS Failure Code



System Configuration APIsCreate Data Source

Success Response

HTTPS/1.1 200 OK

Sample Input XML—Modify DataSource (PUT)

<?xml version="1.0" encoding="UTF-8"?><DataSource>

<self>URL</self><id>15</id><name>oracle1</name><userName>System2</userName><password>MTJDY2J1MTI=</password><maxConnection>10</maxConnection><driver>oracle.jdbc.driver.OracleDriver</driver><jdbcURL>jdbc:oracle:thin://@uccx-server:1521/XE</jdbcURL>

</DataSource>

Delete Data SourceDELETEHTTPS Method







Success Response

HTTPS/1.1 200 OK

Test Connection for Data SourceGETHTTPS Method

https://<server>/adminapi/dataSource/{id}/testConnectionURI

https://uccx-server/adminapi/dataSource/30/testConnectionExample URI





System Configuration APIsDelete Data Source

<?xml version="1.0" encoding="UTF-8"standalone="yes"?><DatabaseTestResult><testResult>false</testResult></DatabaseTestResult>

Error Codes

Success Response

HTTPS/1.1 200 OK

DB Purge Schedule ConfigurationDB purge schedule configuration schedules a DB purge with given configurations and triggers automaticpurge at a given time stamp.

Data Structure for DB Purge Schedule ConfigurationDescriptionRestrictionsBase TypeAttribute Name

Data older than the specified numberof months to be purged.

minInclusive = 1

maxInclusive = 99

intreataininterval

Data older than the specified numberof days to be purged.

minInclusive = 1

maxInclusive = 99

inthrdbdays

Percentage of the maximum databasesize at which an automatic purge isinitiated.

minInclusive = 5

maxInclusive = 95

inthrdbmaxsize

Time of the day for the daily purgewith the time zone. The time displayedhere is based on the primary time zonespecified during initial setup of UnifiedCCX Administration.

In a High Availability overWAN deployment, thepurge schedule happens atthe time zone of the primarynode.

Note

nillable= false

Regex:

[(0[1-9]|1[0-2]):[0]

(AM|PM)]

stringscheduledTime

The total duration for which the purgeprocess should run.

minInclusive = 1

maxInclusive = 23

intpurge run time

Percentage of the maximum extentssize of any table above which anautomatic purge is initiated.

minInclusive = 60

maxInclusive = 90

intinitiate automaticpurge when extentsize exceeds


System Configuration APIsDB Purge Schedule Configuration

Get Purge Configuration InformationGETHTTPS Method

https://<server>/adminapi/dbpurgeURI

https://uccx-server/adminapi/dbpurgeExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><dbpurge><retaininterval>6</retaininterval><hrdbdays>1</hrdbdays><hrdbmaxsize>5</hrdbmaxsize><scheduledTime>04:00 PM</scheduledTime></dbpurge>

Update Purge Configuration InformationPUTHTTPS Method

https://<server>/adminapi/dbpurgeURI

https://uccx-server/adminapi/dbpurgeExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML — Modify a DB Purge Configuration (PUT)

<?xml version="1.0" encoding="UTF-8"?><dbpurge><retaininterval>months</retaininterval><hrdbdays>days</hrdbdays><hrdbmaxsize>dbsize</hrdbmaxsize><scheduledTime>time</scheduledTime></dbpurge>


System Configuration APIsGet Purge Configuration Information

DB Purge Now ConfigurationDB purge now configuration purges the database manually at any time with the given configuration values.

Data Structure for DB Purge Now ConfigurationDescriptionRestrictionsBase TypeAttribute Name

Data older than the specified numberof months to be purged.

minInclusive = 0

maxInclusive = 99

intmonths

Data older than the specified numberof days to be purged.

minInclusive = 1

maxInclusive = 99

intdays

The total duration for which the purgeprocess should run.

minInclusive = 1

maxInclusive = 23

intpurge run time

Update Purge Now ConfigurationPUTHTTPS Method

https://<server>/adminapi/dbpurgeNowURI

https://uccx-server/adminapi/dbpurgeNowExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML — Modify and initiate a DB Purge now (PUT)

<?xml version="1.0" encoding="UTF-8"?><dbpurgeNow><months>months</months><days>days</days></dbpurgeNow>


System Configuration APIsDB Purge Now Configuration

DB Purge Configuration StatusDB purge configuration status gets the status of manual and schedule purge.

Data Structure for DB Purge Configuration StatusDescriptionRestrictionsBase TypeAttribute Name

State of the purge.minOccurs = 1

maxOccurs = 1

nillable = false

stringpurgeState

Time stamp of the purge.minOccurs = 1

maxOccurs = 1

nillable = false

stringpurgeTimeStamp

Type of the purge.minOccurs = 1

maxOccurs = 1

nillable = false

stringpurgeType

Get Purge Configuration StatusGETHTTPS Method

https://<server>/adminapi/purgeConfigStatusURI

https://uccx-server/adminapi/purgeConfigStatusExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><purgeConfigStatus><purgeState>COMPLETED_SUCCESSFULLY</purgeState><purgeTimeStamp>Mon Sep 30 12:00:24 PM 2013</purgeTimeStamp><purgeType>SCHEDULED</purgeType</purgeConfigStatus>


System Configuration APIsDB Purge Configuration Status

Dialog GroupA dialog group is a pool of dialog channels in which each channel is used to perform dialog interactions witha caller, during which the caller responds to automated prompts by pressing buttons on a touchtone phone.

Data Structure for Dialog GroupDescriptionRestrictionsBase TypeAttribute Name

Numeric identifier of theapplication

Min Value = 0

Max Value = 65535

Multiplicity = Required

intid

Descriptor for the dialog groupMin length = 1

Max length = 80


Dialog Group Descriptioncontains alphanumericcharacters, specialcharacters, spaces,underscores (_), and hyphens(-) without leading or trailingwhite spaces.

stringdialogGroupDesc

Type of the group, correspondingto type of the channels that aremanaged by the group as definedsince CRS 3.0


Enumeration =

• Cisco MediaTermination

• MRCP ASR

stringgroupType

Media termination valueMin length = 1

Max length = 65535


Cisco MediaTermination

Cisco MediaTermination


System Configuration APIsDialog Group


Value for MRCPASRMin length = 1

Max length = 20


Nillable = False

MRCPASR containsalphanumeric characters,special characters, spaces,underscores (_), and hyphens(-) without leading or trailingwhite spaces.

MRCPASRMRCPASR

Get List of Dialog GroupsGETHTTPS Method

https://<server>/adminapi/dialogGroupURI

https://uccx-server/adminapi/dialogGroupExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><dialogGroups><dialogGroup><self>https://uccx-server/adminapi/dialogGroup/0</self><id>0</id><dialogGroupDesc>Default</dialogGroupDesc><groupType>Cisco Media Channel</groupType><CiscoMediaTermination><channels>300</channels></CiscoMediaTermination></dialogGroup><dialogGroup><self>https://uccx-server/adminapi/dialogGroup/1</self><id>1</id><dialogGroupDesc>CMT Auto#8</dialogGroupDesc><groupType>Cisco Media Channel</groupType><CiscoMediaTermination><channels>1</channels></CiscoMediaTermination></dialogGroup></dialogGroups>


System Configuration APIsGet List of Dialog Groups

Get Dialog GroupGETHTTPS Method

https://<server>/adminapi/dialogGroup/<dialog group id>URI

https://uccx-server/adminapi/dialogGroup/1Example URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><dialogGroup><self>https://uccx-server/adminapi/dialogGroup/1</self><id>1</id><dialogGroupDesc>CMT Auto#8</dialogGroupDesc><groupType>Cisco Media Channel</groupType><CiscoMediaTermination><channels>1</channels></CiscoMediaTermination></dialogGroup>

Create Dialog GroupPOSTHTTPS Method


https://uccx-server/adminapi/dialogGroupExample URI




—Error Codes

Success Response


Modify Dialog GroupPUTHTTPS Method


System Configuration APIsGet Dialog Group






—Error Codes

Success Response

HTTPS/1.1 200 OK

Delete Dialog GroupDELETEHTTPS Method

https://<server>/adminapi/dialogGroup/<dialog group id>URI





—Error Codes

Success Response

HTTPS/1.1 200 OK

Email SMTP Server ConfigurationThe Unified CCX system uses the eMail subsystem to communicate with your email server and enable yourapplications to create and send email.


System Configuration APIsDelete Dialog Group

Datastructure for Email SMTP Server ConfigurationDescriptionRestrictionsBase TypeAttribute Name

Email SMTP server addressminOccurs = 1

maxOccurs = 1

Regex:

[A-Za-z0-9_.-\]\+

\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

xs:stringmail_server

Sender address, usually CCXadministrator email address.

minOccurs = 1

maxOccurs = 1

Regex:

([0-9a-zA-Z][-._&])*

[0-9a-zA-Z]@([-0-9a-zA-Z][.])

[a-zA-Z]+

xs:stringemail_address

Get Email SMTP Server ConfigurationGETHTTPS Method

https://<server>/adminapi/emailURI

https://uccx-server/adminapi/emailExample URI

Text/XML, Text/JSONAccept



—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><emailControlGroups>

<emailControlGroup><mail_server>mail.cisco.com</mail_server><email_address>[email protected]</email_address>

</emailControlGroup></emailControlGroups>

Create Email SMTP Server ConfigurationPOSTHTTPS Method


System Configuration APIsDatastructure for Email SMTP Server Configuration

https://<server>/adminapi/emailURI

https://uccx-server/adminapi/emailExample URI

Text/XMLContent Type



—Error Codes

Success Response

https://uccx-server/adminapi/email/0

Modify Email SMTP Server ConfigurationPUTHTTPS Method

https://<server>/adminapi/email/<id>URI

https://uccx-server/adminapi/email/0Example URI




—Error Codes

Success Response

—

Delete Email SMTP Server ConfigurationDELETEHTTPS Method

https://<server>/adminapi/email/<id>URI

https://uccx-server/adminapi/email/0Example URI




—Error Codes


System Configuration APIsModify Email SMTP Server Configuration

Success Response

—

Files (Script, Prompt, Grammar, and Document)Unified CCX applications can make use of many auxiliary files that interact with callers, such as scripts,pre-recorded prompts, grammars, and custom Java classes.

To manage these auxiliary files, you must complete the following tasks:

• Provision telephony and media resources.

• Provision Unified CCX subsystem, if required.

• Provision additional subsystems, if required.

• Configure Cisco script applications.

Depending on your particular Unified CCX implementation, your applications might make use of some or allthe file types. Any file you create needs to be available to the Unified CCX engine before a Unified CCXapplication can use them. This is done through the Unified CCX cluster's Repository datastore, where thescript, prompt, grammar, and document files are created, stored, and updated.

Data Structure for FilesDescriptionRestrictionsBase TypeAttribute Name

Auxiliary files.minOccurs = 1


xs: stringScript | Prompt |

Grammar |Document |

AARDocument

Path of the current item with respect to theroot folder.

minOccurs = 0


xs: stringFolder

File information.minOccurs = 0


xs: stringFile

Details about the language.minOccurs = 0


xs: stringLanguageDetails

Regex:

([^<>%&*| ':?"])+

nillable = falsexs: stringPath


System Configuration APIsFiles (Script, Prompt, Grammar, and Document)


Name of the file.

Regex:

([^<>%&*|':?"])+

nillable = falsexs: stringFileName

minOccurs = 0

maxOccurs = 1

xs: stringDetails

Lets you rename an existing file.minOccurs = 0

maxOccurs = 1

xs: stringReNameTo

minLength = 1

maxLength = 64

xs: stringAARFileName

Regex:

([^<>%&*()|{},/ '+?"])+

nillable = falsexs: stringLanguageName

Regex:

([^<>%&*|/ ':?"])+

nillable = falsexs: stringFolderName

The size of the file prefixed with KB. The filesize is converted from bytes to KB.

nillable = truexs: stringSize

The date and time when the document was lastuploaded or changed along with time zone.

nillable = truexs: stringDateModified

The user ID of the personwho performed thesemodifications.

nillable = truexs: stringmodifiedBy

Create a New Language for PromptPOSTHTTPS Method

https://<server>/adminapi/promptURI

https://uccx-server/adminapi/promptExample URI




—Error Codes

Success Response



System Configuration APIsCreate a New Language for Prompt

Sample Input XML — Create a Language

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Prompt><LanguageDetails><path>/</path><LanguageName>FTCustomPromptLanguage1</LanguageName>

</LanguageDetails></Prompt>

</Files>

Create a New Language for DocumentPOSTHTTPS Method

https://<server>/adminapi/documentURI

https://uccx-server/adminapi/documentExample URI




—Error Codes

Success Response



<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Document><LanguageDetails><path>/</path><LanguageName>FTCustomDocLanguage1</LanguageName>

</LanguageDetails></Document>

</Files>

Create a New Language for GrammarPOSTHTTPS Method

https://<server>/adminapi/grammarURI

https://uccx-server/adminapi/grammarExample URI



System Configuration APIsCreate a New Language for Document



—Error Codes

Success Response



<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Grammar><LanguageDetails><path>/</path><LanguageName>FTCustomGrammarLanguage1</LanguageName>

</LanguageDetails></Grammar>

</Files>

Create a New FolderYou must create a folder to store the files that the Unified CCX system can use.

Create a New Folder for Script

POSTHTTPS Method

https://<server>/adminapi/scriptURI

https://uccx-server/adminapi/scriptExample URI




—Error Codes

Success Response


Sample Input XML — Create a Folder

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Script><Folder><path>/</path>


System Configuration APIsCreate a New Folder

<FolderName>FTCustomScriptF1</FolderName></Folder>

</Script></Files>

Create a New Folder for Prompt

POSTHTTPS Method






—Error Codes

Success Response



<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Prompt><Folder><path>/FTCustomPromptLanguage1</path><FolderName>FTCustomPromptFolder1</FolderName></Folder>

</Prompt></Files>

Create a New Folder for Document

POSTHTTPS Method






—Error Codes


System Configuration APIsCreate a New Folder for Prompt

Success Response



<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Document><Folder><path>/FTCustomDocLanguage1</path><FolderName>FTCustomDocFolder1</FolderName></Folder>

</Document></Files>

Create a New Folder for Grammar

POSTHTTPS Method






—Error Codes

Success Response

HTTPS/1.1 201 No Content


<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Grammar><Folder><path>/FTCustomGrammarLanguage1</path><FolderName>FTCustomGrammarFolder1</FolderName></Folder>

</Grammar></Files>

Upload Files to a Temporary FolderYou must upload the file to a temporary location before storing it in the actual folder path.


System Configuration APIsCreate a New Folder for Grammar

Procedure

Step 1 From the REST API Client, Choose the Content Type as multipart/form-data.Step 2 In the Key-Value pair fields, enter file in the Key field. For the Value field, Click Choose Files to navigate

to the directory that contains the required file.Step 3 Click the Send button to upload the new file to the repository. Display of the Success Code confirms the

successful upload of the files.

If you try to upload invalid files, the upload will be unsuccessful and the Failure Codes will bedisplayed.

Note

Upload Files to a Temporary Folder for Script

POSTHTTPS Method

https://<server>/adminapi/script/uploadFileURI

https://uccx-server/adminapi/script/uploadFileExample URI

multipart/form-dataContent Type



—Error Codes

Success Response


Upload Files to a Temporary Folder for Prompt

POSTHTTPS Method

https://<server>/adminapi/prompt/uploadFileURI

https://uccx-server/adminapi/prompt/uploadFileExample URI




—Error Codes

Success Response



System Configuration APIsUpload Files to a Temporary Folder for Script

Upload Files to a Temporary Folder for Document

POSTHTTPS Method

https://<server>/adminapi/document/uploadFileURI

https://uccx-server/adminapi/document/uploadFileExample URI



401, 405, and 500HTTPS Failure Codes


—Error Codes

Success Response


Upload Files to a Temporary Folder for Grammar

POSTHTTPS Method

https://<server>/adminapi/grammar/uploadFileURI

https://uccx-server/adminapi/grammar/uploadFileExample URI





—Error Codes

Success Response


Store Files in Database from a Temporary folderThe files uploaded in the Temporary location is retrieved and stored in the Folder path specified. The ContentType should be either Application/XML or Application/JSON.

Store Files in Database from a Temporary Folder for Script

POSTHTTPS Method


System Configuration APIsUpload Files to a Temporary Folder for Document







—Error Codes

Success Response


Sample Input XML — Create a Configuration Object for a VXML File

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Script><File><path>/FTCustomScriptFolder/FTCustomScriptFolder1/</path><FileName>FTCustomScript3.vxml</FileName>

</File></Script>

</Files>

Store Files in Database from a Temporary Folder for Prompt

POSTHTTPS Method







—Error Codes

Success Response



System Configuration APIsStore Files in Database from a Temporary Folder for Prompt


<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Prompt><File><path>/FTCustomPromptLanguage1/FTCustomPromptFolder1/</path><FileName>FTCustomPrompt3.vxml</FileName>

</File></Prompt>

</Files>

Store Files in Database from a Temporary Folder for Document

POSTHTTPS Method






—Error Codes

Success Response



<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Document><File><path>/FTCustomDocLanguage1/FTCustomDocFolder1/</path><FileName>FTCustomDoc3.vxml</FileName>

</File></Document>

</Files>

Store Files in Database from a Temporary Folder for Grammar

POSTHTTPS Method





System Configuration APIsStore Files in Database from a Temporary Folder for Document



—Error Codes

Success Response



<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Grammar><File><path>/FTCustomGrammarLanguage1/FTCustomGrammarFolder1/</path><FileName>FTCustomGrammar3.vxml</FileName>

</File></Grammar>

</Files>

Get List for Script Files and FolderGETHTTPS Method






—Error Codes

Success Response

<files><Script><Folder><path>/default/FTCustomScriptF11363861050449/</path><FolderName>FTCustomScriptF11363861050449</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:48:00 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details>

</Folder></Script></files>


System Configuration APIsGet List for Script Files and Folder

Get List for Prompt Files and FolderGETHTTPS Method






—Error Codes

Success Response

<files><Prompt><Folder><path>/en/</path><FolderName>en</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:47:24 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details></Folder></Prompt></files>

Get List for Grammar Files and FolderGETHTTPS Method






—Error Codes

Success Response

<files><Grammar><Folder><path>/en/</path>


System Configuration APIsGet List for Prompt Files and Folder

<FolderName>en</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:47:24 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details></Folder></Grammar></files>

Get List for Document Files and FolderGETHTTPS Method






—Error Codes

Success Response

<Files><Document><Folder><path>/default/FTCustomDocF11363861050449/</path><FolderName>FTCustomScriptF11363861050449</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:48:00 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details>

</Folder></Document></Files>

Get Script Files and FolderGETHTTPS Method

https://<server>/adminapi/script/{FilePath/FolderPath}

FilePath is the fully qualified name of the file. FolderPath isthe fully qualified name of the folder.

Note

URI

https://uccx-server/adminapi/script/FolderPath/

https://uccx-server/adminapi/script/FilePath/

Example URI


System Configuration APIsGet List for Document Files and Folder




—Error Codes

Success Response

<Files><Script><Folder><path>/FolderName//</path><FolderName>SUBFolderName</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:48:01 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details>

</Folder></Script></Files>

Get Prompt Files and FolderGETHTTPS Method

https://<server>/adminapi/prompt/{FilePath/FolderPath}


Note

URI

https://uccx-server/adminapi/prompt/FolderPath/

https://uccx-server/adminapi/prompt/FilePath/

Example URI




—Error Codes

Success Response

<Files><Prompt><Folder><path>/FolderName//</path><FolderName>SUBFolderName</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:48:01 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details>

</Folder>


System Configuration APIsGet Prompt Files and Folder

</Prompt></Files>

Get Grammar Files and FolderGETHTTPS Method

https://<server>/adminapi/grammar/{FilePath/FolderPath}


Note

URI

https://uccx-server/adminapi/grammar/FolderPath/

https://uccx-server/adminapi/grammar/FilePath/

Example URI




—Error Codes

Success Response

<Files><Grammar><Folder><path>/FolderName//</path><FolderName>SUBFolderName</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:48:01 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details>

</Folder></Grammar></Files>

Get Document Files and FolderGETHTTPS Method

https://<server>/adminapi/document/{FilePath/FolderPath}


Note

URI


System Configuration APIsGet Grammar Files and Folder

https://uccx-server/adminapi/document/FolderPath/

https://uccx-server/adminapi/document/FilePath/

Example URI




—Error Codes

Success Response

<Files><Document><Folder><path>/FolderName//</path><FolderName>SUBFolderName</FolderName><Details><size>0 KB</size><dateModified>03/21/2013 03:48:01 PM IndiaStandard Time</dateModified><modifiedBy>Administrator</modifiedBy></Details>

</Folder></Document></Files>

Get FreeSpace and UsedSpace for Script/Prompt/Grammar/DocumentGETHTTPS Method

https://<server>/adminapi/ResourceName}/space/{FolderPath}/

Where "ResourceName" is the "script/prompt/grammar/document" andFolderPath is a fully qualified name of the folder.

URI

https://uccx-server:8080/adminapi/prompt/space/default/

https://uccx-server:8080/adminapi/script/space/default/

https://uccx-server:8080/adminapi/document/space/default/

https://uccx-server:8080/adminapi/grammar/space/default/

Example URI

Application/XMLAccept



—Error Codes


System Configuration APIsGet FreeSpace and UsedSpace for Script/Prompt/Grammar/Document

Success Response

200 OK

Download Script/PromptGETHTTPS Method

https://<server>/adminapi/ResourceName}/download/{FilePath}

Where "ResourceName" is the "script/prompt" and FilePath is a fullyqualified name of the file.

URI

https://uccx-server:8080/adminapi/prompt/download/default/beep.wav

https://uccx-server:8080/adminapi/script/download/default/icd_brkpt.aef

Example URI




—Error Codes

Success Response

200 OK

Modify Script Folder NamePUTHTTPS Method

https://<server>/adminapi/script/FolderPathURI

https://uccx-server/adminapi/script/folder/Example URI




—Error Codes

Success Response

—

Modify FilePUTHTTPS Method


System Configuration APIsDownload Script/Prompt

https://<server>/adminapi/{ResourceName}/FilePathURI

https://uccx-server/adminapi/{ResourceName}/CustomScript1.aef

ResourceName can be script, prompt, grammar, or document.Note

Example URI




—Error Codes

Success Response

—

Sample Input XML — Modifying a Script File Name

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="../adminapi/src/main/resources/xsd/Files.xsd"><Script><File><path>/</path><FileName>CustomScript1.aef</FileName><reNameTo>CustomScript1Mod.aef</reNameTo>

</File></Script>

</Files>

Sample Input XML — Refreshing a Script File Content

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="../adminapi/src/main/resources/xsd/Files.xsd"><Script><File><path>/</path><FileName>CustomScript1.aef</FileName><refresh>true</refresh>

</File></Script>

</Files>

If you want to upload the modified script file, upload the file first and use PUT operation to store the uploadedscript. If the refresh attribute is set to true, application immediately uses the uploaded script.

Note

Modify Prompt Folder Name or Language NamePUTHTTPS Method


System Configuration APIsModify Prompt Folder Name or Language Name

https://<server>/adminapi/prompt/FolderPath

https://<server>/adminapi/prompt/LanguagePath

URI

https://uccx-server/adminapi/prompt/language/

https://uccx-server/adminapi/prompt/folder/

Example URI




—Error Codes

Success Response

—

Sample Input XML — Modifying a Folder

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd">

<Prompt><Folder><path>/PrmoptLanguage1</path><FolderName>PrmoptFolder1</FolderName><reNameTo>ModPrmoptFolder1</reNameTo>

</Folder></Prompt>

</Files>

Modify Grammar Folder Name or Language NamePUTHTTPS Method

https://<server>/adminapi/grammar/FolderPath

https://<server>/adminapi/grammar/LanguagePath

URI

https://uccx-server/adminapi/grammar/language/

https://uccx-server/adminapi/grammar/folder/

Example URI




—Error Codes


System Configuration APIsModify Grammar Folder Name or Language Name

Success Response

—

Sample Input XML — Renaming the Language

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Grammar><LanguageDetails><path>/</path><LanguageName>FTCustomDocLanguage1</LanguageName><reNameTo>FTCustomModDocLanguage1</reNameTo>

</LanguageDetails></Grammar>

</Files>

Sample Input XML — Renaming the Folder

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Grammar><Folder><path>/FTCustomModDocLanguage1</path><FolderName>FTCustomDocumentFolder1</FolderName><reNameTo>FTCustomModDocumentFolder1</reNameTo>

</Folder></Grammar>

</Files>

Modify Document Folder Name or Language NamePUTHTTPS Method

https://<server>/adminapi/document/FolderPath

https://<server>/adminapi/document/LanguagePath

URI

https://uccx-server/adminapi/document/language/

https://uccx-server/adminapi/document/folder/

Example URI




—Error Codes

Success Response

—


System Configuration APIsModify Document Folder Name or Language Name

Sample Input XML — Renaming the Language

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Document><LanguageDetails><path>/</path><LanguageName>FTCustomDocLanguage1</LanguageName><reNameTo>FTCustomModDocLanguage1</reNameTo>

</LanguageDetails></Document>

</Files>

Sample Input XML — Renaming the Folder

<?xml version="1.0" encoding="UTF-8"?><Files xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="Files.xsd"><Document><Folder><path>/FTCustomModDocLanguage1</path><FolderName>FTCustomDocumentFolder1</FolderName><reNameTo>FTCustomModDocumentFolder1</reNameTo>

</Folder></Document>

</Files>

Delete Script Files and FolderDELETEHTTPS Method

https://<server>/adminapi/script/{File/FolderPath}URI

https://uccx-server/adminapi/script/folder/

https://uccx-server/adminapi/script/folder/Test.aef

Example URI




—Error Codes

Success Response

—

Delete Prompt Files and FolderDELETEHTTPS Method

https://<server>/adminapi/prompt/{File/FolderPath}URI


System Configuration APIsDelete Script Files and Folder

https://uccx-server/adminapi/prompt/folder/

https://uccx-server/adminapi/prompt/folder/Test.wav

Example URI




—Error Codes

Success Response

—

Delete Grammar Files and FolderDELETEHTTPS Method

https://<server>/adminapi/grammar/{File/FolderPath}URI

https://uccx-server/adminapi/grammar/folder/

https://uccx-server/adminapi/grammar/folder/Test.grxml

Example URI




—Error Codes

Success Response

—

Delete Document Files and FolderDELETEHTTPS Method

https://<server>/adminapi/document/{File/FolderPath}URI

https://uccx-server/adminapi/document/folder/

https://uccx-server/adminapi/document/Test.vxml

Example URI





System Configuration APIsDelete Grammar Files and Folder

—Error Codes

Success Response

—

HTTPS TriggerAn HTTPS trigger is the relative URL a user enters into the client browser to start the application. You canupload either eXtensible Style Language Transformation (XSLT) templates or Java Server Pages (JSP)templates to serve as your HTTPS trigger.

Data Structure for HTTPS TriggerDescriptionRestrictionsBase TypeAttribute Name

Name of the HTTPS TriggerMin length = 2

Max length = 45

HTTPS Trigger name startswith / character and containsalphanumeric and specialcharacters such as-#%&=.\?/ characterswithout leading and trailingwhite-space characters.

stringname

Name of applicationnillable = false

minOccurs = 1

minOccurs = 1

nameUriPairapplication

Maximum number of sessionsnillable = false

minOccurs = 1

minOccurs = 1

baseIdIntmaxSessions

Idle timeout valuenillable = false

minOccurs = 0

minOccurs = 1

default = 1000

idleTimeoutidleTimeout


System Configuration APIsHTTPS Trigger


Defines the localeMin length = 1

Max length = 50

Locale containsalphanumeric characters,special characters, spaces,underscores (_), and hyphens(-) without leading or trailingwhite spaces.

stringlocale

Indicates if the HTTPS Triggeris enabled

default = truebooleanenabled

Sample Input XML

<?xml version="1.0" encoding="UTF-8"?><httpTrigger><self>URL</self><name>/test</name><application name="app1"><refURL>URL</refURL></application><maxSessions>1</maxSessions><idleTimeout>1000</idleTimeout><locale>en_US</locale><enabled>true</enabled></httpTrigger>

Get List of HTTPS TriggersGETHTTPS Method

https://<server>/adminapi/httpTriggerURI

https://uccx-server/adminapi/httpTriggerExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><httpTriggers><httpTrigger><self>https://uccx-server/adminapi/httpTrigger/redirect_Cisco</self><name>/redirect_Cisco</name><application name="Auto_App_HTTP">


System Configuration APIsGet List of HTTPS Triggers

<refURL>https://uccx-server/adminapi/application/Auto_App_HTTP</refURL></application><maxSessions>10</maxSessions><idleTimeout>2000</idleTimeout><locale>en_US</locale><enabled>true</enabled></httpTrigger><httpTrigger><self>https://uccx-server/adminapi/httpTrigger/Trigger1355924928134</self><name>/Trigger1355924928134</name><application name="ForHttpTriggerFT"><refURL>https://uccx-server/adminapi/application/ForHttpTriggerFT</refURL></application><maxSessions>1</maxSessions><idleTimeout>1</idleTimeout><locale>en_US</locale><enabled>true</enabled></httpTrigger><httpTrigger><self>https://uccx-server/adminapi/httpTrigger/Trigger</self><name>/Trigger</name><application name="ForHttpTriggerFT"><refURL>https://uccx-server/adminapi/application/ForHttpTriggerFT</refURL></application><maxSessions>1</maxSessions><idleTimeout>1</idleTimeout><locale>en_US</locale><enabled>true</enabled></httpTrigger><httpTrigger><self>https://uccx-server/adminapi/httpTrigger/Trigger1355924936759</self><name>/Trigger1355924936759</name><application name="ForHttpTriggerFT"><refURL>https://uccx-server/adminapi/application/ForHttpTriggerFT</refURL></application><maxSessions>15</maxSessions><idleTimeout>1500</idleTimeout><locale>en</locale><enabled>false</enabled></httpTrigger></httpTriggers>

Get HTTPS TriggerGETHTTPS Method

https://<server>/adminapi/httpTrigger/{httpTriggerName}URI





—Error Codes


System Configuration APIsGet HTTPS Trigger

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><httpTrigger><self>https://uccx-server/adminapi/httpTrigger/redirect_Cisco</self><name>/redirect_Cisco</name><application name="Auto_App_HTTP"><refURL>https://uccx-server/adminapi/application/Auto_App_HTTP</refURL></application><maxSessions>10</maxSessions><idleTimeout>2000</idleTimeout><locale>en_US</locale><enabled>true</enabled></httpTrigger>

Create HTTPS TriggerPOSTHTTPS Method

https://<server>/adminapi/httpTriggerURI





—Error Codes

Success Response


Modify HTTPS TriggerPUTHTTPS Method


https://uccx-server/adminapi/httpTrigger/TestHttpTriggerExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsCreate HTTPS Trigger

Delete HTTPS TriggerDELETEHTTPS Method


https://uccx-server/adminapi/httpTrigger/TestHttpTriggerExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Outbound General ConfigurationGeneral configuration for Outbound refers to the settings information that is common for all the campaigns.

Data Structure for Outbound General ConfigurationDescriptionRestrictionsBase TypeAttribute Name

Outbound campaign start time.minOccurs = 1

maxOccurs = 1

Regex:

([01]?[0-9]|2[0-3]):[0-5]\d

timeTypeOB,

string

startTime

Outbound campaign end time.minOccurs = 1

maxOccurs = 1

Regex:

([01]?[0-9]|2[0-3]):[0-5]\d

timeTypeOB,

string

endTime

Timeout duration for an agent torespond to the Outbound call.

minOccurs = 1

maxOccurs = 1

minInclusive = 5

maxInclusive = 3600

intcallTimeout


System Configuration APIsDelete HTTPS Trigger


Number to prefix to the phone numberfor dialing outgoing calls.

minOccurs = 0

maxOccurs = 1

default = ""

minLength = 0

maxLength = 5

The dialing prefix can have4 digits with plus (+) prefixor 5 digits without plus (+)prefix.

stringdialingPrefix

Number to prefix to the phone numberfor dialing long distance.

minOccurs = 0

maxOccurs = 1

default = ""

minLength = 0

maxLength = 5

The long distance prefix can4 digits with plus (+) prefixor 5 digits without plus (+)prefix.

stringlongDistancePrefix

Number to prefix to the internationalphone numbers.

minOccurs = 0

maxOccurs = 1

default = ""

minLength = 0

maxLength = 5

The international prefix canto 4 digits with plus (+)prefix or 5 digits withoutplus (+) prefix.

stringinternationalPrefix

Area code of the Unified CCX serverlocation.

minOccurs = 0

maxOccurs = 1

default = ""

minLength = 0

maxLength = 10

The local area code can have9 digits with plus (+) prefixor 10 digits without plus (+)prefix.

stringlocalAreaCode


System Configuration APIsData Structure for Outbound General Configuration


Local area code to be included whenyou are dialing the phone numbers.

minOccurs = 0

maxOccurs = 1

default = false

booleanincludeLocalAreaCode

Number to prefix to the local andnon-local phone numbers for dialinglong distance.

minOccurs = 0

maxOccurs = 1

default = false

booleanincludeLongDistancePrefix

Unified CCX automatically answersany predictive or progressive campaigncall that gets transferred to the agent.

minOccurs = 0

maxOccurs = 1

default = true

booleanagentAutoAnswer

CSQs that are used by the Outboundsystem.

minOccurs = 0

maxOccurs = 1

csqListOB,

int

assignedCSQs

CSQs that are assigned for theOutbound campaign with thecorresponding percentage allocation.

minOccurs = 0


csqDetailsOB,

int

csq

CSQs that are assigned for theOutbound campaigns.

—nameUriPaircsqNameUriPair

The percentage of logged in agents ineach of the selected CSQs that areallocated for handling the Outboundcalls.

minInclusive = 1

maxInclusive = 100

intpercentage

Get List of Skills for Outbound General ConfigurationGETHTTPS Method

https://<server>/adminapi/generalobconfigURI

https://uccx-server/adminapi/generalobconfigExample URI




—Error Codes


System Configuration APIsGet List of Skills for Outbound General Configuration

Success Response

<?xml version="1.0" encoding="UTF-8"?><generalobconfig xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="../../../../main/resources/xsd/generalobconfig.xsd"><startTime>08:00</startTime><endTime>21:00</endTime><callTimeout>10</callTimeout><dialingPrefix>1</dialingPrefix><longDistancePrefix>2</longDistancePrefix><internationalPrefix>1</internationalPrefix><localAreaCode>21</localAreaCode><includeLocalAreaCode>false</includeLocalAreaCode><includeLongDistancePrefix>false</includeLongDistancePrefix><assignedCSQs><csq><csqNameUriPair name="csq1"><refURL> https://uccx-server/adminapi/csq/1</refURL></csqNameUriPair><percentage>10</percentage></csq></assignedCSQs></generalobconfig>

Modify Outbound General ConfigurationPUTHTTPS Method

https://<server>/adminapi/generalobconfigURI

https://uccx-server/adminapi/generalobconfigExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsModify Outbound General Configuration

System Configuration

Data Structure for System ConfigurationDescriptionRestrictionsBase

TypeAttribute Name

notReadyOnSecondaryEnabled:Determines the agent's state change toNot Ready state when the monitoredNon ICD lines are used for Incomingor Outgoing calls.

minOccurs = 0

maxOccurs = 1

nillable = false

booleannotReadyOnSecondaryEnabled

Get System ConfigurationGETHTTPS Method

https://<server>/adminapi/systemConfigURI

https://uccx-Server/adminapi/systemConfigExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><systemConfig>

<appConfig><notReadyOnSecondaryEnabled>false</notReadyOnSecondaryEnabled>

</appConfig></systemConfig>

Update System ConfigurationPUTHTTPS Method

https://<server>/adminapi/systemConfigURI

https://uccx-Server/adminapi/systemConfigExample URI




System Configuration APIsSystem Configuration


—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML — Modify Proxy Configuration (PUT)

<?xml version="1.0" encoding="UTF-8"?><systemConfig>

<appConfig><notReadyOnSecondaryEnabled>false</notReadyOnSecondaryEnabled>

</appConfig></systemConfig>

Proxy Configuration

Data Structure for Proxy ConfigurationDescriptionRestrictionsBase TypeAttribute Name

• hostName: Fully qualifieddomain name (FQDN) of theHTTPS proxy server.

• port: Port number that is used toconnect to the HTTPS proxyserver.

Host Name cannot be the IPaddress of the proxy Server.

Range: 1 to 65535

stringhttpProxy

• hostName: Fully qualifieddomain name (FQDN) of theSOCKS proxy server.

• port: Port number that is used toconnect to the SOCKS proxyserver.

• userName: Username of theSocks Proxy server.

• password: Password for the SocksProxy server

Host Name cannot be the IPaddress of the proxy Server.

Range: 1 to 65535

stringsocksProxy

Get Proxy ConfigurationGETHTTPS Method


System Configuration APIsProxy Configuration

https://<server>/adminapi/proxyConfigURI

https://uccx-Server/adminapi/proxyConfigExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><proxyConfig><httpProxy><hostName>proxy.esl.cisco.com</hostName><port>80</port></httpProxy><socksProxy><hostName>socks.proxy.com</hostName><Port>1080</Port><userName>Administrator</userName><password>12Ccbu12</password></socksProxy></proxyConfig>

Update Proxy ConfigurationPUTHTTPS Method

https://<server>/adminapi/proxyConfigURI

https://uccx-Server/adminapi/proxyConfigExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsUpdate Proxy Configuration

Sample Input XML — Modify Proxy Configuration (PUT)

<?xml version="1.0" encoding="UTF-8"?><proxyConfig><httpProxy><hostName>proxy.esl.cisco.com</hostName><port>80<port></httpProxy><socksProxy><hostName>socks.proxy.com</hostName><Port>1080</Port><userName>Administrator</userName><password>12Ccbu12</password></socksProxy></proxyConfig>

Recording ConfigurationConfigures the recording server.

Data Structure for Recording ConfigurationDescriptionRestrictionsBase TypeAttribute Name

FullyQualifiedDomainName (FQDN)of host1.

minOccurs = 1

maxOccurs = 1

stringhost1

FullyQualifiedDomainName of host2.minOccurs = 0

maxOccurs = 1

stringhost2

User name must be a MediaSense APIuser. API user name is a Unified CMend user, who is configured in CiscoMediaSense as aMediaSense API user.

minOccurs = 1

maxOccurs = 1

minLength = 1

maxLength = 128

stringuserName

Password to connect to the RecordingServer.

API does not accept theblank password for the firsttime. Sending blankpassword the next time,retains the previouspassword.

Note

minOccurs = 1

maxOccurs = 1

maxLength = 127

stringpassword

Get Recording Configuration InformationGETHTTPS Method


System Configuration APIsRecording Configuration

https://<server>/adminapi/recordingConfigurationURI

https://<server>/adminapi/recordingConfigurationExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?>

<recordingConfiguration><host1>host1.cisco.com</host1><host2>host2.cisco.com</host2><userName>admin</userName><password></password>

</recordingConfiguration>

Modify Recording Configuration InformationPUTHTTPS Method

https://<server>/adminapi/recordingConfigurationURI

https://<server>/adminapi/recordingConfigurationExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML — Modify Recording Configuration Information (PUT)

<?xml version="1.0" encoding="UTF-8"?><recordingConfiguration xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="recordingConfiguration.xsd"><self>self</self><host1>host1.cisco.com</host1><host2>host2.cisco.com</host2><userName>userName</userName>


System Configuration APIsModify Recording Configuration Information

<password>password</password></recordingConfiguration>

ResourceThe Unified CCX system creates a new record in the Resource table when the Unified CCX system retrievesagent information from the Unified CM. A Resource record contains information about the resource (agent).One such record exists for each active and inactive resource.

Data Structure for ResourceDescriptionRestrictionsBase TypeAttribute Name

Numeric identifier of the resourceminOccurs = 1

maxOccurs = 1

nillable = false

intresourceId

Numeric identifier of userminOccurs = 1

maxOccurs = 1

nillable = false

stringuserID

Full name of the userminOccurs = 1

maxOccurs = 1

nillable = false

stringfullName

Last name of the userminOccurs = 1

maxOccurs = 1

nillable = false

stringlastName


System Configuration APIsResource


Alias name of agent is displayedto the customer when on chat.

minOccurs = 0

maxOccurs = 1

nillable = false

minLength = 0

maxLength = 31

Alias contains alphanumericcharacters and the specialcharacters hyphens (-),space ( ), periods (.), andunderscores (_), except atthe beginning and at the endof the alias name.

stringalias

Extension of the userminOccurs = 1

maxOccurs = 1

nillable = false

stringextension

Group of the resourceminOccurs = 1

maxOccurs = 1

nillable = true

nameUriPairresourceGroup

Mapping of skills of the resourceminOccurs = 1

maxOccurs = 1

nillable = false

skillMapskillMap

Availability of resource—booleanautoAvailable

Type of resourceminOccurs = 1

maxOccurs = 1

nillable = false

resourceTypetype

Name of the teamminOccurs = 1

maxOccurs = 1

nillable = false

nameUriPairteam

Primary supervisorminOccurs = 1

maxOccurs = 1

nillable = true

supervisorOfprimarySupervisorOf


System Configuration APIsData Structure for Resource


Secondary supervisorminOccurs = 1

maxOccurs = 1

nillable = true

supervisorOfsecondarySupervisorOf

Get List of Resourceshttps://<server>/adminapi/resourceURI

https://uccx-server/adminapi/resourceExample URI

GETHTTPS Method




—Error Codes

Success Response

The response depends on the credentials provided. The following are the use cases that are observed whenthis API is invoked:

• When an administrator gets the list of resources, the response has the complete list of agents.

• When a supervisor gets the list of resources, the response has the list of agents corresponding to the teamof the supervisor. The supervisor can be either a primary or secondary supervisor.

• The query parameter combination of withCsqs and detail=none is invalid.

Note

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><resources><resource><self>https://uccx-server/adminapi/resource/agent1333</self><userID>agent1333</userID><firstName></firstName><lastName>agent1333</lastName><extension>2244333</extension><alias>uccx</alias><skillMap><skillCompetency><competencelevel>5</competencelevel><skillNameUriPair name="OBAgentSkill"><refURL>https://uccx-server/adminapi/skill/3</refURL>

</skillNameUriPair></skillCompetency>

</skillMap>


System Configuration APIsGet List of Resources

<autoAvailable>true</autoAvailable><type>1</type><team name="Default"><refURL>https://uccx-server/adminapi/team/1</refURL></team><primarySupervisorOf/><secondarySupervisorOf/>

</resource></resources>

Get List of Resources by CSQhttps://<server>/adminapi/resource?csqid={id}URI

https://<server>/adminapi/resource?csqid=1Example URI

GETHTTPS Method




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"

standalone="yes"?><resources>

<resource>

<self>https://10.78.95.167/adminapi/resource/agent8000<

/self><userID>agent8000</userID><firstName></firstName><lastName>agent8000</lastName><extension>8000</extension><alias>AgentAlias</alias><resourceGroup name="Auto_Sanity_RG">

<refURL>https://10.78.95.167/adminapi/resourceGroup/2</refURL>

</resourceGroup><autoAvailable>true</autoAvailable><type>1</type><team name="Auto_Team">

<refURL>https://10.78.95.167/adminapi/team/2</refURL></team><primarySupervisorOf/><secondarySupervisorOf/>

</resource></resources>


System Configuration APIsGet List of Resources by CSQ

Get Resource with CSQsGETHTTPS Method

https://<server>/adminapi/resource?withCsqs

https://<server>/adminapi/resource?csqid={id}&withCsqs

https://<server>/adminapi/resource/{id}?withCsqs

URI

https://uccx-server/adminapi/resource?withCsqs

https://uccx-server/adminapi/resource?csqid=1&withCsqs

https://uccx-server/adminapi/resource/1?withCsqs

Example URI



400, 401, 403, 404, 405, 500, 503HTTPS Failure Codes

—Error Codes

Success Response

<resource><self>

https://10.78.92.103/adminapi/resource/rick</self><userID>

rick</userID><firstName>

Rick</firstName><lastName>

Barrows</lastName><extension>

1009</extension><alias></alias><resourceGroup name="RG1">

<refURL>https://10.78.92.103/adminapi/resourceGroup/2

</refURL></resourceGroup><skillMap>

<skillCompetency><competencelevel>

5</competencelevel><skillNameUriPair name="SalesSkill">

<refURL>https://10.78.92.103/adminapi/skill/2

</refURL></skillNameUriPair>

</skillCompetency></skillMap>


System Configuration APIsGet Resource with CSQs

<csqMap><csq name="VoiceCSQ1"><refURL>

https://10.78.92.103/adminapi/csq/1</refURL></csq><csq name="ChatCSQ1"><refURL>

https://10.78.92.103/adminapi/csq/2</refURL></csq></csqMap><autoAvailable>

true</autoAvailable><type>

2</type><team name="Default">

<refURL>https://10.78.92.103/adminapi/team/1

</refURL></team><primarySupervisorOf>

<supervisorOfTeamName name="Team2"><refURL>

https://10.78.92.103/adminapi/team/34</refURL>

</supervisorOfTeamName><supervisorOfTeamName name="Team1">

<refURL>https://10.78.92.103/adminapi/team/32

</refURL></supervisorOfTeamName>

</primarySupervisorOf><secondarySupervisorOf/>

</resource>

Get Modified Information of Resources by CSQGETHTTPS Method

https://<server>/adminapi/resource?csqid={Id}&lastReSkillDetailsURI

https://<server>/adminapi/resource?csqid=2&lastReSkillDetailsExample URI




—Error Codes

Success Response

https://<server fqdn>:/adminapi/resource?csqid=&lastReSkillDetails


System Configuration APIsGet Modified Information of Resources by CSQ

Sample output XML—GET

Invoked by Supervisor<resource>....<lastReSkillDetails>

<timestamp>1516593630</timestamp><reskiller>Rick Barrows</reskiller><reskillerType>Supervisor</reskillerType></lastReSkillDetails>

</resource>

Invoked by Admin<resource>....<lastReSkillDetails>

<timestamp>1516593630</timestamp><reskiller>Admin</reskiller><reskillerType>Administrator</reskillerType>

</lastReSkillDetails></resource>

PUT, POST, and DELETE methods are not supported. Corresponding error response will be returned.Note

Get Resourcehttps://<server>/adminapi/resource/{id}URI

https://uccx-server/adminapi/resource/12Example URI

GETHTTPS Method




—Error Codes

The ID in the URI is the user ID of a particular resource. The resource in the Unified CommunicationsManagerenvironment is an end user. The user ID in Unified CCX can include all the special characters except theforward slash (/) and the backslash (\).

Note

Success Response

<resource><self>https://uccx-server/adminapi/resource/uccxautosup1</self>


System Configuration APIsGet Resource

<userID>uccxautosup1</userID><firstName /><lastName>uccxautosup1</lastName><extension>6003</extension><skillMap /><autoAvailable>true</autoAvailable><type>2</type><team name="Team123"><refURL>https://uccx-server/adminapi/team/1</refURL></team><primarySupervisorOf><supervisorOfTeamName name="Team123"><refURL>https://uccx-server/adminapi/team/1</refURL></supervisorOfTeamName><supervisorOfTeamName name="tempteam1"><refURL>https://uccx-server/adminapi/team/3</refURL></supervisorOfTeamName><supervisorOfTeamName name="tempteam3"><refURL>https://uccx-server/adminapi/team/5</refURL></supervisorOfTeamName><supervisorOfTeamName name="chatTeamchatTeamchatTeamchatTeam"><refURL>https://uccx-server/adminapi/team/7</refURL></supervisorOfTeamName><supervisorOfTeamName name="TeamTest1213497663301901355924770962"><refURL>https://uccx-server/adminapi/team/9</refURL></supervisorOfTeamName><supervisorOfTeamName name="TeamTest1213497663301901355924777915"><refURL>https://uccx-server/adminapi/team/10</refURL></supervisorOfTeamName><supervisorOfTeamName name="Team123"><refURL>https://uccx-server/adminapi/team/11</refURL></supervisorOfTeamName></primarySupervisorOf><secondarySupervisorOf><supervisorOfTeamName name="tempteam2"><refURL>https://uccx-server/adminapi/team/4</refURL></supervisorOfTeamName><supervisorOfTeamName name="tempteam4"><refURL>https://uccx-server/adminapi/team/6</refURL></supervisorOfTeamName></secondarySupervisorOf></resource>

Modify Resourcehttps://<server>/adminapi/resource/{id}URI

https://uccx-server/adminapi/resource/{id}Example URI

PUTHTTPS Method




—Error Codes


System Configuration APIsModify Resource

The ID in the URI is the user ID of a particular resource. The resource in the Unified CommunicationsManagerenvironment is an end user. The user ID in Unified CCX can include all the special characters except theforward slash (/) and the backslash (\).

Note

Success Response

—

Resource GroupResource groups are collections of agents that the CSQ uses to handle incoming calls. To useresource-group-based CSQs, you must specify a resource group.

Data Structure for Resource GroupDescriptionsRestrictionsBase TypeAttribute Name

Unique identifier for the resourcegroup.

Noneintid

Name of the resource group as set upin Unified CCX administration.

minLength value = 1


Occurences = 1

Resource Group name containsalphanumeric characters,spaces, underscores (_), andhyphens (-) without leading ortrailing white spaces.

stringname

Get List of Resource GroupsGETHTTPS Method

https://<server>/adminapi/resourceGroupURI

https://uccx-server/adminapi/resourceGroupExample URI




—Error Codes


System Configuration APIsResource Group

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><resourceGroups><resourceGroup><self>https://uccx-server/adminapi/resourceGroup/4</self><id>4</id><name>Auto_RG</name></resourceGroup><resourceGroup><self>https://uccx-server/adminapi/resourceGroup/7</self><id>7</id><name>rg1</name></resourceGroup></resourceGroups>

Get Resource GroupGETHTTPS Method

https://<server>/adminapi/resourceGroup/{id}URI

https://uccx-server/adminapi/resourceGroup/22Example URI





Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><resourceGroup><self>https://uccx-server/adminapi/resourceGroup/7</self><id>7</id><name>rg1</name></resourceGroup>>

Create Resource GroupPOSTHTTPS Method

https://<server>/adminapi/resourceGroupURI

https://uccx-server/adminapi/resourceGroupExample URI






System Configuration APIsGet Resource Group

Success Response


Sample Input XML—Create Resource Group (POST)

<?xml version="1.0" encoding="UTF-8"?><ResourceGroup>

<self/><name>Group-02</name>

</ResourceGroup>

Modify Resource GroupPUTHTTPS Method







Success Response

HTTPS/1.1 200 OK

Sample Input XML—Modify ResourceGroup (PUT)

<?xml version="1.0" encoding="UTF-8"?><ResourceGroup><self>https://uccx-server/adminapi/resourceGroup/</self><id>3</id><name>Group-01</name>

</ResourceGroup>

Delete Resource GroupDELETEHTTPS Method





System Configuration APIsModify Resource Group




Success Response

HTTPS/1.1 200 OK

SkillSkills are customer-definable labels that are assigned to agents. All the Unified CCX license packages canroute incoming calls to agents who have the necessary skills or sets of skills to handle the call.

Data Structure for SkillDescriptionRestrictionsBase TypeAttribute Name

Numeric identifier of the skillNoneintskillId

Name of the skillminlength = 1

maxlength = 24

occurrences = 1

Skill Name containsalphanumericcharacters, specialcharacters, spaces,underscores (_), andhyphens (-) withoutleading or trailing whitespaces.

stringskillName

Get List of Skills

The maximum number of skills is 150.Note

GETHTTPS Method

https://<server>/adminapi/skillURI

https://uccx-server/adminapi/skillExample URI



System Configuration APIsSkill



—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><Skills>

<Skill><self>https://uccx-server/adminapi/skill/2</self><skillId>2</skillId><skillName>Auto_Sanity_Skill</skillName>

</Skill><Skill>

<self>https://uccx-server/adminapi/skill/3</self><skillId>3</skillId><skillName>icd</skillName>

</Skill></Skills>

Get SkillGETHTTPS Method

https://<server>/adminapi/skill/{id}URI

https://uccx-server/adminapi/skill/12Example URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><Skill>

<self>https://uccx-server/adminapi/skill/12</self><skillId>12</skillId><skillName>Auto_Sanity_Skill</skillName>

</Skill>

Create SkillUsing this API, you can assign customer-definable label to an agent.

POSTHTTPS Method

https://<server>/adminapi/skillURI


System Configuration APIsGet Skill

https://uccx-server/adminapi/skillExample URI




—Error Codes

Success Response


Sample Input XML—Create Skill (POST)

<Skill><self href="https://uccx-server/adminapi/skill/1" rel="self" type="skill"/><skillId>1</skillId><skillName>skill1</skillName></Skill>

Modify SkillPUTHTTPS Method

https://<server>/adminapi/skill/{id}URI





—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML—Modify Skill (PUT)

<Skill><self href="https://uccx-server/adminapi/skill/1" rel="self" type="skill"/><skillId>1</skillId><skillName>skillNewName</skillName></Skill>


System Configuration APIsModify Skill

Delete SkillWhen you delete a skill:

• the skill is removed automatically.

• If the skill is associated with any agents or CSQs, you are directed to another web page where you cansee a list of the associated CSQs and agents, and you are prompted to confirm whether you want to deleteit or not.

DELETEHTTPS Method

https://<server>/adminapi/skill{skillId}URI





—Error Codes

Success Response

HTTPS/1.1 200 OK

Sip Gateway ConfigurationSIP Gateways provide media termination and signal translation between the PSTN and the IP networks usingthe SIP signaling protocol for voice and video traffic. You can add or modify the SIP Gateway parametersusing REST API that enable the Outbound subsystem of the Unified CCX to communicate with the SIPgateway.

Call Progress Analysis is a feature of the SIP gateway which determines whether the reached end point is ananswering machine, live voice, fax, or beep tone and so on. The SIP gateway performs call progressive analysisof the call and informs the outcome of the call to the Unified CCX


System Configuration APIsDelete Skill

Data Structure for Sip Gateway ConfigurationsDescriptionRestrictionsBase TypeAttribute Name

IP Address or hostname of theSIP Gateway.

The IP addressvalidation for thevalid range and thehost name validationfor the existence of atleast one alphabeticcharacter is doneusing Java code.

Note

Regex:

(([a-zA-Z0-9]|[a-zA-Z0-9]

[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])

(\.([a-zA-Z0-9]|[a-zA-Z0-9]

[a-zA-Z0-9-]{0,61}[a-zA-Z0-9]))*)

stringIpAddressorHostName

SIP port used by the gateway tocommunicatewithUnified CCX.

minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1


intGatewayPort

Port number used on the UnifiedCCX server to communicatewith the gateway.

minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1025


minInclusive = 61001


intLocalCCXPort

Protocol required to send SIPmessages.

default = UDPstringtransportProtocol

CPA analysis period.minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1000


intCpaAnalysisPeriod

Minimum silence period.minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 100

maxInclusive = 1000

intCpaMinSilencePeriod


System Configuration APIsData Structure for Sip Gateway Configurations


Maximum time analysis period.minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1000


intCpaMaxTimeAnalysis

Minimum valid speech time.minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 50

maxInclusive = 500

intCpaMinValidSpeechTime

Maximum term tone analysisperiod.

minOccurs = 1

maxOccurs = 1

nillable = false

minInclusive = 1000


intCpaMaxTermToneAnalysis

Get List of Sip Gateway ConfigurationsGETHTTPS Method

https://<server>/adminapi/obsipgatewayconfigurationURI

https://uccx-server/adminapi/obsipgatewayconfigurationExample URI




—Error Codes


System Configuration APIsGet List of Sip Gateway Configurations

Success Response

<?xml version="1.0" encoding="UTF-8"?><obSipGatewayConfiguration><IpAddressorHostName>uccx-server</IpAddressorHostName><GatewayPort>1024</GatewayPort><LocalCCXPort>5678</LocalCCXPort><transportProtocol>UDP</transportProtocol><CpaMinSilencePeriod>1000</CpaMinSilencePeriod><CpaAnalysisPeriod>2010</CpaAnalysisPeriod><CpaMaxTimeAnalysis>3000</CpaMaxTimeAnalysis><CpaMinValidSpeechTime>112</CpaMinValidSpeechTime><CpaMaxTermToneAnalysis>15000</CpaMaxTermToneAnalysis></obSipGatewayConfiguration>

Update SIP Gateway ConfigurationsPUTHTTPS Method

https://<server>/adminapi/obsipgatewayconfigurationURI

https:/uccx-server/adminapi/obsipgatewayconfigurationExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Sample Input XML — Modify SIP Gateway Configuration (PUT)

<?xml version="1.0" encoding="UTF-8"?><obSipGatewayConfiguration><IpAddressorHostName>uccx-server</IpAddressorHostName><GatewayPort>1024</GatewayPort><LocalCCXPort>5678</LocalCCXPort><transportProtocol>UDP</transportProtocol><CpaMinSilencePeriod>1000</CpaMinSilencePeriod><CpaAnalysisPeriod>2010</CpaAnalysisPeriod><CpaMaxTimeAnalysis>3000</CpaMaxTimeAnalysis><CpaMinValidSpeechTime>112</CpaMinValidSpeechTime><CpaMaxTermToneAnalysis>15000</CpaMaxTermToneAnalysis></obSipGatewayConfiguration>

Standalone Cisco Unified Intelligence CenterUnified CCX 11.0(1) provides support for a standalone Cisco Unified Intelligence Center system in additionto the on-box Cisco Unified Intelligence Center.


System Configuration APIsUpdate SIP Gateway Configurations

A standalone Unified Intelligence Center can be installed with standard, enhanced and premium licenses. Theversion of the standalone Cisco Unified Intelligence Center should be the same as the Cisco Unified IntelligenceCenter that is embedded in Unified CCX. The standalone Cisco Unified Intelligence Center supports multipledata source including Unified CCX.

Data Structure for Standalone CUICDescriptionRestrictionsBase TypeAttribute Name

Fully Qualified Domain Nameof the standalone CUIC server.

Regex :

[A-Za-z0-9]([A-Z0-9a-z_\-\.])+[a-z]{2}

minLength = 1

maxLength = 255

stringFQDN

Datasource name to which theCUIC server is pointing.

minLength = 1stringDatasourceName

Username of the CUIC server.minLength = 1stringUsername

Password of the CUIC server.minLength = 1stringPassword

Configuration of Standalone CUICDescriptionExample URIURIHTTPS Method

Get details of the CUICServer.

https://uccx-server/adminapi/standalonecuicconfigurationhttps://<server>/adminapi/

standalonecuicconfiguration

GET

Create or modify the CUICServer Information.

https://uccx-server/adminapi/standalonecuicconfigurationhttps://<server>/adminapi/

standalonecuicconfiguration

PUT

Sample Input XML - Modify CUIC Configuration (PUT)<?xml version="1.0" encoding="UTF-8"?><standaloneCuicConfiguration xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="standaloneCuicConfiguration.xsd">

<fqdn>host.cisco.com</fqdn><datasourceName>ucce realtime</datasourceName><userName>userName</userName><password>password</password>

</standaloneCuicConfiguration>


System Configuration APIsData Structure for Standalone CUIC

http://uccx-server:8080/appadmin/standaloneCuicConfiguration

http://uccx-server:8080/adminapi/recordingConfiguration

TeamA team is a group of agents who report to the same supervisor. A team can have one primary supervisor andoptional secondary supervisors. A supervisor can also monitor CSQs that are assigned to the team that is beingsupervised.

Data Structure for TeamDescriptionRestrictionsBase TypeAttribute Name

Name of the teamminOccurs = 1

maxOccurs = 1

nillable = false

minLength value = 1


Team name contains alphanumericcharacters, special characters,spaces, underscores (_), and hyphens(-) without leading or trailing whitespaces.

stringteamName

Name of the primarysupervisor of the team

minOccurs = 0

maxOccurs = 1

nillable = false

nameUriPairprimarySupervisor

Name of the secondarysupervisor of the team

minOccurs = 0

maxOccurs = 1

nillable = false

nameUriPairsecondarySupervisors

Name of the resourceminOccurs = 0

maxOccurs = 1

nillable = false

nameUriPairresources

Name of the CSQminOccurs = 0

maxOccurs = 1

nillable = false

nameUriPaircsqs

Get List of TeamsGETHTTPS Method

https://<server>/adminapi/teamURI


System Configuration APIsTeam

https://uccx-server/adminapi/teamExample URI





Success Response

—

Get TeamPOSTHTTPS Method

https://<server>/adminapi/team/{id}URI

https://uccx-server/adminapi/team/12Example URI





Success Response

—

Create TeamPOSTHTTPS Method

https://<server>/adminapi/teamURI

https://uccx-server/adminapi/teamExample URI




—Error Codes


System Configuration APIsGet Team

Success Response


Sample Input XML—Create Team (PUT)

<?xml version="1.0" encoding="UTF-8"?><team xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:noNamespaceSchemaLocation="team.xsd"><self>URL</self><teamId>27</teamId><teamname>TeamTest12</teamname><primarySupervisor name="atagent2">

<refURL>URL</refURL></primarySupervisor><secondarySupervisors>

<secondrySupervisor name="atagent1"><refURL>URL</refURL>

</secondrySupervisor></secondarySupervisors><resources><resource name="atagent1"><refURL>URL</refURL>

</resource></resources><csqs><csq name="Q1"><refURL>URL</refURL></csq></csqs></team>

Modify TeamPUTHTTPS Method






—Error Codes

Success Response

—


System Configuration APIsModify Team

Delete TeamDELETEHTTPS Method






—Error Codes

Success Response

—

TriggerYou must configure Unified CM Telephony triggers to invoke application scripts in response to incomingcontacts. A Unified CM Telephony trigger responds to calls that arrive on a specific route point by selectingtelephony and media resources to serve the call and invoking an application script to handle the call.

Trigger Data StructureDescriptionRestrictionsBase TypeAttribute Name

A unique phone number.minOccurs = 1

maxOccurs = 1

directoryNumberdirectoryNumber

Defines the locale.minOccurs = 0

maxOccurs = 1

RestrictedStringlocale

Application name used toassociate with the trigger.

minOccurs = 1

maxOccurs = 1

nameUriPairapplication

A unique identifier for thedevice.

minOccurs = 1

maxOccurs = 1

deviceNamedeviceName

A descriptive name for the CTIroute point.

minOccurs = 1

maxOccurs = 1

descriptiondescription

The call control group used toassociate with the trigger.

minOccurs = 1

maxOccurs = 1

nameUriPaircallControlGroup


System Configuration APIsDelete Team


Used to enable or disable thetrigger.

minOccurs = 1

maxOccurs = 1

default = true

booleantriggerEnabled

The maximum number ofsimultaneous calls that thistrigger can handle.

minOccurs = 0

maxOccurs = 1

baseIdIntmaxNumOfSessions

The number of milliseconds(ms) the system should waitbefore rejecting the UnifiedCM Telephony request for thistrigger .

minOccurs = 0

maxOccurs = 1

default = "5000"

baseIdIntidleTimeout

Used to enable or disable themedia termination.

minOccurs = 0

maxOccurs = 1

overrideMediaTerminationoverrideMediaTermination

Displays the ASCII name alertsfor the following scenarios:

• if the device is not capableof handling the Unicodestrings

• if the locale on endpointdevices do not match

• if the Unicode string is notspecified

minOccurs = 0

maxOccurs = 1

default = ""

CCMAlertingNameASCIIalertingNameAscii

The device pool to which youwant to assign the route point.

minOccurs = 0

maxOccurs = 1

default = "default"

CCMCommonObjectNamedevicePool

The total bandwidth that isavailable for calls to/from alocation.

minOccurs = 0

maxOccurs = 1

default ="Hub_none"

CCMCommonObjectNamelocation

The partition to which theDirectory Number belongs.

minOccurs = 0

maxOccurs = 1

default = none

CCMPartionNamepartition

A list of profiles defined in theVoice Mail ProfileConfiguration.

minOccurs = 0

maxOccurs = 1

cucmStringvoiceMailProfile


System Configuration APIsTrigger Data Structure


A collection of partitions thatare searched for numbers thatare called from the directorynumber.

minOccurs = 0

maxOccurs = 1

CCMCommonObjectNamecallingSearchSpace

A collection of partitions thatare searched to determine howa redirected call is routed.

Redirect Calling Search Spaceoptions:

• DN Calling SearchSpace—Enables the CTIPort to use its directorynumber CSS whenperforming a redirect /consult transfer.

• Calling Party—Enablesthe CTI Port to use thecalling party's CSS whenperforming a redirect /consult transfer.

• Redirect Party—Enablesthe CTI Port to use theCTI Route Point's CSSwhen performing aredirect / consult transfer.

minOccurs = 0

maxOccurs = 1

default = "default"

enum values =default,calling.party,redirecting.party

enumcallingSearchSpaceForRedirect

A list of groups to integrate thedevice with the iPass server.

minOccurs = 0

maxOccurs = 1

default = "StandardPresence group"

CCMCommonObjectNamepresenceGroup

Used to configure call forwardand pickup settings.

minOccurs = 0

maxOccurs = 1

forwardBusyforwardBusy


System Configuration APIsTrigger Data Structure

Simple Data Structure and Elements Used in TriggerDescriptionRestrictionsBase TypeAttribute Name

A unique phone number.minLength = 0

maxLength = 50

To support E.164compliance, Unified CCXallows to add “+” precedingto an agent extension or aroute point directory number.Including “+”, the directorynumber includes numericcharacters and the followingspecial characters:

X # [ ] - *

stringdirectoryNumber

A unique identifier forthis device.

minLength = 1

maxLength = 15

Description type cannotcontain special characters<,>,?,%,(,),\,/,+,'," andcannot have a leading ortrailing spaces.

stringdeviceName

A descriptive name forthe CTI route point.

minLength = 1

maxLength = 50

Description type cannotcontain special characters",\,&,<,>,,,/ and cannot havea leading space.

stringdescription

Unicode stringrepresenting route pointinformation.

minLength = 1

maxLength = 50

Can contain numbers from0-9, characters a-z, A-Z, .-_and empty spaces.

stringcucmString

Used to display the username or the directorynumber.

minOccurs = 1

maxOccurs = 30

default = ""

Can contain a maximum of30 alphanumeric charactersexcept \,],",%,<,>,[,&,|,{and}.

stringdisplay


System Configuration APIsSimple Data Structure and Elements Used in Trigger


externalPhoneMaskNumberminOccurs = 0

maxOccurs = 1

maxLength = 24

All numeric character 0-9and character #, +, and X areallowed.

stringexternalPhoneMaskNumber

Used to enable or disablethe media termination.

minOccurs = 0


sequenceoverrideMediaTermination

Displays the ASCII namealerts for the followingscenarios:

• The device is notcapable of handlingthe Unicode strings.

• The locales onendpoint devices donot match.

• The Unicode stringis not specified.

minLength = 0

maxLength = 30

All characters are allowedexcept double quotationmarks ("), brackets (<,>),ampersand (&), and percent(%).

Do not use the followingkeywords that are reservedin Unified CommunicationsManager: Conference, ParkNumber, Barge, CBarge,Monitor, and Record.

stringCCMAlertingNameASCII

Complex Data Structure Defined for forwardBusyDescriptionRestrictionsBase TypeAttribute Name

Used to enable or disablesettings in the Destination boxand Calling Search Space.

default = false

minOccurs = 0

maxOccurs = 1

booleanforwardBusyVoiceMail

Used to set a phone number,including an outsidedestination.

minOccurs = 0

maxOccurs = 1

directoryNumberforwardBusyDestination

Used to apply the call forwardsetting on all devices that areusing the same directorynumber.

default = none

minOccurs = 1

maxOccurs = 1

stringforwardBusyCallingSearchSpace


System Configuration APIsComplex Data Structure Defined for forwardBusy

Get list of triggersGETHTTPS Method

https://<server>/adminapi/triggerURI

https://uccx-server/adminapi/triggerExample URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Get a Trigger by Directory NumberGETHTTPS Method

https://<server>/adminapi/trigger/<trigger number>URI

https://uccx-server/adminapi/trigger/876Example URI




—Error Codes

Success Response

HTTPS/1.1 200 OK

Create a New TriggerPOSTHTTPS Method

https://<server>/adminapi/triggerURI

https://uccx-server/adminapi/triggerExample URI




System Configuration APIsGet list of triggers


—Error Codes

Success Response

Retrieves the unique URI pointing to the trigger.

Sample Input XML—Create a New Trigger with Default Parameters (POST)

<?xml version="1.0" encoding="UTF-8"?><trigger><self rel="self" href=https://uccx-server/adminapi/trigger/3000" type="trigger"/><directoryNumber>3000</directoryNumber><locale>en_AU</locale><application name="Auto_OB_Application"><refURL>https://uccx-server/adminapi/application/Auto_OB_Application</refURL></application><deviceName>abcd</deviceName><description>abcd</description><callControlGroup name="2"><refURL>https://uccx-server/adminapi/callControlGroup/2</refURL></callControlGroup><triggerEnabled>true</triggerEnabled><maxNumOfSessions>20</maxNumOfSessions><idleTimeout>5000</idleTimeout><overrideMediaTermination><dialogGroup name="0"><refURL>https://uccx-server/adminapi/dialogGroup/0</refURL></dialogGroup></overrideMediaTermination><alertingNameAscii></alertingNameAscii><devicePool>Default</devicePool><location>Hub_None</location><partition>None</partition><voiceMailProfile>None</voiceMailProfile><callingSearchSpace>None</callingSearchSpace><callingSearchSpaceForRedirect>default</callingSearchSpaceForRedirect><presenceGroup>Standard Presence group</presenceGroup><forwardBusy><forwardBusyVoiceMail>false</forwardBusyVoiceMail><forwardBusyDestination></forwardBusyDestination><forwardBusyCallingSearchSpace>None</forwardBusyCallingSearchSpace></forwardBusy><display></display><externalPhoneMaskNumber></externalPhoneMaskNumber>

</trigger>

Modify a Trigger by IDPUTHTTPS Method

https://<server>/adminapi/trigger/<trigger id>URI




System Configuration APIsModify a Trigger by ID



—Error Codes

Success Response

HTTPS/1.1 200 OK

Delete a Trigger by IDDELETEHTTPS Method

https://<server>/adminapi/trigger/<trigger id>URI





—Error Codes

Success Response

HTTPS/1.1 200 OK

TTS ProviderTTS Provider provides the information about the text to speech service provider.

Data Structure for TTS ProviderDescriptionRestrictionsBase TypeAttribute Name

Name of the TTS provider.Regex:

[A-Za-z0-9.-_\s]+

stringttsProviderName

The number of TTS licenses.minOccurs = 0

maxOccurs = 1

nillable = false

intnoOflicenses


System Configuration APIsDelete a Trigger by ID

Get list of TTS ProvidersGETHTTPS Method

https://<server>/adminapi/ttsProviderURI

https://uccx-server:8080/adminapi/ttsProviderExample URI




—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ttsProviders>

<ttsProvider><ttsProviderId>47</ttsProviderId><ttsProviderName>Scansoft Realspeak 4.0</ttsProviderName><noOfLicenses>0</noOfLicenses>

</ttsProvider><ttsProvider>

<ttsProviderId>51</ttsProviderId><ttsProviderName>Nuance Vocalizer 4.0</ttsProviderName><noOfLicenses>0</noOfLicenses>

</ttsProvider></ttsProviders>

Get a TTS ProviderGETHTTPS Method

https://<server>/adminapi/ttsProvider/ttsProviderNameURI

https://uccx-server:8080/adminapi/ttsProvider/ScansoftRealspeak 4.0

Example URI




—Error Codes


System Configuration APIsGet list of TTS Providers

Success Response

<?xml version="1.0" encoding="UTF-8"?><ttsProvider>

<ttsProviderId>44</ttsProviderId><ttsProviderName>Scansoft Realspeak 4.0</ttsProviderName><noOfLicenses>0</noOfLicenses>

</ttsProvider>

Create TTS ProviderPOSTHTTPS Method

https://<server>/adminapi/ttsProviderURI

https://uccx-server:8080/adminapi/ttsProviderExample URI

Application/XMLContent Type



—Error Codes

Success Response

https://uccx-server/adminapi/ttsProvider/Nuance%20Vocalizer%204%2E0

Sample Input XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ttsProvider><ttsProviderName>Scansoft Realspeak 4.0</ttsProviderName></ttsProvider>

Modify TTS ProviderPUTHTTPS Method



Example URI




—Error Codes


System Configuration APIsCreate TTS Provider

Sample Input XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ttsProvider><ttsProviderName>Scansoft Realspeak 4.0</ttsProviderName><noOfLicenses>50</noOfLicenses></ttsProvider>

Delete TTS ProviderDELETEHTTPS Method



Example URI




—Error Codes

TTS ServerTTS Server provides the information about the text to speech server.

Data Structure for TTS ServerDescriptionRestrictionsBase TypeAttribute Name

IP Address or hostname of theTTS server.

Regex:

[A-Za-z0-9_.-]+

\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

stringttsServerName

Name of the TTS provider.Regex:

[A-Za-z0-9.-_\s]+

providerTypeproviderName

Port number used for the TTS.minInclusive = 0


intportNumber

The type of locale used for theTTS.

minOccurs = 1


nillable = false

localeTypelocales


System Configuration APIsDelete TTS Provider


The type of language used forthe TTS.

minOccurs = 1

maxOccurs = 1

nillable = false

stringlanguage

The type of gender used for theTTS.

minOccurs = 1

maxOccurs = 1

nillable = false

Enumeraton: (Male, Femaleand Neutral)

enumerationgender

The default gender used for theTTS.

minOccurs = 1

maxOccurs = 1

nillable = false

Enumeraton: (Male, Femaleand Neutral)

enumerationdefaultGender

Get list of TTS ServersGETHTTPSs Method

https://<server>/adminapi/ttsServerURI

https://uccx-server:8080/adminapi/ttsServerExample URI


200HTTPSs Success Code

401, 402, 405HTTPSs Failure Codes

—Error Codes


System Configuration APIsGet list of TTS Servers

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ttsServers>

<ttsServer><ttsServerId>48</ttsServerId><ttsServerName>localhost</ttsServerName><providerName>Scansoft Realspeak 4.0</providerName><portNumber>4900</portNumber><locales>

<language>en_US</language><gender>Female</gender><defGender>Female</defGender>

</locales></ttsServer><ttsServer>

<ttsServerId>49</ttsServerId><ttsServerName>localhost2</ttsServerName><providerName>Scansoft Realspeak 4.0</providerName><portNumber>4900</portNumber><locales>


</locales></ttsServer>

</ttsServers>

Get a TTS ServerGETHTTPSs Method

https://<server>/adminapi/ttsServer/ttsProviderNameURI

https://uccx-server:8080/adminapi/ttsServer/localhostExample URI


200HTTPSs Success Code

401, 402, 404, 405HTTPSs Failure Codes

—Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><ttsServer>

<ttsServerId>48</ttsServerId><ttsServerName>localhost</ttsServerName><providerName>Scansoft Realspeak 4.0</providerName><portNumber>4900</portNumber><locales>


</locales></ttsServer>


System Configuration APIsGet a TTS Server

Create TTS ServerPOSTHTTPS Method

https://<server>/adminapi/ttsServerURI

https://uccx-server:8080/adminapi/ttsServerExample URI




—Error Codes

Success Response

https://uccx-server/adminapi/ttsServer/localhost

Sample Input XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ttsServer><ttsServerName>localhost</ttsServerName><providerName>Scansoft Realspeak 4.0</providerName><portNumber>4900</portNumber><locales><language>en_US</language><gender>Male</gender><defGender>Female</defGender></locales></ttsServer>

Modify TTS ServerPUTHTTPS Method

https://<server>/adminapi/ttsServer/localhostURI





—Error Codes


System Configuration APIsCreate TTS Server

Sample Input XML

<?xml version="1.0" encoding="UTF-8"?><ttsServer><ttsServerName>localhost</ttsServerName><providerName>Scansoft Realspeak 4.0</providerName><portNumber>4900</portNumber><locales><language>en_US</language><gender>Female</gender><defGender>Female</defGender></locales><locales><language>en_SZ</language><gender>Male</gender><defGender>Male</defGender></locales></ttsServer>

Delete TTS ServerDELETEHTTPS Method

https://<server>/adminapi/ttsServer/localhostURI





—Error Codes

WrapupCategoryWrapupCategory provides information about the reasons that agents can apply to the chats and email handled.A Wrap-Up reason indicates why a customer called the contact center.

Data Structure for WrapupCategoryDescriptionRestrictionsBase TypeAttribute Name

Unique identifier of theWrapupCategory.

minOccurs = 0

maxOccurs = 1

intid

Name of the WrapupCategory.Should have 1 to 40 characterslength

stringname

Type of the WrapupCategory.Currently only 'nonvoice' ispermitted

stringtype


System Configuration APIsDelete TTS Server


Flag indicating whether theWrapupCategory is Global orCSQ level .

nonebooleanglobal

All the Reasons associated withthis Category .

Reason should be minOccurs= 1 maxOccurs = 25

Text should have 1 to 40 charslength and there should be noduplicates

ComplexTypeelementcontainingtheComplexTypeelement'reason'withelements'id' of type'int' and'text' oftype'string'

wrapupReasons

All the CSQs associatedwith thiscategory .

Associated CSQs should bethere only if the type is notglobal.

ComplexTypeelementcontainingtheelement'csq'which isof the type'nameUriPair'

associatedCSQs

Other Restrictions

• There can be a maximum number of 25 categories.

• There can be maximum 10 global categories.

• The category name should be unique.

• CSQs associated should be of chat/email type and should be existing.

• A Wrap-Up Category can be mapped to any number of CSQs.

• A CSQ can be associated with a maximum number of 10 Wrap-Up categories.

• Special characters like <, >, ~, `, !, @, #, $, %, ^, &, *, (, ), =, |, [, ], {, }, ;, /, ',+, :, ", and comma are notallowed in the attributes, WrapupCategory name and wrapupReasons text.

Get list of WrapupCategoryGETHTTPS Method

https://<server>/adminapi/wrapupcategoryURI


System Configuration APIsGet list of WrapupCategory

https://uccx-server:8080/adminapi/wrapupcategoryExample URI




500Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><wrapupCategories>

<wrapupCategory><id>1</id><name>CategoryName1</name><type>nonvoice</type><global>true</global><wrapupReasons>

<reason><id>1</id><text>Reason1</text>

</reason><reason>

<id>2</id><text>Reason2</text>

</reason></wrapupReasons><associatedCSQs/>

</wrapupCategory><wrapupCategory>

<id>2</id><name>CategoryName2</name><type>nonvoice</type><global>false</global><wrapupReasons>


</reason><reason>


</reason></wrapupReasons><associatedCSQs>

<csq name="1"><refURL>https://10.100.10.100/adminapi/csq/1</refURL>

</csq><csq name="2">

<refURL>https://10.100.10.100/adminapi/csq/2</refURL></csq>

</associatedCSQs></wrapupCategory>

</wrapupCategories>


System Configuration APIsGet list of WrapupCategory

Get WrapupCategoryGETHTTPS Method

https://<server>/adminapi/wrapupcategory/{id}URI

https://uccx-server:8080/adminapi/wrapupcategory/1Example URI




500Error Codes

Success Response

<?xml version="1.0" encoding="UTF-8"?><wrapupCategory>

<id>1</id><name>CategoryName1</name><type>nonvoice</type><global>true</global><wrapupReasons>


</reason><reason>



</wrapupCategory>

Create WrapupCategoryPOSTHTTPS Method

https://<server>/adminapi/wrapupcategoryURI

https://uccx-server:8080/adminapi/wrapupcategoryExample URI




500Error Codes


System Configuration APIsGet WrapupCategory

Success Response


Sample Input XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><wrapupCategory>

<name>CategoryName1</name><type>nonvoice</type><global>true</global><wrapupReasons>


</reason><reason>



</wrapupCategory>

Modify WrapupCategoryPUTHTTPS Method

https://< server >/adminapi/wrapupcategory/{id}URI

https://uccx-server/adminapi/wrapupcategory/1Example URI




500Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsModify WrapupCategory

Sample Input XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><wrapupCategory>

<name>CategoryName1</name><type>nonvoice</type><global>true</global><wrapupReasons>


</reason><reason>



</wrapupCategory>

Delete WrapupCategoryDELETEHTTPS Method

https://< server >/adminapi/wrapupcategory/{id}URI

https://uccx-server/adminapi/wrapupcategory/1Example URI




500Error Codes

Success Response

HTTPS/1.1 200 OK


System Configuration APIsDelete WrapupCategory


System Configuration APIsDelete WrapupCategory

A P P E N D I X ACisco Finesse Desktop and Configuration APIs

The Cisco Web Services Developer Guide includes the Cisco Finesse desktop and configuration APIs, a listof API parameters, errors, and information about gadget development.

This guide is available on the Finesse page of the Cisco DevNet and located at https://developer.cisco.com/site/finesse/docs.


https://developer.cisco.com/site/finesse/docs

https://developer.cisco.com/site/finesse/docs


Cisco Finesse Desktop and Configuration APIsCisco Finesse Desktop and Configuration APIs

A P P E N D I X BCisco SocialMiner APIs

The Cisco SocialMiner Developers Guide includes the SocialMiner APIs.

This guide is available on the SocialMiner page of the Cisco DevNet and located athttps://developer.cisco.com/site/socialminer/overview/.


https://developer.cisco.com/site/socialminer/overview/


Cisco SocialMiner APIsCisco SocialMiner APIs