configuration web services - five9 · 2 configuration web services • api reference guide about...

Cloud Contact Center Software

Five9 and the Five9 logo are registered trademarks of Five9 and its subsidiaries in the United States and other countries. Other marks and brands may be claimed as the property of others. The product plans, specifications, and descriptions herein are provided for information only and subject to change without notice, and are provided without warranty of any kind, express or implied. Copyright © 2021 Five9, Inc.

Configuration Web ServicesAPI Reference Guide

January 2021

The Configuration Web Services enable developers to build secure applications to access, configure, and synchronize their call center information with work flow-management systems, such as lead management, CRM, and ERP systems.

2 Configuration Web Services • API Reference Guide

About Five9

Five9 is the leading provider of cloud contact center software, bringing the power of the cloud to thousands of customers and facilitating more than three billion customer interactions annually. Since 2001, Five9 has led the cloud revolution in contact centers, delivering software to help organizations of every size transition from premise-based software to the cloud. With its extensive expertise, technology, and ecosystem of partners, Five9 delivers secure, reliable, scalable cloud contact center software to help businesses create exceptional customer experiences, increase agent productivity and deliver tangible results. For more information visit www.five9.com.

Trademarks

Five9®Five9 LogoFive9® SoCoCare™Five9® Connect™

Contents

What’s New............................................................................... 13

Chapter1About the Five9 Configuration Web Services API................................. 15Web Services Platform............................................................................. 15Differences Among Versions 4, 3, 2, and Default.............................................. 17Basic Access Authentication ...................................................................... 18

Chapter2Data Types................................................................................ 20adminConfigTranslation ........................................................................... 20adminPermission.................................................................................... 21adminPermissionType.............................................................................. 21adminRole ........................................................................................... 23agentAuditReportCriteria ......................................................................... 23agentAvailability ................................................................................... 23agentGroup .......................................................................................... 24agentPermission .................................................................................... 24agentPermissionType .............................................................................. 24agentProductivity................................................................................... 29agentRole ............................................................................................ 29agentState ........................................................................................... 30apiOperationType .................................................................................. 31autodialCampaign .................................................................................. 32baseOutboundcampaign ........................................................................... 32

autodialCampaign ............................................................................. 32outboundCampaign ............................................................................ 33

basicImportResult .................................................................................. 38crmImportResult ............................................................................... 39dispositionsImportResult ..................................................................... 39listImportResult ................................................................................ 40

basicImportSettings ................................................................................ 40crmDeleteSettings ............................................................................. 42crmUpdateSettings ............................................................................ 42dispositionsUpdateSettings................................................................... 43listDeleteMode ................................................................................. 43listUpdateSettings ............................................................................. 44

callCounterState.................................................................................... 46callNowMode ........................................................................................ 46callAnalysisMode.................................................................................... 46


callLogReportCriteria .............................................................................. 47callType .............................................................................................. 47callVariable.......................................................................................... 48callVariableRestriction............................................................................. 49callVariableType.................................................................................... 49callVariablesGroup ................................................................................. 50callbackFormat ..................................................................................... 50campaign............................................................................................. 51campaignCallWrapup............................................................................... 51campaignDialNumber .............................................................................. 52campaignDialingAction............................................................................. 52campaignDialingActionType....................................................................... 53campaignDialingMode .............................................................................. 53campaignDialingOrder ............................................................................. 54campaignDialingSchedule ......................................................................... 55campaignFilterCriterion ........................................................................... 55campaignMode ...................................................................................... 56campaignNumberSchedule ........................................................................ 56campaignProfileFilter .............................................................................. 56campaignProfileInfo................................................................................ 57campaignState ...................................................................................... 58campaignStateDialingRule......................................................................... 58campaignStrategies ................................................................................ 59campaignStrategy .................................................................................. 59campaignStrategyFilter ............................................................................ 60campaignStrategyPeriod........................................................................... 60campaignTimeZoneAssignment................................................................... 61campaignType.......................................................................................61campaignsSettings.................................................................................. 62cannedReport .......................................................................................62cavRestrictionType ................................................................................. 63compareOperatorType............................................................................. 63contactField ......................................................................................... 64contactFieldDisplay ................................................................................ 65contactFieldMapping ............................................................................... 65contactFieldRestriction............................................................................ 66contactFieldRestrictionType...................................................................... 66contactFieldType ................................................................................... 67contactsLookupResult.............................................................................. 68crmAddMode......................................................................................... 68crmManagerRole .................................................................................... 68crmManagerPermission ............................................................................ 69crmManagerPermissionType ...................................................................... 69crmCriteriaGrouping ............................................................................... 69crmCriteriaGroupingType ......................................................................... 70crmDeleteMode ..................................................................................... 70crmDeleteSettings .................................................................................. 70crmFieldCriterion................................................................................... 71


crmImportResult .................................................................................... 71crmLookupCriteria.................................................................................. 71crmUpdateMode .................................................................................... 72crmUpdateSettings ................................................................................. 72cssTheme ............................................................................................ 73customDispositionType ............................................................................ 73customReportCriteria .............................................................................. 74data................................................................................................... 74dateRange ........................................................................................... 74dayOfWeek .......................................................................................... 75dialSortOrder........................................................................................ 75dialingRule........................................................................................... 76disposition ........................................................................................... 77dispositionCount .................................................................................... 78dispositionTypeParams ............................................................................ 79dispositionsImportResult .......................................................................... 79dispositionsUpdateMode ........................................................................... 80dispositionsUpdateSettings........................................................................ 80distributionAlgorithm .............................................................................. 80distributionTimeFrame ............................................................................ 81emailNotifications .................................................................................. 82entry.................................................................................................. 82extensionSettings................................................................................... 83fieldEntry ............................................................................................ 83ftpImportSettings................................................................................... 84generalCampaign ................................................................................... 85i18NObjectField..................................................................................... 85i18NObjectType..................................................................................... 85importData .......................................................................................... 86importIdentifier..................................................................................... 86importTrouble.......................................................................................86importTroubleKind ................................................................................. 87inboundCampaign................................................................................... 88inboundIvrScriptSchedule ......................................................................... 88ivrIcons ............................................................................................... 88ivrScriptDef.......................................................................................... 89ivrScriptOwnership ................................................................................. 89ivrScriptSchedule ................................................................................... 89keyPerfomanceIndicators ......................................................................... 90keyValuePair ........................................................................................ 90language ............................................................................................. 90limitTimeoutState .................................................................................. 91listAddMode ......................................................................................... 91listDeleteSettings................................................................................... 91listDialingMode...................................................................................... 92listInfo................................................................................................ 92listImportResult..................................................................................... 93listState .............................................................................................. 93


listUpdateSettings .................................................................................. 94listUpdateSimpleSettings .......................................................................... 96mediaType........................................................................................... 96mediaTypeConfig ................................................................................... 97mediaTypeItem ..................................................................................... 97miscVccOptions ..................................................................................... 98operationType.......................................................................................99orderByField......................................................................................... 99outboundCampaign............................................................................... 100passwordPolicies.................................................................................. 100passwordPolicyEntries ........................................................................... 101passwordPolicyEntryValue....................................................................... 101promptInfo......................................................................................... 102promptType ....................................................................................... 102reasonCode ........................................................................................ 103reasonCodeType .................................................................................. 103record .............................................................................................. 104recordData......................................................................................... 104remoteHostLoginSettings........................................................................ 104reportObjectList .................................................................................. 105reportRowData .................................................................................... 105reportTimeCriteria ............................................................................... 105reportingPermission .............................................................................. 106reportingPermissionType ........................................................................ 106reportingRole...................................................................................... 107sayAs................................................................................................ 107sayAsFormat ....................................................................................... 110scriptParameterValue............................................................................ 111sForceEmailAccount.............................................................................. 111skill ................................................................................................. 112skillInfo............................................................................................. 113speedDialNumber ................................................................................. 113stateDialingRule .................................................................................. 113stateProvince...................................................................................... 114stringArray ......................................................................................... 116supervisorPermission............................................................................. 117supervisorPermissionType ....................................................................... 117supervisorRole..................................................................................... 120timePeriod......................................................................................... 121timeRange ......................................................................................... 121timeZoneAssignment ............................................................................. 121timer................................................................................................ 122ttsInfo .............................................................................................. 122userInfo ............................................................................................ 123userGeneralInfo................................................................................... 123userProfile ......................................................................................... 125userRoleType...................................................................................... 125userRoles........................................................................................... 126


userSkill ............................................................................................ 126vccConfiguration.................................................................................. 127versions ............................................................................................ 128visualModeSettings ............................................................................... 128webConnector..................................................................................... 129webConnectorAgentAppType ................................................................... 130webConnectorCTIWebServicesType............................................................ 131webConnectorTriggerType ...................................................................... 131wrongListDialingMode............................................................................ 132wsObjectType ..................................................................................... 132xFrameOption ..................................................................................... 133

Chapter3Methods ..................................................................................135Agent Groups ...................................................................................... 135

createAgentGroup ........................................................................... 135deleteAgentGroup ........................................................................... 136getAgentGroup ............................................................................... 136getAgentGroups .............................................................................. 137modifyAgentGroup........................................................................... 137

Call Variables...................................................................................... 138createCallVariable........................................................................... 138createCallVariablesGroup .................................................................. 138deleteCallVariable........................................................................... 139deleteCallVariablesGroup .................................................................. 139getCallVariables.............................................................................. 139getCallVariableGroups ...................................................................... 140modifyCallVariable .......................................................................... 140modifyCallVariablesGroup.................................................................. 141

Campaign Configuration ......................................................................... 141addDispositionsToCampaign................................................................ 142addDNISToCampaign ........................................................................ 142addListsToCampaign ........................................................................ 143addSkillsToCampaign........................................................................ 143createAutodialCampaign ................................................................... 143createInboundCampaign.................................................................... 144createOutboundCampaign.................................................................. 144deleteCampaign.............................................................................. 144getAutodialCampaign ....................................................................... 145getCampaigns ................................................................................ 145getCampaignDNISList........................................................................ 146getDNISList.................................................................................... 146getInboundCampaign........................................................................ 147getListsForCampaign ........................................................................ 147getOutboundCampaign...................................................................... 147modifyCampaignLists........................................................................ 148modifyAutodialCampaign ................................................................... 148modifyInboundCampaign ................................................................... 149


modifyOutboundCampaign ................................................................. 149removeDispositionsFromCampaign........................................................ 149removeDNISFromCampaign................................................................. 150removeListsFromCampaign................................................................. 150removeSkillsFromCampaign ................................................................ 150renameCampaign ............................................................................ 151setDefaultIVRSchedule ...................................................................... 151

Campaign Management .......................................................................... 152asyncUpdateCampaignDispositions........................................................ 152forceStopCampaign.......................................................................... 153getCampaignState ........................................................................... 153getCampaignStrategies ..................................................................... 154getDispositionsImportResult ............................................................... 154resetCampaign ............................................................................... 155resetCampaignDispositions ................................................................. 155resetListPosition ............................................................................. 155setCampaignStrategies...................................................................... 156startCampaign................................................................................ 156stopCampaign ................................................................................ 157updateDispositions .......................................................................... 157updateDispositionsCsv ...................................................................... 158updateDispositionsFtp ...................................................................... 158

Campaign Profiles ................................................................................ 159createCampaignProfile ..................................................................... 159deleteCampaignProfile ..................................................................... 159getCampaignProfiles ........................................................................ 160getCampaignProfileDispositions ........................................................... 160getCampaignProfileFilter................................................................... 161modifyCampaignProfile ..................................................................... 161modifyCampaignProfileCrmCriteria....................................................... 161modifyCampaignProfileFilterOrder ....................................................... 162modifyCampaignProfileDispositions....................................................... 162

Connectors......................................................................................... 163createWebConnector........................................................................ 163deleteWebConnector........................................................................ 163getWebConnectors .......................................................................... 164modifyWebConnector ....................................................................... 164

Contact Fields..................................................................................... 165createContactField .......................................................................... 165deleteContactField .......................................................................... 165getContactFields............................................................................. 165modifyContactField ......................................................................... 166

Contact Management ............................................................................ 166asyncUpdateCrmRecords ................................................................... 166deleteFromContacts......................................................................... 167deleteFromContactsCsv..................................................................... 168deleteFromContactsFtp..................................................................... 169getContactRecords .......................................................................... 169


getCrmImportResult......................................................................... 169updateContacts .............................................................................. 170updateContactsCsv .......................................................................... 171updateContactsFtp .......................................................................... 171updateCrmRecord ........................................................................... 172

Domain Limits ..................................................................................... 172getCallCountersState........................................................................ 176

Dialing Rules....................................................................................... 176getDialingRules............................................................................... 176setDialingRules ............................................................................... 177

Disposition Configuration........................................................................ 177createDisposition ............................................................................ 177getDisposition ................................................................................ 177getDispositions ............................................................................... 178modifyDisposition............................................................................ 178removeDisposition ........................................................................... 179renameDisposition ........................................................................... 179

IVR Script .......................................................................................... 179createIVRScript .............................................................................. 180deleteIVRScript .............................................................................. 180getIVRScripts ................................................................................. 180modifyIVRScript .............................................................................. 181setIvrScriptOwnership....................................................................... 181getIvrScriptOwnership ...................................................................... 181removeIvrScriptOwnership ................................................................. 182setIvrIcons .................................................................................... 182getIvrIcons .................................................................................... 183removeIvrIcons ............................................................................... 183

Locales and Languages........................................................................... 183getAvailableLocales ......................................................................... 184getConfigurationTranslations .............................................................. 184getLocale ..................................................................................... 184setLocale...................................................................................... 185updateConfigurationTranslations ......................................................... 185

List Management.................................................................................. 186Using Dialing Lists in the E.164 Format .................................................. 186addNumbersToDnc........................................................................... 187addRecordToList ............................................................................. 187addRecordToListSimple ..................................................................... 188addToList ..................................................................................... 189addToListCsv ................................................................................. 190addToListFtp ................................................................................. 190asyncAddRecordsToList ..................................................................... 191asyncDeleteRecordsFromList .............................................................. 192checkDncForNumbers ....................................................................... 193createList ..................................................................................... 193deleteAllFromList............................................................................ 193deleteFromList ............................................................................... 194


deleteFromListCsv ........................................................................... 195deleteFromListFtp ........................................................................... 196deleteList ..................................................................................... 196deleteRecordFromList ...................................................................... 197getListImportResult ......................................................................... 197getListsInfo ................................................................................... 198isImportRunning.............................................................................. 198removeNumbersFromDnc ................................................................... 199

Prompt Management ............................................................................. 199addPromptTTS ............................................................................... 199addPromptWav ............................................................................... 200addPromptWavInline ........................................................................ 200deleteLanguagePrompt ..................................................................... 201deletePrompt................................................................................. 201getPrompt..................................................................................... 201getPrompts ................................................................................... 202modifyPromptTTS............................................................................ 202modifyPromptWav ........................................................................... 203modifyPromptWavInline .................................................................... 203

Reason Codes...................................................................................... 203createReasonCode........................................................................... 204deleteReasonCode........................................................................... 204deleteReasonCodeByType .................................................................. 204getReasonCode............................................................................... 204getReasonCodeByType ...................................................................... 204modifyReasonCode .......................................................................... 205

Reports ............................................................................................. 205getReportResult.............................................................................. 206getReportResultCsv.......................................................................... 206isReportRunning.............................................................................. 207runReport ..................................................................................... 207

Skill Management ................................................................................. 208addSkillAudioFile ............................................................................ 209createSkill .................................................................................... 209deleteSkill .................................................................................... 209getSkill ........................................................................................ 210getSkillAudioFiles ............................................................................ 210getSkillInfo.................................................................................... 210getSkills ....................................................................................... 211getSkillsInfo................................................................................... 211getSkillVoicemailGreeting.................................................................. 212modifySkill .................................................................................... 213removeSkillAudioFile ........................................................................ 213setSkillVoicemailGreeting .................................................................. 213

Session Information .............................................................................. 214closeSession .................................................................................. 214

Speed Dial Information .......................................................................... 214createSpeedDialNumber .................................................................... 214


getSpeedDialNumbers....................................................................... 215removeSpeedDialNumber................................................................... 215

User Management................................................................................. 216createUser .................................................................................... 216deleteUser .................................................................................... 216getUserGeneralInfo.......................................................................... 217getUserInfo ................................................................................... 217getUserVoicemailGreeting ................................................................. 217getUsersGeneralInfo......................................................................... 217getUsersInfo .................................................................................. 218modifyUser.................................................................................... 218modifyUserCannedReports ................................................................. 219setUserVoicemailGreeting.................................................................. 220userSkillAdd .................................................................................. 220userSkillModify ............................................................................... 220userSkillRemove.............................................................................. 221

User Profiles....................................................................................... 221createUserProfile ............................................................................ 221deleteUserProfile ............................................................................ 222getUserProfile ................................................................................ 222getUserProfiles............................................................................... 222modifyUserProfile ........................................................................... 223modifyUserProfileSkills ..................................................................... 223modifyUserProfileUserList.................................................................. 223

VCC Configuration ................................................................................ 224getApiVersions ............................................................................... 224getVCCConfiguration ........................................................................ 224modifyVCCConfiguration.................................................................... 225

Chapter4Exceptions ...............................................................................226

Appendix5Examples.................................................................................239XML Examples ..................................................................................... 239

addToListCsv ................................................................................. 239Request................................................................................... 239Response ................................................................................. 240

addRecordToList ............................................................................. 240Request................................................................................... 240Response ................................................................................. 241

asyncAddRecordsToList ..................................................................... 242Request................................................................................... 242Response ................................................................................. 243

deleteFromContacts......................................................................... 243Request................................................................................... 243Response ................................................................................. 244

runReport ..................................................................................... 244Request................................................................................... 244


Response ................................................................................. 245PHP Example ...................................................................................... 245



Chapter3

What’s New

This table lists the changes made in the recent releases of this document:

Release Changes

January 20201 • Updated parameter list for crmUpdateSettings.• Identified required properties of agentRole.

Post R12 correction

• Updated description of allowDataCleanup in basicImportSettings• Added crmManagerRole to userRoles.• Added information about the reattempt frequencies for failed requests in

basicImportSettings.• Removed space after /v9_3/ in Web Services Platform.

July 2020 • Added version 12 to Web Services Platform.• Added these data types:

– crmManagerRole– crmManagerPermission– crmManagerPermissionType

• Added the permission CanUseSupervisorSoapApi to supervisorPermissionType.• Added the permission CanUseAdminSoapApi to adminPermissionType.• Added the list of methods that ignore the value of reportEmail. Removed this

parameter from the addRecordToList example request.• Updated isReportRunning with a note describing how to prevent this method from

overloading the system.• Updated Domain Limits to reflect the maximum number of records you can add or

update with each request. Updated the number of records that can be imported asynchronously per minute to 20.

• Corrected the descriptions of scale and precision in cavRestrictionType and contactFieldRestrictionType.

• Corrected the description of callsAgentRatio in outboundCampaign.

What’s New


September 2019

• Corrected the description of failOnFieldParseError and updateCRM.• Added a note about passing dates and times.• Clarified the description of addRecordToListSimple.• Clarified the URL to use for your data center.• Added a note about Apache CXF and swaRef.

June 2019 • Added Version 11 to Web Services Platform.• Added CanMonitorIdleAgents to supervisorPermissionType.• Added an example about runReport.

March 2019 • Marked all instances of NICE Do not use.

October 2018 • Added federationId to userGeneralInfo.• Added these methods:

– createSpeedDialNumber– getSpeedDialNumbers– removeSpeedDialNumber

• Added this parameter: speedDialNumber.• Updated the description for closeSession.• Added Version 10.2 to Web Services Platform.

September 2018

• Changed spelling of unifiedCommunicationId parameter in userGeneralInfo.• Added CASE to mediaType.• Added CanChangeDisplayLanguage to supervisorPermissionType.

Release Changes


Chapter1

About the Five9 Configuration Web Services API

The Five9 Configuration Web Services enable you to build secure applications to access, configure, manage, and synchronize call center information with work flow-management systems, such as lead management, CRM, and ERP systems.

This guide is intended for developers who understand these technologies and protocols:• Client-server architecture and Web services• SOAP, HTTP, and XML• JSP, ASP, CGI, or Perl• Computer-telephony integration concepts, processes, events, and call routing• Overall call center integration and configuration

Apache CXF and swaRef

Web Services PlatformYour client send Web service requests that are acknowledged by Five9 with a Web services response. Your client needs to check periodically for the status and outcome of the operations requested. The Web services API contains the XML-encoded SOAP methods used to communicate with your client application.

Note Five9 Configuration Web Services uses the swaRef.xsd to include binary content for types that are used to upload greetings in WAV format.If you use Apache CXF, be aware that it does not support swaRef.xsd types. Before the SOAP envelope, it inserts text for which Five9 returns this exception:

Exception=javax.xml.ws.soap.SOAPFaultException: org.xml.sax.SAXParseException: Content is not allowed in prolog.

To prevent this issue, remove the SwaOutputInterceptor Apache CXF proxy class. However, with this fix, you cannot use Five9 methods that uses the swaRef types.

About the Five9 Configuration Web Services API Web Services Platform


Five9 recommends that you use the latest version. Previous versions are still supported but are not recommended because they do not contain all the features. Five9username is the user name of the administrator:

• Version 12: https://api.five9.com/wsadmin/v12/AdminWebService?wsdl&user=

version 9_5


• Version 10_2: https://api.five9.com/wsadmin/v10_2/AdminWebService?wsdl&user=


• Version 9_5: https://api.five9.com/wsadmin/v9_5 AdminWebService?wsdl&user=

• Version 9_3: https://api.five9.com/wsadmin/v9_3/AdminWebService?wsdl&user=




• Default version (common to all versions): https://api.five9.com/wsadmin/AdminWebService?wsdl&user=

version 4

To ensure that connections are secure, send all requests by Transport Layer Security protocol (HTTPS) or VPN (IPSec or SSH) to the URL for your version, for example:

https://api.five9.com/wsadmin[/]/AdminWebService

Note In the rest of this guide, the features that apply to these versions are highlighted.data center

Use the data center that applies to you: api.five9.com or api.five9.eu.

About the Five9 Configuration Web Services API Differences Among Versions 4, 3, 2, and Default


Differences Among Versions 4, 3, 2, and DefaultThe differences between API versions 4, 3, 2, and the default are listed in this table.

Version 4 Version 3 Version 2 Default

Data Types

agentPermissionType Added Added

apiOperationType (VIVRCreateSession Version 3) Added

basicImportResult (importTroubles Version 3, keyFields Version 3)

Added

basicImportSettings (countryCode, failOnFieldParseError)

Added Added

campaignStrategies New

campaignStrategy New

campaignStrategyFilter New

campaignStrategyPeriod New

contactFieldRestriction (isEnabled) Deleted Added

importTrouble New

importTroubleKind New

ivrScriptSchedule (chatEnabled, visualModeEnabled)

Added

listDialingMode (EXTENDED_STRATEGY) Added

listUpdateSimpleSettings (countryCode) Added New

passwordPolicies (entryValues) Modified Added Modified

passwordPolicyEntries Removed Added Removed

passwordPolicyEntryValue Removed Added Removed

supervisorPermissionType (CanViewTextDetailsTab Version 3, CanAccessShowFields Version 3)

Added

Methods

addRecordToListSimple New

createContactField Modified Modified Modified

About the Five9 Configuration Web Services API Basic Access Authentication


Basic Access AuthenticationYour HTTPS requests must provide valid Five9 credentials for basic access authentication, which is used by the Web services API to enforce access control.

The credentials included in the header should be those of an administrator. Five9 recommends that you create several administrator users reserved for the Web Services if you plan to send multiple concurrent requests. Otherwise, if you try to use the same user name and password for multiple concurrent requests, your requests are denied, and you receive an exception. The administrator user must have the VCC Administrator role. Be sure to set the appropriate permissions for each administrator.

With HTTP basic authentication, the user name and password are encoded in base 64. In your client, construct your authorization header as follows:

1 Concatenate the user name and password, for example:ExampleUsername:ExamplePassword

2 Encode the string in base 64, for example:RXhhbXBsZVVzZXJOYW1lOkV4YW1wbGVQYXNzd29yZA==

3 In your client, include the Authorization header with the value Basic .

getCampaignStrategies New

getContactFields Modified Modified Modified

modifyContactField Modified Modified Modified

setCampaignStrategies New

setDefaultIVRSchedule (isVisualModeEnabled Version 3, isChatEnabled)

Added

Exceptions

AddRecordToListFault New

CommonCampaignFault Version 3 New

WrongListDialingModeFault New

Version 4 Version 3 Version 2 Default

About the Five9 Configuration Web Services API Basic Access Authentication


Example Web services header with encoded user name and passwordPOST https://api.five9.com/wsadmin/AdminWebService HTTP/1.1Accept-Encoding: gzip,deflateContent-Type: text/xml;charset=UTF-8SOAPAction: ""Authorization: Basic RXhhbXBsZVVzZXJOYW1lOkV4YW1wbGVQYXNzd29yZA==

Chapter2

Data Types

These data types are specific to the Five9 methods used in the requests and responses. For information on primitive data types, refer to www.w3.org/TR/xmlschema-2/.

dates and times

adminConfigTranslationv 9.5Contains configuration translations for the locale..

Note The time zone of a date and time field value passed in a record is determined by the domain’s default time zone. However, to pass the date and time field only in GMT/UTC, use this format: yyyy-mm-dd hh:mm:ss.sss GMT0

Example 2019-06-30 16:00:00.000 GMT0

Name Type Description

comment string Comment about the configuration.

objectField i18NObjectField Object field to be translated.

objectId long Object ID.

objectType i18NObjectType Object type to be translated.

value string Object value.


www.w3.org/TR/xmlschema-2/

Data Types adminPermission

adminPermissionContains the role of the administrator.

adminPermissionTypeContains the list of permissions assigned to an administrator.


type adminPermissionType

Permissions assigned to the administrator.

value boolean Whether to assign the permission.• True: Assign the permission.• False: Do not assign the

permission.


CanUseAdminSoapApiVersion 12

string Can submit requests to the Admin SOAP API if the following permissions are enabled on the VCC Administrator application:

• User Can Execute Web API Requests.

• Corresponding permission. For example, to edit dispositions with the Admin API, enable the corresponding permission User Can Edit Dispositions on the VCC Administrator application.

FullPermissions string Has all the administrator permissions.

ManageUsers string Can manage users.

ManageSkills string Can manage skills.

ManageAgentGroups string Can manage agent groups.


Data Types adminPermissionType

ManageCampaignsStartStop

string Can start and stop a campaign.

ManageCampaignsResetDispositions

string Can reset campaign dispositions.

ManageCampaignsResetListPosition

string Can reset campaign list position.

ManageCampaignsReset string Can reset campaigns.

ManageCampaignsProperties

string Can manage campaign properties.

ManageLists string Can manage lists.

ManageCRM string Can manage CRMs.

ManageDNC string Can manage DNC lists.

EditIvr string Can edit IVRs.

EditProfiles string Can edit user profiles.

EditConnectors string Can edit connectors.

EditDispositions string Can edit dispositions.

EditPrompts string Can edit prompts.

EditReasonCodes string Can edit reason codes.

EditWorkflowRules string Can edit work flow rules.

AccessConfigANI string Can configure ANIs.

EditCallAttachedData string Can edit call variables.

EditTrustedIPAddresses

string Can edit trusted IP addresses.

AccessBillingApplication

string Can enable the Billing Portal.

EditDomainEMailNotificationv 9.5

string Can edit email notifications for the domain.

EditCampaignEMailNotificationv 9.5

string Can edit email notifications for campaigns.



Data Types adminRole

adminRoleContains the role of the administrator.

agentAuditReportCriteriaNo longer used. For report information, see runReport and its data types.

agentAvailability Data type of autodial campaigns that enables the dialer to dial only when agents are available to take calls. If you do not use this object, numbers are dialed continuously whether or not agents are available. See also baseOutboundcampaign.


permissions adminPermission[0..unbounded]

List of permissions assigned to the administrator.


ReadyToReceiveCalls string One or more agents are available, ready, and not on call.

ReadyToReceiveCallsOrBusy

string One or more agents are logged in and are either ready or busy taking or finishing another call. Agents are not considered busy if they are making a manual call after having been on break.

LoggedIn string One or more agents are logged in, regardless of their current status.


Data Types agentGroup

agentGroupContains the details of a single group of agents.

agentPermissionContains the permissions assigned to a user.

agentPermissionTypeContains all the permissions that can be assigned to an agent.


agents string [0..unbounded]

List of agents in the group.

description string Description of the agent group.

id long ID of the group.

name string Name of the group.


type adminPermissionType

Information about the permissions that can be assigned to an agent.

value boolean Whether the agent is assigned the permission.• True: Agent assigned the

permission.• False: Agent not assigned the

permission

Important Agents who log into a PSTN station or forward calls between sessions may incur high long-distance fees. Therefore, be sure to give permission only to the appropriate users.


Data Types agentPermissionType


ReceiveTransfer string Can receive transfers from other agents.

ProcessVoiceMail string Can process skill voicemail messages.

DeleteVoiceMail string Can delete voicemail messages.

TransferVoiceMail string Can transfer voicemail messages to other users and queues.

MakeRecordings string Can record calls or a portion of a call.

SendMessages string Can send messages to agents, administrators, and supervisors.

CreateChatSessions string Can start chat sessions with agents, administrators, and supervisors.

TrainingMode string Can initiate and receive a test call in the agent desktop.

CannotRemoveCRM string Cannot delete contact records. Five9 recommends that you assign this permission to all agents.

CannotEditSession string Cannot edit CRM session notes.

CallForwarding string Can enable call forwarding.

AddingToDNC string Can add numbers to your DNC list. Without this permission, the Add to DNC option in the agent desktop is unavailable, but agents can still use custom dispositions that add numbers to the DNC list.

DialManuallyDNC string Can manually dial the numbers listed in the DNC List. Without this permission, agents see an error message when they dial a number in the DNC list.

CreateCallbacks string Can create callback reminders. Without this permission, the Add Callback button in the agent desktop is disabled.



PlayAudioFiles string Can play prerecorded messages while on call or leave standard recorded messages on answering machines (Play Audio File button). Without this permission, the audio files in the agent desktop are hidden.

SkipCrmInPreviewDialMode

string Can skip records In Preview Dialing Mode. Disabled by default.

ManageAvailabilityBySkill

string Can select the skill groups or ACD queues in which to participate during the active session.

BrowseWebInEmbeddedBrowser

string Can use the browser to open any URL from the agent desktop.

ChangePreviewPreferences

string Can control when and where the preview window is displayed.

CanWrapCall string Can end a call and assign a disposition to it after spending time in the Wrap-Up state. Without this permission, the agent can end a call only by setting a disposition.

CanPlaceCallOnHold string Can place calls on hold.

CanParkCall string Can park a call.

CanRejectCalls string When auto-answer is disabled, the agent can decline incoming calls (typically inbound calls). To use this permission, be sure to enable CanConfigureAutoAnswer.

CanConfigureAutoAnswer

string Can choose whether to auto-answer calls or be prompted before accepting a call. Enabled by default.

ScreenRecording string Do not use.

RecycleDispositionAllowed Version 3

string Enables agents to view and select the Recycle system disposition.

MakeTransferToAgents Version 3

string Can transfer calls to other agents.




MakeTransferToSkills Version 3

string Can transfer calls to skill groups.

MakeTransferToInboundCampaigns Version 3

string Can transfer calls to inbound campaigns.

MakeTransferToExternalCalls Version 3

string Can transfer calls to external phone numbers.

CreateConferenceWithAgents Version 3

string Can create a conference with other agents.

CreateConferenceWithSkills Version 3

string Can create a conference by using skill groups.

CreateConferenceWithInboundCampaigns Version 3

string Can create a conference with inbound campaigns.

CreateConferenceWithExternalCallsVersion 3

string Can create a conference with external call participants.

MakeCallToAgents Version 3

string Can call other agents.

MakeCallToSkills Version 3

string Can call skill groups.

MakeCallToExternalCalls Version 3

string Can make external calls.

CanRunJavaClient Version 4

string Can use the Java client of the Agent Desktop Plus version of the VCC.

CanRunWebClient Version 4

string Can use the Web client of the Agent Desktop Plus version of the VCC.

CanViewMissedCallsVersion 9_3

string Can view and return missed personal calls.

MakeCallToSpeedDialNumberv 9.5

string Can call speed-dial numbers, including external numbers.

CreateConferenceWithSpeedDialNumberv 9.5

string Can add speed-dial numbers to conference calls, including external numbers.




MakeTransferToSpeedDialNumberv 9.5

string Can transfer calls to speed-dial numbers, including external numbers.

CanSelectDisplayLanguagev 9.5

string Can select a language in the softphone settings.

CanViewWebAnalyticsVersion 9_3

string Can view and use web analytics.

CanTransferChatsToAgentsVersion 10

string Can transfer chats to agents.

CanTransferChatsToSkillsVersion 10

string Can transfer chats to queues.

CanTransferEmailsToAgentsVersion 10

string Can transfer email messages to agents.

CanTransferEmailsToSkillsVersion 10

string Can transfer emails to queues.

CanCreateChatConferenceWithAgentsVersion 10

string Can create chat conferences with agents.

CanCreateChatConferenceWithSkillsVersion 10

string Can create chat conferences with queues.

CanTransferSocialsToAgentsVersion 10

string Can transfer social interactions to agents.

CanTransferSocialsToSkillsVersion 10

string Can transfer social interactions to queues.



Data Types agentProductivity

agentProductivityContains the number of seconds used in reports to identify possible deviations from the expected performance of agents.

agentRoleContains the attributes and permissions that can be assigned to an agent.


longACWTime int Number of seconds spent performing work after a call. The time is reported if is longer than this setting.

longCallDuration int Number of seconds spent on a call. The time is reported if is longer than this setting.

longHoldDuration int Number of seconds for a call placed on hold. The time is reported if is longer than this setting.

longParkDuration int Number of seconds for a call waiting in a queue. The time is reported if is longer than this setting.

shortACWTime int Number of seconds spent performing work after a call. The time is reported if is shorter than this setting.

shortCallDuration int Number of seconds spent on a call. The time is reported if it is shorter than this setting.


alwaysRecorded boolean Whether the agent’s calls are recorded.• True: Agent’s calls are recorded.• False: Agent’s calls are not

recorded.This property is required.


Data Types agentState

agentStateRemoved from Version 10.

Contains the possible states for an agent.

attachVmToEmail boolean Whether the agent is allowed to attach a voicemail message to an email message.• True: Agent is allowed.• False: Agent is not allowed.This property is required.

permissions agentPermission [0..unbounded]

List of permissions that can be assigned to an agent.

sendEmailOnVm boolean Whether the agent is allowed to send an email message as a follow-up to a voicemail message.• True: Agent is allowed.• False: Agent is not allowed.This property is required.



AVAILABLE_FOR_CALLS string Available to take calls.

AVAILABLE_FOR_VMS string Available to take voicemail messages.

LOGIN string Logged in or logging in.

LOGOUT string Logged out or logging out.

NOT_AVAILABLE_FOR_CALLS

string Not available to take calls.

NOT_AVAILABLE_FOR_VMS

string Not available to take voicemail messages.

NOT_READY string Not ready.

READY string Ready.


Data Types apiOperationType

apiOperationTypeContains the possible types of operation. QueryStatistics and QueryChangedStatistics do not apply to the Configuration Web Services API

VM_IN_PROGRESS string Currently taking a voicemail message.

VM_NOT_AVAILABLE string Voicemail not available.

WAITING string Waiting.


Name Type Examples

Query string getListsInfoModify string addSkillToCampaignUpload string createCampaignSingleUpload string addRecordToListReportRequest string runReportRetrieveReport string getReportResultAsynchronousUpload string asyncAddRecordsToListQueryStatistics string getStatisticsQueryChangedStatistics

string getStatisticsUpdate

Web2CampaignUpload string Not used.VIVRCreateSession Version 3

string No specific method.


Data Types autodialCampaign

autodialCampaignContains the attributes of an autodial campaign. autodialCampaign extends baseOutboundCampaign.

baseOutboundcampaignThis section contains information about campaigns:

autodialCampaign outboundCampaign

autodialCampaignContains information about autodial campaigns. It is used by createAutodialResponse, getAutodialCampaignResponse, and modifyAutodialCampaign


baseOutboundCampaign autodialCampaign Attributes of an autodial campaign.

Name Type Examples

agentAvailability agentAvailability Types of agent states considered available. Autodial campaigns dial only agents that are available to process calls. If omitted, the list is dialed continuously regardless of agent availability.

agentSkillName string Numbers dialed only if agents with the specified skill are available. If empty when dialIfAgentsAvailable=True, agent availability is for any skill.When modifyAutodialCampaign specifies agentSkillName=null, the value remains.

defaultIvrSchedule ivrScriptSchedule Schedule of the IVR script that processes call flow. Required for inbound and autodial calls.


Data Types baseOutboundcampaign

outboundCampaignContains information about outbound campaigns. All data types used by createOutboundCampaign are listed below. Depending on the campaign mode and your goal, you can use these flags as follows:

This figure shows the relationship between the groups of elements.

dialIfAgentsAvailable

boolean Whether to dial numbers only if agents with agentSkillName are available.• True: Dial only if agents are

available in the skill group.• False: Dial regardless of agent

availability in the skill group.

maxNumOfLines int Maximum number of outbound phone lines dedicated to the campaign.

Name Type Examples

Goal limitPreviewTime dialNumberOnTimeout previewDialImmediately

Unlimited preview time

false false

Limited preview time

true false

Dial number true true false

Set agent to not ready

true false false

Dial immediately

true




actionOnAnswerMachine

campaignDialingAction

Action to take when the answering machine is detected.

actionOnQueueExpiration

campaignDialingAction

Action to take when the maximum queue time expires, which occurs when no agent is available to take a call.

callAnalysisMode callAnalysisMode Types of attempts when a call is answered.

callsAgentRatio double For campaigns in the power mode, count of phone numbers dialed for an agent ready for a new call.

dialNumberOnTimeout boolean For campaigns in the preview mode, use as follows:• True: Dial number when preview

time expires.• False: Set agent to Not Ready

state.

dialingMode campaignDialingMode

Types of dialing modes.



dialingPriorityv 9.5

int Method to set the dialing priority of the running outbound campaign by assigning a priority to each campaign. The default for all campaigns is 3; the range is 1 to 99.To enable this feature, see campaignsSettings.

dialingRatiov 9.5

int Method to set the dialing priority of the running outbound campaign by using a ratio (1 to 99). The default is 50.To enable this feature, see campaignsSettings.

distributionAlgorithm

distributionAlgorithm

Method used by the ACD to transfer calls to agents.

distributionTimeFrame

distributionTimeFrame

Time intervals used by distributionAlgorithm.

limitPreviewTime boolean For campaigns in the preview mode, use as follows: • True: Dial contact number after

maxPreviewTime.• False: Allow agents to preview the

contact number for an unlimited time.

maxDroppedCallsPercentage

float Maximum allowed percentage of dropped calls. Use when monitorDroppedCalls is set to true.

maxPreviewTime timer Duration until expiration of the preview time.

maxQueueTime timer Maximum time allowed for calls in a queue.




monitorDroppedCalls boolean Whether to keep track of the dropped call percentage of the campaign.• True: Keep track of the dropped

calls for the last 30 days or since the last reset.

• False: Do not keep track of the dropped calls.

previewDialImmediately

boolean For outbound campaigns in preview mode, use as follows:• True: Automatically dial the

number without waiting for an action from the agent.

• False: Do not dial the number automatically.

useTelemarketingMaxQueTimeEq1v 9.5

boolean Whether to enable maximum queue time for telemarketing in campaigns to one second.

generalCampaign.

analyzeLevel int Voice detection level for an answering machine. The values range from 0 (fast detection) to 11 (accurate detection).

CRMRedialTimeout timer Minimum time before redialing a contact record after all numbers for the contact record have been dialed or skipped. The default is 10 minutes.

dnisAsAni boolean When transferring calls to third parties, whether to override the default DNIS of the domain by using the contact’s phone number (ANI) as the DNIS (caller ID).• True: Override the default DNIS.• False: Do not override the default

DNIS.




enableListDialingRatios

boolean Whether to use list dialing ratios, which enable multiple lists to be dialed at specified frequencies.• True: Enable dialing ratios.• False: Do not enable dialing ratios.

listDialingMode listDialingMode Describes the list dialing mode.

noOutOfNumbersAlert boolean When an outbound campaign runs out of numbers to dial, whether to turn off notification messages to administrators and supervisors that the campaign is no longer dialing because the lists are complete.• True: Turn off notification

messages.• False: Do not turn off notification

messages.

stateDialingRulev 9.5

campaignStateDialingRule

How dialing rule options are used in the campaign.

timeZoneAssignmentv 9.5

campaignTimeZoneAssignment

How time zone are assigned the campaign.

campaign.

autoRecord boolean Whether to record all calls of the campaign.• True: Record all calls.• False: Do not record all calls.

callWrapup campaignCallWrapup

Details for the work time after the call.

ftpHost string Host name of the FTP server.

ftpPassword string Password of the FTP server.

ftpUser string User name for the FTP server.



Data Types basicImportResult

basicImportResultContains information about rejected records.

recordingNameAsSid boolean For FTP transfer, whether to use the session ID as the recording name.• True: Use the session ID as

recording name.• False: Do not use the session ID as

recording name.

useFtp boolean Whether to use FTP to transfer recordings.• True: Use FTP to transfer

recordings• False: Do not use FTP to transfer

recordings.



failureMessage string Description of the error sent to your email address or in the newly added callback messages.

importIdentifierv 9.5

string Identifier used to check the status and outcome of a data import operation.

importTroubles Version 3

importTrouble Reason for the rejection.

keyFields Version 3 string Set of fields marked as keys that define the rejected record.

successv 9.5

boolean Whether the request was successful.

uploadDuplicatesCount

long Number of duplicate contact records inserted.

uploadErrorsCount long Number of errors in the updated contact records.


Data Types basicImportResult

In addition, these data types use basicImportRresult:crmImportResultdispositionsImportResultlistImportResult

This figure shows the relationship between the data types.

crmImportResultContains the number of modified contact records.

dispositionsImportResultContains the number of updated disposition records.

warningsCount entry [0..unbounded]

Number of warnings associated with the imported data.



crmRecordsDeleted long Number of deleted contact records.

crmRecordsInserted long Number of inserted contact records.

crmRecordsUpdated long Number of updated contact records.


dispRecordsUpdated long Number of updated disposition records.


Data Types basicImportSettings

listImportResultContains information about the modified contact records.

basicImportSettingsContains the settings for updating all lists and contacts.


callNowQueued long Number of records in the Call Now queue.

crmRecordsInserted long long Number of inserted contact records.

crmRecordsUpdated long long Number of updated contact records.

listName string Name of list into which data was imported.

listRecordsDeleted long Number of deleted list records.

listRecordsInserted long Number of inserted list records.


allowDataCleanup boolean Whether to remove duplicate entries from a list.• True: Remove duplicate entries.• False: Ignore duplicate entries.

callbackFormatv 9.5

callbackFormat File format of the HTTP callback message.

callbackUrlv 9.5

string URL of the callback passed in the batch method.

countryCode

countryCode Version 4 string Two-letter codes defined in ISO 3166-1.


https://www.iso.org/obp/ui/#search/code


failOnFieldParseErrorVersion 3

boolean Whether to stop the import if incorrect data is found:• True: The record is rejected when

at least one field fails validation.• False: Default. The record is

accepted. However, changes to the fields that fail validation are rejected.

fieldsMapping fieldEntry [1..unbounded]

Mapping of the column number to the field name in the contact database.

Important For listUpdateSettings, the column number starts at 1 whereas for listUpdateSimpleSettings, the column number starts at 0.

reportEmail string Notification about import results is sent to the email addresses that you set for your application. See also basicImportResult.The following methods ignore the value of reportEmail:• addRecordToList• addRecordToListSimple• deleteRecordFromList• updateCrmRecord• asyncAddRecordsToList• asyncDeleteRecordsFromList• asyncUpdateCrmRecords• asyncUpdateCampaignDispositi

onsseparator string Any ASCII character, such as a comma,

used to separate entries in a list.

skipHeaderLine boolean Whether to omit the top row that contains the names of the fields.• True: Omit the top row.• False: Include the top row.




These data types use basicImportSettings:crmDeleteSettingscrmUpdateSettingsdispositionsUpdateSettingslistDeleteModelistUpdateSettings

This figure shows the relationship between the data types.

crmDeleteSettingsContains deletion settings.

crmUpdateSettingsContains the CRM update settings.


crmDeleteMode crmDeleteMode Information about the deletion settings.


crmAddMode crmAddMode Describes how to add a contact record.

crmUpdateMode crmUpdateMode Describes how to update a contact record.



dispositionsUpdateSettingsContains the disposition update settings.

listDeleteModeContains the options for deleting records from a list.


commonDispositionValue

string Disposition value when the same disposition is assigned to all records in the list.

dispositionColumnNumber

int Column number for the disposition value of a record. The column is created when not assigning the same disposition for all records in the list.

dispositionsUpdateMode

dispositionsUpdateMode

Describes how dispositions are updated.

updateToCommonDisposition

boolean For all records, whether to use the disposition value specified in commonDispositionValue.• True: Use

commonDispositionValue.• False: Do not use

commonDispositionValue.

warnIfNoCrmMatchFound

boolean Whether to add a warning in the import transaction report when records do not match a CRM record.• True: Warn when no CRM match

exists.• False: Do not warn when no CRM

match exists.


DELETE_ALL string Delete all records. Does not apply to single record transactions, such as with the deleteRecordFromList method.



listUpdateSettingsContains the list update settings.

DELETE_IF_SOLE_CRM_MATCH

string Delete only if a single match is found in the database.

DELETE_EXCEPT_FIRST string Delete all records except the first matched record.



callNowColumnNumber int Column number, starting with 1.If a record should be dialed immediately, the content of the column is 1, T, Y, and Yes. This column is not included in the fieldsMapping parameter and is not imported in the contact database.If callNowMode is also specified, only records that have a true value and apply to callNowMode are called immediately.If you do not want to add a column for each imported record, use callNowMode singly.

callNowMode callNowMode Whether records are dialed immediately.If callNowColumnNumber is also specified, callNowMode applies to all records with a true value in the specified column.If callNowColumnNumber is omitted, the callNowMode applies to all records imported by the request.



callTime long When to dial the records (Epoch time in milliseconds); applies to all records in the request, except for those with a value in the timeToCallColumn; does not apply to the addToList method, which is used to process batch record transactions.Note The call time value is applied only if the campaign exists when the record is added to the list assigned to that campaign. However, if a campaign is created or associated with a list after the record is added to the list, calls may be dialed sooner than the specified value, depending on the size of the list, the position of the record in the list, and the other parameters assigned to the list in the campaign.

callTimeColumnNumber int Column that contains the times (Epoch time) to call individual records. If a record contains a valid time, this time is used instead of the callTime parameter. Does not apply to the addToList method, which is used to process batch record transactions.

cleanListBeforeUpdate

boolean Whether all records in the list should be removed before adding new records.• True: Remove records before

adding new ones.• False: Do not remove records

before adding new ones.

crmAddMode crmAddMode Whether contact records should be added when a new record is inserted into a dialing list.

crmUpdateMode crmUpdateMode Whether contact records should be updated when a record is added to a dialing list.

listAddMode listAddMode Describes how to update the list.



http://en.wikipedia.org/wiki/Unix_timehttp://en.wikipedia.org/wiki/Unix_timehttp://en.wikipedia.org/wiki/Unix_time

Data Types callCounterState

callCounterStateContains the maximum number and count of requests sent for a specific operation type in a specific time period.

callNowModeContains the records that are dialed immediately.

callAnalysisModeContains the types of attempts when a call is answered.


limit long Limit of the operation.

operationType apiOperationType Type of operation.

value long Number of requests already sent in that time interval.


NONE string Default. No records are dialed immediately.

NEW_CRM_ONLY string Newly created CRM records are dialed immediately.

NEW_LIST_ONLY string New list records are dialed immediately even if the corresponding CRM records existed before the import.

ANY string All imported records are dialed immediately.


NO_ANALYSIS string No detection is attempted.


Data Types callLogReportCriteria

callLogReportCriteriaNo longer used. For report information, see runReport and its data types.

callTypeRemoved from Version 10.

Contains the options used in reports to qualify calls or parts of calls.

FAX_ONLY string Fax detection is attempted.

FAX_AND_ANSWERING_MACHINE

string Fax and answering machine detection are attempted.



AGENT string Call dialed manually by an agent.

AUTODIAL string Call in an autodial campaign.

INBOUND string Call in an inbound campaign.

INBOUND_VOICEMAIL string Voicemail in an inbound campaign.

INTERNAL string Call made in your Five9 domain.

INTERNAL_VOICEMAIL string Voicemail made within your Five9 domain.

OUTBOUND string Call in an outbound campaign.

OUTBOUND_PREVIEW string Call in preview mode made in an outbound campaign.

OUTBOUND_VOICEMAIL string Voicemail made in an outbound campaign.

TEST string Test call.


Data Types callVariable

callVariableContains the details of a call variable.


applyToAllDispositions

boolean Whether to use the variable for all dispositions.• True: Use the variable for all

dispositions.• False: Do not use the variable for

all dispositions.

defaultValue string Optional value that may be assigned to a call variable. Some data types (callVariableType) can have a default value.

description string Description of the variable.

dispositions string [0..unbounded]

If applyToAllDispositions is false, this parameter lists the names of the dispositions for which to set this variable.

group string Group name of the call variable.

name string Name of the call variable.

reporting boolean Whether to add the values to reports:True: Variables are added to reports.False: Default. Variables are not added to reports.

restrictions callVariableRestriction [0..unbounded]

Possible values of the variable.

sensitiveDatav 9.5

boolean Whether the variable contains personal data that identifies the customer.

type callVariableType One of the available types of call variables.


Data Types callVariableRestriction

callVariableRestrictionContains the restriction values of a call variable.

callVariableTypeContains the possible data types of a call variable.


type cavRestrictionType

One of the available restrictions.

value string Value by which to limit the variable.


STRING string Letters and numbers.

NUMBER string N

configuration web services - five9 · 2 configuration web services • api reference guide about...

Documents

Five9 Virtual Contact Center · ii Basic Administrator’s Guide About Five9 Five9 is the leading provider of cloud contact center software, bringing the power of the cloud to thousands

PIN Services OpenVPN Configuration

Five9 Virtual Contact Center - Cloud Contact Center … · Five9 is the leading provider of cloud contact center software, ... Description of Dashboard Widgets ... and social media

Five9 Virtual Contact Center Agent’s Installation Guide for Mac OS About Five9 Five9 is the leading provider of cloud contact center software, bringing the power of the cloud to

Five9 Plus Adapter for Salesforce - Call Center Software Five9 Plus Adapter for Salesforce • Administrator’s Guide About Five9 Five9 is the leading provider of cloud contact center

Statistics Web Services - Five9 · Statistics Web Services API Reference Guide ... Five9 delivers secure, ... The Five9 Statistics Web Services API enables developers to build secure

Five9 Virtual Contact Center · Five9 is the leading provider of cloud contact center software, bringing the power of the cloud to thousands of customers and facilitating more than

Five9 sfdc sales presentation july 23 2014 (1)

Five9 Plus Adapter for Microsoft Dynamics CRM · ii Five9 Plus Adapter for Micosoft Dynamics CRM • Agent’s Guide About Five9 Five9 is the leading provider of cloud contact center

PerformancePoint Services 2010 Configuration

Dart Configuration Management Services

Five9 Adapter for Velocifywebapps.five9.com/.../integrations/velocify/velocify-agents-guide.pdf · ii Five9 Adapter for Velocify • Agent’s Guide About Five9 Five9 is the leading

Five9 Open CTI Adapter for Salesforce Five9 Open CTI Adapter for Salesforce • Administrator’s Guide About Five9 Five9 is the leading provider of cloud contact center software,

Five9 Confidential 1 The Five9 Virtual Contact Center TM

Five9 Technical Requirements - Cloud Contact … is the leading provider of cloud contact center software, ... viii Five9 Technical Requirements Chapter 3What’s New ... • TLS_ECDHE_RSA_WITH_AES_256_GCM

Five9 sfdc sales presentation july 23 2014

Q3 2020 Investor Presentation - Five9, Inc

CallTower for Five9 Virtual Contact Center Suite Guide_CallTower... · 2020-01-10 · CallTower for Five9 Virtual Contact Center Suite Feature Guide 0 OVERVIEW The Five9® Virtual

Five9 (Nasdaq:FIVN) Deserves a High Five Report.pdf · Five9 (Nasdaq:FIVN) Deserves a High Five EXECUTIVE SUMMARY Q1 2018 Financial Results Crush Analyst Estimates On May 1 Five9

Five9 Plus Adapter for Microsoft Dynamics CRM · Managing the Five9 Plus Adapter for Microsoft Dynamics CRM ... 8 To finish preparing your softphone for the session, see the next

Five9, InsideSales, Interactive Intelligence,inContact | Company Showdown

Five9 Open CTI Adapter for Salesforcewebapps.five9.com/.../salesforce-open-cti-administrators-guide.pdf · ii Five9 Open CTI Adapter for Salesforce • Administrator’s Guide About

Five9, Inc

Five9 Plus Adapter for Microsoft Dynamics CRM · without notice, and are provided without warranty of any ki nd, express or ... Managing the Five9 Plus Adapter for Microsoft Dynamics

Five9 Technical Requirements - gallery.azure.com · Digital Certificates ... Five9 Java-Based Application ... Environment and Security Technical Requirements Digital Certificates

How Five9 Doubled Their Lead Volume & Added $8.6M Annually Using Leadspace

Five9 Data Sheet ACD

Fuze + Five9€¦ · The Five9 Fuze UC integration connects Fuze’s Unified Communications as a Service (UCaaS) platform, and Five9’s Contact Center as a Service (CCaaS) solution

Logging into Five9 Telephony · Five9. (Other projects may log in to the Five9 MTM or Voxco telephony system). Take note of the Telephony Username you will use to login to your project’s

Deployment Services - POSDATA Group€¦ · Deployment Services. Configuration, deployment and installation services for your data collection technologies. Product Configuration/Staging

Five9 Award Write Up

Five9 Adapter for Velocify€™s New ... April 2015 • Added information about upgrading from a previous Five9 release. ... CRM with Five9 connectors to manage screen pops and lead

Five9 Plus Adapter for Agent Desktop Toolkit · iv Five9 Plus Adapter for Agent Desktop Toolkit • Administrator’s Guide Configuring the Browser

Five9 OutsOurcing - QTSC · 6 FIVE9 OUTSOURCING FIVE9 VIETNAM CORPORATION 7 BLOCKCHAIN SALE & MARKETING IOT HEALTH CARE TELECOM BANKING & ... AngularJs/Angular2, ReactJs, KnockoutJs,

Five9 Virtual Contact Center - Cloud Contact Center … · Five9 is the leading provider of cloud contact center software, ... Character Limits for Domain ... Configuring Profiles