Documentation
All
Finesse
Finesse
Overview
Finesse Overview
Getting Started
FAQ
Guides
REST API Developer Guide
Introduction
What's New in Cisco Finesse 12.6(2)
Deprecated Features
Cisco Finesse REST APIs
JavaScript Library and Sample Gadgets
Communication with the Cisco Finesse Web Service
Client Requests
HTTPS Requests
Real-Time Events
API Parameter Types
Cisco Finesse API Errors
Lab Development Environment Validation with Cisco FinesseWeb Services APIs
Environment and Tools
Postman
Pidgin for Windows
Adium for Mac OS X
Cisco Finesse APIs
Sign In to Finesse
Change Agent State
Cisco Finesse Desktop APIs
User
User APIs
User—Sign In to Finesse
User—Sign In as a Mobile Agent
User—Sign Out of Finesse Desktop
User—Get User
User—Get User Id from loginName
User—Get List
User—Get List of Dialogs (Voice Only by Default)
User—Get List of Dialogs (Nonvoice Only)
User—Get List of Reservation Dialogs
User—Change Agent State
User—Agent State Change With Reason Code
User—Get Reason Code
User—Get Reason Code List
User—Get Wrap-Up Reason
User—Get Wrap-Up Reason List
User—Get Default Media Properties Layout
User—Get Media Properties Layout List
User—Get List of Phone Books
User—Get List of Workflows
User API Parameters
User API Errors
Devices
Devices API
Devices—Get List of Devices for Extension
Devices API Parameters
Devices API Errors
Dialog
Dialog APIs
Dialog—Get Dialog
Dialog—Create a New Dialog (Make a Call)
Dialog—Take Action on Participant
Dialog—Update Call Variable Data
ECC and Call Variable Error Handling
Dialog—Send DTMF String
Dialog—Make a Consult Call Request
Dialog—Initiate a Single Step Transfer
Dialog—Make a Silent Monitor Call
Dialog—End a Silent Monitor Call
Dialog—Make a Barge Call
Dialog—End a Barge Call
Dialog—Drop Participant from Conference
Dialog—Start Recording
Dialog—Accept, Close, or Reject an Outbound Option Preview Reservation
Dialog—Accept, Close, or Reject a Direct Preview Outbound Reservation
Dialog—Reclassify a Direct Preview Call
Dialog—Schedule or Cancel a Callback
Dialog API Parameters
State (Dialog) Parameter Values
Actions Parameter Values
State (Participant) Parameter Values
CTI Event Mappings for Dialog and Participant States
Outbound Call Types and BAStatus
Disposition Code Parameter Values for Nonvoice Tasks
Dialog API Errors
Queue
Queue APIs
Queue—Get Queue
Queue—Get List of Queues for User
Queue API Parameters
Queue API Errors
Team
Team APIs
Team—Get Team
Team—Get List of TeamMessages
Team API Parameters
Team API Errors
TeamResource
TeamResource APIs
TeamResource—Get Reason Codes
TeamResource—Get Wrap-Up Reasons
TeamResource—Get Media Properties Layouts
TeamResource—Get Phone Books
TeamResource—Get Workflows
TeamResource—Get Layout
TeamResource API Parameters
TeamResource API Errors
Get Script Selectors
ClientLog
ClientLog APIs
ClientLog—Post to Finesse
CompressedClientLog—Post Compressed Log to Finesse
ClientLog API Parameters
ClientLog API Errors
Task Routing APIs
Media
Media APIs
Media—Sign In
Media—Change State or Sign Out
Media—Change Agent State with Reason Code
Media—Change Agent to Routable/Not Routable
Media—Change Agent from Work State to Active
Media—Get Media
Media—Get List
Media—Put List
MediaDomain—Get List
Agent States for Nonvoice Media
Media API Parameters
Media API Errors
Dialog APIs for Nonvoice Tasks
User APIs for Nonvoice Tasks
Single Sign-On
Single Sign-On APIs
Single Sign-On—Test API
Single Sign-On—Fetch Access Token
Single Sign-On—Refresh Existing Access Token
Single Sign-On—Get User Authentication Mode
Single Sign-On Parameters
Single Sign-On API Errors
Client Integration
TeamMessage
TeamMessage APIs
TeamMessage—Get Team Message
TeamMessage—Get List
TeamMessage—Create a Team Message
TeamMessage—Delete a Team Message
TeamMessage API Parameters
TeamMessage API Errors
Cisco Finesse Configuration APIs
SystemConfig
SystemConfig APIs
SystemConfig—Get
SystemConfig—Set
SystemConfig API Parameters
SystemConfig API Errors
ConfigInfo
ConfigInfo APIs
ConfigInfo—Get
ConfigInfo API Parameters
ConfigInfo API Errors
ECCVariableConfig
ECCVariableConfig APIs
ECCVariableConfig—Get ECC Variable Configuration
ECCVariableConfig API Parameters
ECCVariableConfig API Errors
ClusterConfig
ClusterConfig APIs
ClusterConfig—Get
ClusterConfig—Set
ClusterConfig API Parameters
ClusterConfig API Errors
EnterpriseDatabaseConfig
EnterpriseDatabaseConfig APIs
EnterpriseDatabaseConfig—Get
EnterpriseDatabaseConfig—Set
EnterpriseDatabaseConfig API Parameters
EnterpriseDatabaseConfig API Errors
LayoutConfig
LayoutConfig APIs
LayoutConfig—Get
LayoutConfig—Set
LayoutConfig API Parameters
LayoutConfig API Errors
ReasonCode
ReasonCode APIs
ReasonCode—Get
ReasonCode—Get List
ReasonCode—Create
ReasonCode—Update
ReasonCode—Delete
ReasonCode API Parameters
ReasonCode API Errors
WrapUpReason
WrapUpReason APIs
WrapUpReason—Get
WrapUpReason—Get List
WrapUpReason—Create
WrapUpReason—Update
WrapUpReason—Delete
WrapUpReason API Parameters
WrapUpReason API Errors
ChatConfig
ChatConfig APIs
ChatConfig—Get
ChatConfig—Set
ChatConfig API Parameters
ChatConfig API Errors
Cloud Connect
Cloud Connect Configuration
Cloud Connect Configuration APIs
Cloud Connect Configuration—Get
Cloud Connect Configuration—Set
Cloud Connect Integration—Delete
Cloud Connect Configuration Parameters
Cloud Connect Configuration API Errors
Cloud Connect Services
Cloud Connect Services APIs
Cloud Connect Services Token—Get
Cloud Connect Services API Parameters
Cloud Connect Management Service Config—Get
Cloud Connect Services API Errors
MediaPropertiesLayout
MediaPropertiesLayout APIs
MediaPropertiesLayout—Get
MediaPropertiesLayout—Get Default Layout
MediaPropertiesLayout—Get List
MediaPropertiesLayout—Create
MediaPropertiesLayout—Update
MediaPropertiesLayout—Update Default Layout
MediaPropertiesLayout—Delete
MediaPropertiesLayout API Parameters
MediaPropertiesLayout API Errors
PhoneBook
PhoneBook APIs
PhoneBook—Get
PhoneBook—Get List
PhoneBook—Create
PhoneBook—Update
PhoneBook—Delete
PhoneBook—Import Contact List (CSV)
PhoneBook—Import Contact List (XML)
PhoneBook—Export Contact List
PhoneBook API Parameters
PhoneBook API Errors
Contact
Contact APIs
Contact—Get
Contact—Get List
Contact—Create
Contact—Update
Contact—Delete
Contact API Parameters
Contact API Errors
Workflow
Workflow APIs
Workflow—Get
Workflow—Get List
Workflow—Create
Workflow—Update
Workflow—Delete
Workflow API Parameters
Workflow API Errors
WorkflowAction
WorkflowAction APIs
WorkflowAction—Get
WorkflowAction—Get List
WorkflowAction—Create
WorkflowAction—Update
WorkflowAction—Delete
WorkflowAction API Parameters
WorkflowAction API Errors
Team
Team APIs
Team—Get List
Team—Get List of Reason Codes
Team—Update List of Reason Codes
Team—Get List of Wrap-Up Reasons
Team—Update List of Wrap-Up Reasons
Team—Get List of Phone Books
Team—Update List of Phone Books
Team—Get Layout Configuration
Team—Update Layout Configuration
Team—Get List of Workflows
Team—Update List of Workflows
Team API Parameters
Team API Errors
SystemVariable
SystemVariable APIs
SystemVariable—List
SystemVariable API Parameters
SystemVariable API Errors
Cisco Finesse Serviceability APIs
SystemInfo
SystemInfo APIs
SystemInfo—Get
SystemInfo API Parameters
SystemInfo API Errors
Finesse MaintenanceMode
Finesse MaintenanceMode APIs
Finesse MaintenanceMode—Get
Finesse MaintenanceMode—Update
Finesse MaintenanceMode API Parameters
Finesse MaintenanceMode API Errors
ConnectedUsersInfo
ConnectedUsersInfo APIs
ConnectedUsersInfo—Summary
ConnectedUsersInfo—Get Connected Users Information
ConnectedUsersInfo API Parameters
ConnectedUsersInfo API Errors
Diagnostic Portal
Diagnostic Portal APIs
Diagnostic Portal—Get Performance Information
Diagnostic Portal—Get Product Version
Diagnostic Portal API Errors
Finesse Performance API
List operation
Read operation
RuntimeConfigInfo
RuntimeConfigInfo APIs
RuntimeConfigInfo—Get
RuntimeConfigInfo API Parameters
RuntimeConfigInfo API Errors
Cisco Finesse Notifications
About Cisco Finesse Notifications
Notification Frequency
Subscription Management
Subscription Persistence
Resources
User Notification
Dialog Notification
Dialogs/Media Notification
Dialog CTI Error Notification
Team Notification
Queue Notifications
User/Queue Notification
Media Notification
Media and Dialogs/Media Asynchronous Error Notification
Media and Dialogs/Media Error Code Descriptions
Errors for Agent State and Mode Changes
Errors for Dialogs
Notification Parameters
Managing Notifications in Third-Party Applications
Connect to XMPP over HTTP (BOSH/WebSocket) using Finesse EventTunnel
Connect to XMPP over TCP
Finesse High Availability
Failure Scenarios
Desktop Presence and Forced Logout
Failure Handling for Task Routing Clients
Finesse Desktop Gadget Development
Finesse Gadgets
Gadget Description
Simple Example Gadget
Gadget Limitations
Import Finesse JavaScript API
alternateHosts Configuration
Headless Gadget Configuration
Multi-Tab Gadgets
Best Practices for Gadget Development
Supported OpenSocial Features
Gadget Specification XML Features
Required Module pref Feature
Loading Indicator Feature
APIs Available to Gadget JavaScript
Gadget Preferences
Caveats
Gadget Caching
Notifications on Finesse Desktop
Finesse Notifications in Third-Party Containers
Finesse Topics
Connection Information
Finesse Notifications
Finesse Requests
ConnectionInfoReq
ConnectionReq
SubscribeNodeReq
UnsubscribeNodeReq
Finesse Responses
Workflow Action Event
Finesse Container Timer
Handling Special Characters in CSS
Subscription Management on Finesse Desktop
Gadget Height Management
Setting Gadget Height—Desktop Layout XML
Setting Gadget Height—Using Gadget API
Third-Party Gadgets
Enable or Reset 3rdpartygadget Account
CSS Requirements
Optimizing Gadget Resource Loading
Matching the Desktop Look and Feel
Upload Third-Party Gadgets
Permissions
Replication
Migration
Backup and Restore
Restrictions
CORS Support for Finesse REST APIs
Maintenance Mode
Cisco Finesse JavaScript APIs
Client Services
Container Services
Container Services Topics
Finesse Toaster
Popover Service
Notification Popover Service
Events
Gadget View Changed Event
Timer Tick Event
Workflow Action Event
Workflow Action Event.HandledBy
Task Activity Notification
ClientLogger
Digital Channel
Cisco Common Desktop Stock Icon Names with Image
Channel Service
Gadget Configuration
Interfaces
Request Handlers
REST Services
JavaScript Representation of Finesse REST API
REST Collection Objects
RestBase and RestCollectionBase Common Parameters
RestBase Common Parameters
RestCollectionBase Common Parameters
JavaScript Library
Subscription Support
REST Base
REST Collection Base
User
User.MediaStates
User.States
User.WorkMode
User.WrapUpMode
UserMediaPropertiesLayout
UserMediaPropertiesLayouts
Users
Dialog
Dialog.Actions
Dialog.ParticipantStates
Dialog.ReasonStates
Dialog.States
DialogBase
DialogLogoutActions
Dialogs
Queue
Queues
Team
TeamNotReadyReasonCode
TeamNotReadyReasonCodes
TeamSignOutReasonCodes
Media
Media.States
MediaDialog
MediaDialog.States
MediaDialog.TaskActions
MediaDialogs
MediaList
MediaOptionsHelper
MediaOptionsHelper.States
MediaPropertiesLayout
Script Selectors
ChatConfig
ECCVariableConfig
Contact
Contacts
InterruptActions
PhoneBook
PhoneBooks
ReasonCodeLookup
ReasonCodes
SystemInfo
SystemInfo.Statuses
WrapUpReason
WrapUpReasons
ShortcutKey Service
Utilities
Desktop Cache
JSONValidator
WorkflowService
JSON Schema
Log Collection
Log Collection
Documents and Documentation Feedback
Documents and Documentation Feedback
Reference for Applying Desktop Styles
Common CSS Styles for Finesse Desktop
CSS Styles for Button
CSS Styles for Text
CSS Styles for Icon
CSS Styles for Input
CSS Styles for Border
CSS Styles for Background
JavaScript Library
REST APIs with SSO Guide
Single Sign-On
Single Sign-On
Single Sign-On—Get User Authentication Mode
Single Sign-On—Fetch Access Token
Single Sign-On—Refresh Existing Access Token
Client Integration
Client-Side Token Validation
Desktop Interface API Guide
Introduction
Cisco Finesse Desktop Interface APIs
Desktop Interface API Client Requests
API Parameter Types
Cisco Finesse Desktop Interface API Errors
Finesse Desktop Interface API
Desktop Configuration
Desktop Configuration APIs
Desktop Configuration—Get
Desktop Configuration API Parameters
Desktop Configuration API Errors
Languages List
Languages APIs
Languages—Get List
Languages List Parameters
Languages API Errors
Resource URLs
Resource URLs APIs
Resource URLs—Get List
Resource URL API Errors
Visual Design Guide
Tools
CAD to Finesse Migration Tool
Downloads
Previous Documentation (PDFs)
Official Finesse Gadgets
Sample Gadgets
Developer Resources
Sandbox
Self-Paced Tutorials
Community and Support
Developer Support
FAQs
Backup and Restore
Third-party gadgets are preserved when you perform a DRS backup and restore.
Next