Admin Web Service

Web Service: WsAdminService

Methods

Methods are accessible under the service attribute of a client instance.

AdminWebService.addDNISToCampaign([campaignName, DNISList])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • DNISList – AdminWebService.StringType (optional)
Return type:

AdminWebService.addDNISToCampaignResponse
AdminWebService.addDispositionsToCampaign([campaignName, dispositions, isSkipPreviewDisposition])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • dispositions – AdminWebService.StringType (optional)
  • isSkipPreviewDisposition – AdminWebService.BooleanType (optional)
Return type:

AdminWebService.addDispositionsToCampaignResponse
AdminWebService.addListsToCampaign([campaignName, lists])
Parameters:
Return type:

AdminWebService.addListsToCampaignResponse
AdminWebService.addNumbersToDnc([numbers])
Parameters:numbers – AdminWebService.StringType (optional)
Return type:AdminWebService.addNumbersToDncResponse
AdminWebService.addPromptTTS([prompt, ttsInfo])
Parameters:
Return type:

AdminWebService.addPromptTTSResponse
AdminWebService.addPromptWav([prompt, wavFile])
Parameters:
Return type:

AdminWebService.addPromptWavResponse
AdminWebService.addPromptWavInline([prompt, wavFile])
Parameters:
Return type:

AdminWebService.addPromptWavInlineResponse
AdminWebService.addRecordToList([listName, listUpdateSettings, record])
Parameters:
Return type:

AdminWebService.addRecordToListResponse
AdminWebService.addRecordToListSimple([listName, listUpdateSimpleSettings, record])
Parameters:
Return type:

AdminWebService.addRecordToListSimpleResponse
AdminWebService.addSkillAudioFile([skillName, promptName])
Parameters:
  • skillName – AdminWebService.StringType (optional)
  • promptName – AdminWebService.StringType (optional)
Return type:

AdminWebService.addSkillAudioFileResponse
AdminWebService.addSkillsToCampaign([campaignName, skills])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • skills – AdminWebService.StringType (optional)
Return type:

AdminWebService.addSkillsToCampaignResponse
AdminWebService.addToList([listName, listUpdateSettings, importData])
Parameters:
Return type:

AdminWebService.addToListResponse
AdminWebService.addToListCsv([listName, listUpdateSettings, csvData])
Parameters:
  • listName – AdminWebService.StringType (optional)
  • listUpdateSettings – AdminWebService.listUpdateSettings (optional)
  • csvData – AdminWebService.StringType (optional)
Return type:

AdminWebService.addToListCsvResponse
AdminWebService.addToListFtp([listName, updateSettings, ftpSettings])
Parameters:
Return type:

AdminWebService.addToListFtpResponse
AdminWebService.asyncAddRecordsToList([listName, listUpdateSettings, importData, resetDispositionsInCampaignsImportData])
Parameters:
Return type:

AdminWebService.asyncAddRecordsToListResponse
AdminWebService.asyncDeleteRecordsFromList([listName, listDeleteSettings, importData])
Parameters:
Return type:

AdminWebService.asyncDeleteRecordsFromListResponse
AdminWebService.asyncUpdateCampaignDispositions([campaignName, dispositionsUpdateSettings, importData])
Parameters:
Return type:

AdminWebService.asyncUpdateCampaignDispositionsResponse
AdminWebService.asyncUpdateCrmRecords([crmUpdateSettings, importData])
Parameters:
Return type:

AdminWebService.asyncUpdateCrmRecordsResponse
AdminWebService.checkDncForNumbers([numbers])
Parameters:numbers – AdminWebService.StringType (optional)
Return type:AdminWebService.checkDncForNumbersResponse
AdminWebService.closeSession(parameters)
Parameters:parameters – AdminWebService.closeSession
Return type:AdminWebService.closeSessionResponse
AdminWebService.createAgentGroup([group])
Parameters:group – AdminWebService.agentGroup (optional)
Return type:AdminWebService.createAgentGroupResponse
AdminWebService.createAutodialCampaign([campaign])
Parameters:campaign – AdminWebService.autodialCampaign (optional)
Return type:AdminWebService.createAutodialCampaignResponse
AdminWebService.createCallVariable([variable])
Parameters:variable – AdminWebService.callVariable (optional)
Return type:AdminWebService.createCallVariableResponse
AdminWebService.createCallVariablesGroup([name, description])
Parameters:
  • name – AdminWebService.StringType (optional)
  • description – AdminWebService.StringType (optional)
Return type:

AdminWebService.createCallVariablesGroupResponse
AdminWebService.createCampaignProfile([campaignProfile])
Parameters:campaignProfile – AdminWebService.campaignProfileInfo (optional)
Return type:AdminWebService.createCampaignProfileResponse
AdminWebService.createContactField([field])
Parameters:field – AdminWebService.contactField (optional)
Return type:AdminWebService.createContactFieldResponse
AdminWebService.createDisposition([disposition])
Parameters:disposition – AdminWebService.disposition (optional)
Return type:AdminWebService.createDispositionResponse
AdminWebService.createIVRScript([name])
Parameters:name – AdminWebService.StringType (optional)
Return type:AdminWebService.createIVRScriptResponse
AdminWebService.createInboundCampaign([campaign])
Parameters:campaign – AdminWebService.inboundCampaign (optional)
Return type:AdminWebService.createInboundCampaignResponse
AdminWebService.createList([listName])
Parameters:listName – AdminWebService.StringType (optional)
Return type:AdminWebService.createListResponse
AdminWebService.createOutboundCampaign([campaign])
Parameters:campaign – AdminWebService.outboundCampaign (optional)
Return type:AdminWebService.createOutboundCampaignResponse
AdminWebService.createReasonCode([reasonCode])
Parameters:reasonCode – AdminWebService.reasonCode (optional)
Return type:AdminWebService.createReasonCodeResponse
AdminWebService.createSkill([skillInfo])
Parameters:skillInfo – AdminWebService.skillInfo (optional)
Return type:AdminWebService.createSkillResponse
AdminWebService.createUser([userInfo])
Parameters:userInfo – AdminWebService.userInfo (optional)
Return type:AdminWebService.createUserResponse
AdminWebService.createUserProfile([userProfile])
Parameters:userProfile – AdminWebService.userProfile (optional)
Return type:AdminWebService.createUserProfileResponse
AdminWebService.createWebConnector([connector])
Parameters:connector – AdminWebService.webConnector (optional)
Return type:AdminWebService.createWebConnectorResponse
AdminWebService.deleteAgentGroup([groupName])
Parameters:groupName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteAgentGroupResponse
AdminWebService.deleteAllFromList([listName, reportEmail, callbackUrl, callbackFormat])
Parameters:
  • listName – AdminWebService.StringType (optional)
  • reportEmail – AdminWebService.StringType (optional)
  • callbackUrl – AdminWebService.StringType (optional)
  • callbackFormat – AdminWebService.callbackFormat (optional)
Return type:

AdminWebService.deleteAllFromListResponse
AdminWebService.deleteCallVariable([name, groupName])
Parameters:
  • name – AdminWebService.StringType (optional)
  • groupName – AdminWebService.StringType (optional)
Return type:

AdminWebService.deleteCallVariableResponse
AdminWebService.deleteCallVariablesGroup([name])
Parameters:name – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteCallVariablesGroupResponse
AdminWebService.deleteCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteCampaignResponse
AdminWebService.deleteCampaignProfile([profileName])
Parameters:profileName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteCampaignProfileResponse
AdminWebService.deleteContactField([fieldName])
Parameters:fieldName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteContactFieldResponse
AdminWebService.deleteFromContacts([crmDeleteSettings, importData])
Parameters:
Return type:

AdminWebService.deleteFromContactsResponse
AdminWebService.deleteFromContactsCsv([crmDeleteSettings, csvData])
Parameters:
Return type:

AdminWebService.deleteFromContactsCsvResponse
AdminWebService.deleteFromContactsFtp([deleteSettings, ftpSettings])
Parameters:
Return type:

AdminWebService.deleteFromContactsFtpResponse
AdminWebService.deleteFromList([listName, listDeleteSettings, importData])
Parameters:
Return type:

AdminWebService.deleteFromListResponse
AdminWebService.deleteFromListCsv([listName, listDeleteSettings, csvData])
Parameters:
  • listName – AdminWebService.StringType (optional)
  • listDeleteSettings – AdminWebService.listDeleteSettings (optional)
  • csvData – AdminWebService.StringType (optional)
Return type:

AdminWebService.deleteFromListCsvResponse
AdminWebService.deleteFromListFtp([listName, deleteSettings, ftpSettings])
Parameters:
Return type:

AdminWebService.deleteFromListFtpResponse
AdminWebService.deleteIVRScript([name])
Parameters:name – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteIVRScriptResponse
AdminWebService.deleteLanguagePrompt([promptName, language])
Parameters:
  • promptName – AdminWebService.StringType (optional)
  • language – AdminWebService.StringType (optional)
Return type:

AdminWebService.deleteLanguagePromptResponse
AdminWebService.deleteList([listName])
Parameters:listName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteListResponse
AdminWebService.deletePrompt([promptName])
Parameters:promptName – AdminWebService.StringType (optional)
Return type:AdminWebService.deletePromptResponse
AdminWebService.deleteReasonCode([reasonCodeName])
Parameters:reasonCodeName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteReasonCodeResponse
AdminWebService.deleteReasonCodeByType([reasonCodeName, type])
Parameters:
Return type:

AdminWebService.deleteReasonCodeByTypeResponse
AdminWebService.deleteRecordFromList([listName, listDeleteSettings, record])
Parameters:
Return type:

AdminWebService.deleteRecordFromListResponse
AdminWebService.deleteSkill([skillName])
Parameters:skillName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteSkillResponse
AdminWebService.deleteUser([userName])
Parameters:userName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteUserResponse
AdminWebService.deleteUserProfile([userProfileName])
Parameters:userProfileName – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteUserProfileResponse
AdminWebService.deleteWebConnector([name])
Parameters:name – AdminWebService.StringType (optional)
Return type:AdminWebService.deleteWebConnectorResponse
AdminWebService.forceStopCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.forceStopCampaignResponse
AdminWebService.getAgentAuditReport([time, criteria])
Parameters:
Return type:

AdminWebService.getAgentAuditReportResponse
AdminWebService.getAgentAuditReportCsv([time, criteria])
Parameters:
Return type:

AdminWebService.getAgentAuditReportCsvResponse
AdminWebService.getAgentGroup([groupName])
Parameters:groupName – AdminWebService.StringType (optional)
Return type:AdminWebService.getAgentGroupResponse
AdminWebService.getAgentGroups([groupNamePattern])
Parameters:groupNamePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getAgentGroupsResponse
AdminWebService.getApiVersions(parameters)
Parameters:parameters – AdminWebService.getApiVersions
Return type:AdminWebService.getApiVersionsResponse
AdminWebService.getAutodialCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.getAutodialCampaignResponse
AdminWebService.getAvailableLocales(parameters)
Parameters:parameters – AdminWebService.getAvailableLocales
Return type:AdminWebService.getAvailableLocalesResponse
AdminWebService.getCallCountersState(parameters)
Parameters:parameters – AdminWebService.getCallCountersState
Return type:AdminWebService.getCallCountersStateResponse
AdminWebService.getCallLogReport([time, criteria])
Parameters:
Return type:

AdminWebService.getCallLogReportResponse
AdminWebService.getCallLogReportCsv([time, criteria])
Parameters:
Return type:

AdminWebService.getCallLogReportCsvResponse
AdminWebService.getCallVariableGroups([namePattern])
Parameters:namePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getCallVariableGroupsResponse
AdminWebService.getCallVariables([namePattern, groupName])
Parameters:
  • namePattern – AdminWebService.StringType (optional)
  • groupName – AdminWebService.StringType (optional)
Return type:

AdminWebService.getCallVariablesResponse
AdminWebService.getCampaignDNISList([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.getCampaignDNISListResponse
AdminWebService.getCampaignProfileDispositions([profileName])
Parameters:profileName – AdminWebService.StringType (optional)
Return type:AdminWebService.getCampaignProfileDispositionsResponse
AdminWebService.getCampaignProfileFilter([profileName])
Parameters:profileName – AdminWebService.StringType (optional)
Return type:AdminWebService.getCampaignProfileFilterResponse
AdminWebService.getCampaignProfiles([namePattern])
Parameters:namePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getCampaignProfilesResponse
AdminWebService.getCampaignState([campaignName, waitUntilChange])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • waitUntilChange – AdminWebService.LongType (optional)
Return type:

AdminWebService.getCampaignStateResponse
AdminWebService.getCampaignStrategies([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.getCampaignStrategiesResponse
AdminWebService.getCampaigns([campaignNamePattern, campaignType])
Parameters:
Return type:

AdminWebService.getCampaignsResponse
AdminWebService.getConfigurationTranslations([localeName])
Parameters:localeName – AdminWebService.StringType (optional)
Return type:AdminWebService.getConfigurationTranslationsResponse
AdminWebService.getContactFields([namePattern])
Parameters:namePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getContactFieldsResponse
AdminWebService.getContactRecords([lookupCriteria])
Parameters:lookupCriteria – AdminWebService.crmLookupCriteria (optional)
Return type:AdminWebService.getContactRecordsResponse
AdminWebService.getCrmImportResult([identifier])
Parameters:identifier – AdminWebService.importIdentifier (optional)
Return type:AdminWebService.getCrmImportResultResponse
AdminWebService.getDNISList([selectUnassigned])
Parameters:selectUnassigned – AdminWebService.BooleanType (optional)
Return type:AdminWebService.getDNISListResponse
AdminWebService.getDialingRules([namePattern])
Parameters:namePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getDialingRulesResponse
AdminWebService.getDisposition([dispositionName])
Parameters:dispositionName – AdminWebService.StringType (optional)
Return type:AdminWebService.getDispositionResponse
AdminWebService.getDispositions([dispositionNamePattern])
Parameters:dispositionNamePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getDispositionsResponse
AdminWebService.getDispositionsImportResult([identifier])
Parameters:identifier – AdminWebService.importIdentifier (optional)
Return type:AdminWebService.getDispositionsImportResultResponse
AdminWebService.getIVRScripts([namePattern])
Parameters:namePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getIVRScriptsResponse
AdminWebService.getInboundCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.getInboundCampaignResponse
AdminWebService.getListImportResult([identifier])
Parameters:identifier – AdminWebService.importIdentifier (optional)
Return type:AdminWebService.getListImportResultResponse
AdminWebService.getListsForCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.getListsForCampaignResponse
AdminWebService.getListsInfo([listNamePattern])
Parameters:listNamePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getListsInfoResponse
AdminWebService.getLocale(parameters)
Parameters:parameters – AdminWebService.getLocale
Return type:AdminWebService.getLocaleResponse
AdminWebService.getOutboundCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.getOutboundCampaignResponse
AdminWebService.getPrompt([promptName])
Parameters:promptName – AdminWebService.StringType (optional)
Return type:AdminWebService.getPromptResponse
AdminWebService.getPrompts(parameters)
Parameters:parameters – AdminWebService.getPrompts
Return type:AdminWebService.getPromptsResponse
AdminWebService.getReasonCode([reasonCodeName])
Parameters:reasonCodeName – AdminWebService.StringType (optional)
Return type:AdminWebService.getReasonCodeResponse
AdminWebService.getReasonCodeByType([reasonCodeName, type])
Parameters:
Return type:

AdminWebService.getReasonCodeByTypeResponse
AdminWebService.getReportResult([identifier])
Parameters:identifier – AdminWebService.StringType (optional)
Return type:AdminWebService.getReportResultResponse
AdminWebService.getReportResultCsv([identifier])
Parameters:identifier – AdminWebService.StringType (optional)
Return type:AdminWebService.getReportResultCsvResponse
AdminWebService.getSkill([skillName])
Parameters:skillName – AdminWebService.StringType (optional)
Return type:AdminWebService.getSkillResponse
AdminWebService.getSkillAudioFiles([skillName])
Parameters:skillName – AdminWebService.StringType (optional)
Return type:AdminWebService.getSkillAudioFilesResponse
AdminWebService.getSkillInfo([skillName])
Parameters:skillName – AdminWebService.StringType (optional)
Return type:AdminWebService.getSkillInfoResponse
AdminWebService.getSkillVoicemailGreeting([skillName])
Parameters:skillName – AdminWebService.StringType (optional)
Return type:AdminWebService.getSkillVoicemailGreetingResponse
AdminWebService.getSkills([skillNamePattern])
Parameters:skillNamePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getSkillsResponse
AdminWebService.getSkillsInfo([skillNamePattern])
Parameters:skillNamePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getSkillsInfoResponse
AdminWebService.getUserGeneralInfo([userName])
Parameters:userName – AdminWebService.StringType (optional)
Return type:AdminWebService.getUserGeneralInfoResponse
AdminWebService.getUserInfo([userName])
Parameters:userName – AdminWebService.StringType (optional)
Return type:AdminWebService.getUserInfoResponse
AdminWebService.getUserProfile([userProfileName])
Parameters:userProfileName – AdminWebService.StringType (optional)
Return type:AdminWebService.getUserProfileResponse
AdminWebService.getUserProfiles([userProfileNamePatern])
Parameters:userProfileNamePatern – AdminWebService.StringType (optional)
Return type:AdminWebService.getUserProfilesResponse
AdminWebService.getUserVoicemailGreeting([userName])
Parameters:userName – AdminWebService.StringType (optional)
Return type:AdminWebService.getUserVoicemailGreetingResponse
AdminWebService.getUsersGeneralInfo([userNamePattern])
Parameters:userNamePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getUsersGeneralInfoResponse
AdminWebService.getUsersInfo([userNamePattern])
Parameters:userNamePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getUsersInfoResponse
AdminWebService.getVCCConfiguration(parameters)
Parameters:parameters – AdminWebService.getVCCConfiguration
Return type:AdminWebService.getVCCConfigurationResponse
AdminWebService.getWebConnectors([namePattern])
Parameters:namePattern – AdminWebService.StringType (optional)
Return type:AdminWebService.getWebConnectorsResponse
AdminWebService.isImportRunning([identifier, waitTime])
Parameters:
Return type:

AdminWebService.isImportRunningResponse
AdminWebService.isReportRunning([identifier, timeout])
Parameters:
  • identifier – AdminWebService.StringType (optional)
  • timeout – AdminWebService.LongType (optional)
Return type:

AdminWebService.isReportRunningResponse
AdminWebService.modifyAgentGroup([group, addAgents, removeAgents])
Parameters:
  • group – AdminWebService.agentGroup (optional)
  • addAgents – AdminWebService.StringType (optional)
  • removeAgents – AdminWebService.StringType (optional)
Return type:

AdminWebService.modifyAgentGroupResponse
AdminWebService.modifyAutodialCampaign([campaign])
Parameters:campaign – AdminWebService.autodialCampaign (optional)
Return type:AdminWebService.modifyAutodialCampaignResponse
AdminWebService.modifyCallVariable([variable])
Parameters:variable – AdminWebService.callVariable (optional)
Return type:AdminWebService.modifyCallVariableResponse
AdminWebService.modifyCallVariablesGroup([name, description])
Parameters:
  • name – AdminWebService.StringType (optional)
  • description – AdminWebService.StringType (optional)
Return type:

AdminWebService.modifyCallVariablesGroupResponse
AdminWebService.modifyCampaignLists([campaignName, lists])
Parameters:
Return type:

AdminWebService.modifyCampaignListsResponse
AdminWebService.modifyCampaignProfile([campaignProfile])
Parameters:campaignProfile – AdminWebService.campaignProfileInfo (optional)
Return type:AdminWebService.modifyCampaignProfileResponse
AdminWebService.modifyCampaignProfileCrmCriteria([profileName, grouping, addCriteria, removeCriteria])
Parameters:
Return type:

AdminWebService.modifyCampaignProfileCrmCriteriaResponse
AdminWebService.modifyCampaignProfileDispositions([profileName, addDispositionCounts, removeDispositionCounts])
Parameters:
Return type:

AdminWebService.modifyCampaignProfileDispositionsResponse
AdminWebService.modifyCampaignProfileFilterOrder([campaignProfile, addOrderByField, removeOrderByField])
Parameters:
  • campaignProfile – AdminWebService.StringType (optional)
  • addOrderByField – AdminWebService.orderByField (optional)
  • removeOrderByField – AdminWebService.StringType (optional)
Return type:

AdminWebService.modifyCampaignProfileFilterOrderResponse
AdminWebService.modifyContactField([field])
Parameters:field – AdminWebService.contactField (optional)
Return type:AdminWebService.modifyContactFieldResponse
AdminWebService.modifyDisposition([disposition])
Parameters:disposition – AdminWebService.disposition (optional)
Return type:AdminWebService.modifyDispositionResponse
AdminWebService.modifyIVRScript([scriptDef])
Parameters:scriptDef – AdminWebService.ivrScriptDef (optional)
Return type:AdminWebService.modifyIVRScriptResponse
AdminWebService.modifyInboundCampaign([campaign])
Parameters:campaign – AdminWebService.inboundCampaign (optional)
Return type:AdminWebService.modifyInboundCampaignResponse
AdminWebService.modifyOutboundCampaign([campaign])
Parameters:campaign – AdminWebService.outboundCampaign (optional)
Return type:AdminWebService.modifyOutboundCampaignResponse
AdminWebService.modifyPromptTTS([prompt, ttsInfo])
Parameters:
Return type:

AdminWebService.modifyPromptTTSResponse
AdminWebService.modifyPromptWav([prompt, wavFile])
Parameters:
Return type:

AdminWebService.modifyPromptWavResponse
AdminWebService.modifyPromptWavInline([prompt, wavFile])
Parameters:
Return type:

AdminWebService.modifyPromptWavInlineResponse
AdminWebService.modifyReasonCode([reasonCode])
Parameters:reasonCode – AdminWebService.reasonCode (optional)
Return type:AdminWebService.modifyReasonCodeResponse
AdminWebService.modifySkill([skill])
Parameters:skill – AdminWebService.skill (optional)
Return type:AdminWebService.modifySkillResponse
AdminWebService.modifyUser([userGeneralInfo, rolesToSet, rolesToRemove])
Parameters:
Return type:

AdminWebService.modifyUserResponse
AdminWebService.modifyUserCannedReports([userName, cannedReportsToAdd, cannedReportsToRemove])
Parameters:
  • userName – AdminWebService.StringType (optional)
  • cannedReportsToAdd – AdminWebService.cannedReport (optional)
  • cannedReportsToRemove – AdminWebService.StringType (optional)
Return type:

AdminWebService.modifyUserCannedReportsResponse
AdminWebService.modifyUserProfile([userProfile])
Parameters:userProfile – AdminWebService.userProfile (optional)
Return type:AdminWebService.modifyUserProfileResponse
AdminWebService.modifyUserProfileSkills([userProfileName, addSkills, removeSkills])
Parameters:
  • userProfileName – AdminWebService.StringType (optional)
  • addSkills – AdminWebService.StringType (optional)
  • removeSkills – AdminWebService.StringType (optional)
Return type:

AdminWebService.modifyUserProfileSkillsResponse
AdminWebService.modifyUserProfileUserList([userProfileName, addUsers, removeUsers])
Parameters:
  • userProfileName – AdminWebService.StringType (optional)
  • addUsers – AdminWebService.StringType (optional)
  • removeUsers – AdminWebService.StringType (optional)
Return type:

AdminWebService.modifyUserProfileUserListResponse
AdminWebService.modifyVCCConfiguration([configuration])
Parameters:configuration – AdminWebService.vccConfiguration (optional)
Return type:AdminWebService.modifyVCCConfigurationResponse
AdminWebService.modifyWebConnector([connector])
Parameters:connector – AdminWebService.webConnector (optional)
Return type:AdminWebService.modifyWebConnectorResponse
AdminWebService.removeDNISFromCampaign([campaignName, DNISList])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • DNISList – AdminWebService.StringType (optional)
Return type:

AdminWebService.removeDNISFromCampaignResponse
AdminWebService.removeDisposition([dispositionName])
Parameters:dispositionName – AdminWebService.StringType (optional)
Return type:AdminWebService.removeDispositionResponse
AdminWebService.removeDispositionsFromCampaign([campaignName, dispositions])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • dispositions – AdminWebService.StringType (optional)
Return type:

AdminWebService.removeDispositionsFromCampaignResponse
AdminWebService.removeListsFromCampaign([campaignName, lists])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • lists – AdminWebService.StringType (optional)
Return type:

AdminWebService.removeListsFromCampaignResponse
AdminWebService.removeNumbersFromDnc([numbers])
Parameters:numbers – AdminWebService.StringType (optional)
Return type:AdminWebService.removeNumbersFromDncResponse
AdminWebService.removeSkillAudioFile([skillName, promptName])
Parameters:
  • skillName – AdminWebService.StringType (optional)
  • promptName – AdminWebService.StringType (optional)
Return type:

AdminWebService.removeSkillAudioFileResponse
AdminWebService.removeSkillsFromCampaign([campaignName, skills])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • skills – AdminWebService.StringType (optional)
Return type:

AdminWebService.removeSkillsFromCampaignResponse
AdminWebService.renameCampaign([campaignName, campaignNewName])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • campaignNewName – AdminWebService.StringType (optional)
Return type:

AdminWebService.renameCampaignResponse
AdminWebService.renameDisposition([dispositionName, dispositionNewName])
Parameters:
  • dispositionName – AdminWebService.StringType (optional)
  • dispositionNewName – AdminWebService.StringType (optional)
Return type:

AdminWebService.renameDispositionResponse
AdminWebService.resetCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.resetCampaignResponse
AdminWebService.resetCampaignDispositions([campaignName, dispositions, after, before])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • dispositions – AdminWebService.StringType (optional)
  • after – AdminWebService.DateTimeType (optional)
  • before – AdminWebService.DateTimeType (optional)
Return type:

AdminWebService.resetCampaignDispositionsResponse
AdminWebService.resetListPosition([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.resetListPositionResponse
AdminWebService.runReport([folderName, reportName, criteria])
Parameters:
Return type:

AdminWebService.runReportResponse
AdminWebService.setCampaignStrategies([campaignName, campaignStrategies])
Parameters:
Return type:

AdminWebService.setCampaignStrategiesResponse
AdminWebService.setDefaultIVRSchedule([campaignName, scriptName, params, isVisualModeEnabled, isChatEnabled])
Parameters:
  • campaignName – AdminWebService.StringType (optional)
  • scriptName – AdminWebService.StringType (optional)
  • params – AdminWebService.scriptParameterValue (optional)
  • isVisualModeEnabled – AdminWebService.BooleanType (optional)
  • isChatEnabled – AdminWebService.BooleanType (optional)
Return type:

AdminWebService.setDefaultIVRScheduleResponse
AdminWebService.setDialingRules([setRules, removeRules])
Parameters:
Return type:

AdminWebService.setDialingRulesResponse
AdminWebService.setLocale([localeName])
Parameters:localeName – AdminWebService.StringType (optional)
Return type:AdminWebService.setLocaleResponse
AdminWebService.setSkillVoicemailGreeting([skillName, wavFile])
Parameters:
  • skillName – AdminWebService.StringType (optional)
  • wavFile – AdminWebService.StringType (optional)
Return type:

AdminWebService.setSkillVoicemailGreetingResponse
AdminWebService.setUserVoicemailGreeting([userName, wavFile])
Parameters:
  • userName – AdminWebService.StringType (optional)
  • wavFile – AdminWebService.StringType (optional)
Return type:

AdminWebService.setUserVoicemailGreetingResponse
AdminWebService.startCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.startCampaignResponse
AdminWebService.stopCampaign([campaignName])
Parameters:campaignName – AdminWebService.StringType (optional)
Return type:AdminWebService.stopCampaignResponse
AdminWebService.updateConfigurationTranslations([localeName, diffTranslations])
Parameters:
Return type:

AdminWebService.updateConfigurationTranslationsResponse
AdminWebService.updateContacts([crmUpdateSettings, importData])
Parameters:
Return type:

AdminWebService.updateContactsResponse
AdminWebService.updateContactsCsv([crmUpdateSettings, csvData])
Parameters:
Return type:

AdminWebService.updateContactsCsvResponse
AdminWebService.updateContactsFtp([updateSettings, ftpSettings])
Parameters:
Return type:

AdminWebService.updateContactsFtpResponse
AdminWebService.updateCrmRecord([crmUpdateSettings, record])
Parameters:
Return type:

AdminWebService.updateCrmRecordResponse
AdminWebService.updateDispositions([campaignName, DispositionsUpdateSettings, importData])
Parameters:
Return type:

AdminWebService.updateDispositionsResponse
AdminWebService.updateDispositionsCsv([campaignName, DispositionsUpdateSettings, csvData])
Parameters:
Return type:

AdminWebService.updateDispositionsCsvResponse
AdminWebService.updateDispositionsFtp([campaignName, updateSettings, ftpSettings])
Parameters:
Return type:

AdminWebService.updateDispositionsFtpResponse
AdminWebService.userSkillAdd([userSkill])
Parameters:userSkill – AdminWebService.userSkill (optional)
Return type:AdminWebService.userSkillAddResponse
AdminWebService.userSkillModify([userSkill])
Parameters:userSkill – AdminWebService.userSkill (optional)
Return type:AdminWebService.userSkillModifyResponse
AdminWebService.userSkillRemove([userSkill])
Parameters:userSkill – AdminWebService.userSkill (optional)
Return type:AdminWebService.userSkillRemoveResponse

Types

Types are accessible under the type attribute of a client instance.

class AdminWebService.AccessDisallowedFault
message

type: AdminWebService.StringType

class AdminWebService.AddRecordToListFault
message

type: AdminWebService.StringType

class AdminWebService.AdminSessionClosedFault
message

type: AdminWebService.StringType

class AdminWebService.AllowedOnlyForPreviewCampaignFault
campaignName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.CampaignAlreadyExistsFault
campaignName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.CampaignNotFoundFault
campaignName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.CampaignStateUpdateFault
campaignName

type: AdminWebService.StringType

details

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.CantModifyObjectFault
message

type: AdminWebService.StringType

class AdminWebService.CommonCampaignFault
campaignName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ConcurrentModificationFault
message

type: AdminWebService.StringType

class AdminWebService.CrmFieldNotFoundFault
fieldName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DNISAlreadyAssignedFault
campaignName

type: AdminWebService.StringType

dnis

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DNISIsNotAssignedFault
campaignName

type: AdminWebService.StringType

dnis

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DNISNotFoundFault
dnis

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DialProfileNotFoundFault
message

type: AdminWebService.StringType

profileName

type: AdminWebService.StringType

class AdminWebService.DispositionAlreadyExistsFault
dispositionName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DispositionIsAlreadyAssignedFault
campaignName

type: AdminWebService.StringType

dispositionName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DispositionIsNotAssisgnedFault
campaignName

type: AdminWebService.StringType

dispositionName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DispositionNotAllowedFault
dispositionName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.DispositionNotFoundFault
dispositionName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ExecutionRestrictionFault
message

type: AdminWebService.StringType

class AdminWebService.ExtensionAlreadyInUseFault
ext

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ExtensionsOutOfRangeFault
campaignNames

type: AdminWebService.StringType

This is a list with an unlimited number of items.

message

type: AdminWebService.StringType

userNames

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.FinderException
message

type: AdminWebService.StringType

class AdminWebService.ImportCancelledFault
message

type: AdminWebService.StringType

class AdminWebService.ImportInProgressFault
message

type: AdminWebService.StringType

class AdminWebService.ImportSizeLimitExceededFault
limit

type: AdminWebService.IntType

message

type: AdminWebService.StringType

recordsCount

type: AdminWebService.IntType

class AdminWebService.IncorrectArgumentFault
message

type: AdminWebService.StringType

class AdminWebService.InternalImportFault
message

type: AdminWebService.StringType

class AdminWebService.InvalidAccountFault
message

type: AdminWebService.StringType

class AdminWebService.InvalidDateRangeFault
end

type: AdminWebService.DateTimeType

message

type: AdminWebService.StringType

start

type: AdminWebService.DateTimeType

class AdminWebService.InvalidImportDataFault
message

type: AdminWebService.StringType

class AdminWebService.InvalidRegexpPatternFault
message

type: AdminWebService.StringType

pattern

type: AdminWebService.StringType

class AdminWebService.InvalidUserDataFault
message

type: AdminWebService.StringType

class AdminWebService.IvrScriptNotFoundFault
ivrScriptName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ListAlreadyAssignedFault
campaignName

type: AdminWebService.StringType

listName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ListAlreadyExistsFault
listName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ListCantBeRemovedFault
listName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ListIsNotAssignedFault
campaignName

type: AdminWebService.StringType

listName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.ListNotFoundFault
listName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.LocaleNotFoundFault
localeName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.LogoutReasonCodeNotFoundFault
message

type: AdminWebService.StringType

reasonCodeName

type: AdminWebService.StringType

class AdminWebService.MaxPlayFileCountForSkillExceededFault
message

type: AdminWebService.StringType

skillName

type: AdminWebService.StringType

class AdminWebService.MissedArgumentFault
message

type: AdminWebService.StringType

class AdminWebService.MissedOsLoginFault
agentNames

type: AdminWebService.StringType

This is a list with an unlimited number of items.

message

type: AdminWebService.StringType

class AdminWebService.NICELicencesExceededFault
featureLicenseType

type: AdminWebService.niceLicenseType

message

type: AdminWebService.StringType

totalNumberOfLicenses

type: AdminWebService.IntType

class AdminWebService.NotReadyReasonCodeNotFoundFault
message

type: AdminWebService.StringType

reasonCodeName

type: AdminWebService.StringType

class AdminWebService.ObjectAlreadyExistsFault
id

type: AdminWebService.LongType

message

type: AdminWebService.StringType

objectName

type: AdminWebService.StringType

objectType

type: AdminWebService.wsObjectType

class AdminWebService.ObjectInUseFault
id

type: AdminWebService.LongType

message

type: AdminWebService.StringType

objectName

type: AdminWebService.StringType

objectType

type: AdminWebService.wsObjectType

class AdminWebService.ObjectNotFoundFault
id

type: AdminWebService.LongType

message

type: AdminWebService.StringType

objectName

type: AdminWebService.StringType

objectType

type: AdminWebService.wsObjectType

class AdminWebService.ObjectsCountLimitExceededFault
id

type: AdminWebService.LongType

limit

type: AdminWebService.IntType

message

type: AdminWebService.StringType

objectName

type: AdminWebService.StringType

objectType

type: AdminWebService.wsObjectType

class AdminWebService.OperationsLimitExceededFault
limit

type: AdminWebService.LongType

message

type: AdminWebService.StringType

operationType

type: AdminWebService.StringType

class AdminWebService.ParseException
errorOffset

type: AdminWebService.IntType

message

type: AdminWebService.StringType

class AdminWebService.PromptAlreadyExistsFault
message

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.PromptCantBeDeletedFault
message

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.PromptNotFoundFault
message

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.ReasonCodeCountLimitExceededFault
message

type: AdminWebService.StringType

reasonCodeName

type: AdminWebService.StringType

class AdminWebService.ReasonCodeNotFoundFault
message

type: AdminWebService.StringType

reasonCodeName

type: AdminWebService.StringType

class AdminWebService.ReportNotFoundFault
folder

type: AdminWebService.StringType

message

type: AdminWebService.StringType

reportName

type: AdminWebService.StringType

class AdminWebService.ResultIsNotReadyFault
message

type: AdminWebService.StringType

class AdminWebService.ScheduleNotFoundFault
message

type: AdminWebService.StringType

scheduleName

type: AdminWebService.StringType

class AdminWebService.ScheduleOperationFailedFault
message

type: AdminWebService.StringType

operation

type: AdminWebService.operationType

scheduleName

type: AdminWebService.StringType

class AdminWebService.ServerFault
message

type: AdminWebService.StringType

class AdminWebService.ServiceUnavailableFault
message

type: AdminWebService.StringType

class AdminWebService.SessionClosedFault
message

type: AdminWebService.StringType

class AdminWebService.SkillAlreadyAssignedFault
campaignName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.SkillAlreadyExistsFault
message

type: AdminWebService.StringType

skillName

type: AdminWebService.StringType

class AdminWebService.SkillCantBeDeletedFault
message

type: AdminWebService.StringType

skillName

type: AdminWebService.StringType

class AdminWebService.SkillIsNotAssignedFault
campaignName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

skillName

type: AdminWebService.StringType

class AdminWebService.SkillNotFoundFault
message

type: AdminWebService.StringType

skillName

type: AdminWebService.StringType

class AdminWebService.TooManyExtensionsFault
message

type: AdminWebService.StringType

class AdminWebService.TooManyItemsFault
message

type: AdminWebService.StringType

class AdminWebService.TooManyUsersFault
message

type: AdminWebService.StringType

class AdminWebService.TtsGenerationFailed
message

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.UnknownIdentifierFault
message

type: AdminWebService.StringType

class AdminWebService.UserAlreadyExistsFault
message

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.UserAlreadyHasSkillFault
message

type: AdminWebService.StringType

skillName

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.UserAlreadyLoggedInFault
message

type: AdminWebService.StringType

class AdminWebService.UserCantBeDeletedFault
message

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.UserDoesntHaveSkillFault
message

type: AdminWebService.StringType

skillName

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.UserHasNoRequiredRoleFault
message

type: AdminWebService.StringType

roles

type: AdminWebService.userRoleType

This is a list with an unlimited number of items.

userName

type: AdminWebService.StringType

class AdminWebService.UserNotFoundFault
message

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.WavFileUploadFailedFault
message

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.WrongCampaignStateFault
actualState

type: AdminWebService.campaignState

campaignName

type: AdminWebService.StringType

desiredState

type: AdminWebService.campaignState

message

type: AdminWebService.StringType

class AdminWebService.WrongCampaignTypeFault
actualType

type: AdminWebService.campaignType

campaignName

type: AdminWebService.StringType

desiredTypes

type: AdminWebService.campaignType

This is a list with an unlimited number of items.

message

type: AdminWebService.StringType

class AdminWebService.WrongListDialingModeFault
campaignName

type: AdminWebService.StringType

message

type: AdminWebService.StringType

class AdminWebService.WrongPromptTypeFault
actualType

type: AdminWebService.promptType

desiredType

type: AdminWebService.promptType

message

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.addDNISToCampaign
campaignName

type: AdminWebService.StringType

DNISList

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.addDNISToCampaignResponse
class AdminWebService.addDispositionsToCampaign
campaignName

type: AdminWebService.StringType

dispositions

type: AdminWebService.StringType

This is a list with an unlimited number of items.

isSkipPreviewDisposition

type: AdminWebService.BooleanType

class AdminWebService.addDispositionsToCampaignResponse
class AdminWebService.addListsToCampaign
campaignName

type: AdminWebService.StringType

lists

type: AdminWebService.listState

This is a list with an unlimited number of items.

class AdminWebService.addListsToCampaignResponse
class AdminWebService.addNumbersToDnc
numbers

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.addNumbersToDncResponse
return

type: AdminWebService.IntType

class AdminWebService.addPromptTTS
prompt

type: AdminWebService.promptInfo

ttsInfo

type: AdminWebService.ttsInfo

class AdminWebService.addPromptTTSResponse
class AdminWebService.addPromptWav
prompt

type: AdminWebService.promptInfo

wavFile

type: AdminWebService.swaRef

class AdminWebService.addPromptWavInline
prompt

type: AdminWebService.promptInfo

wavFile

type: AdminWebService.StringType

class AdminWebService.addPromptWavInlineResponse
class AdminWebService.addPromptWavResponse
class AdminWebService.addRecordToList
listName

type: AdminWebService.StringType

listUpdateSettings

type: AdminWebService.listUpdateSettings

record

type: AdminWebService.recordData

class AdminWebService.addRecordToListResponse
return

type: AdminWebService.listImportResult

class AdminWebService.addRecordToListSimple
listName

type: AdminWebService.StringType

listUpdateSimpleSettings

type: AdminWebService.listUpdateSimpleSettings

record

type: AdminWebService.recordData

class AdminWebService.addRecordToListSimpleResponse
class AdminWebService.addSkillAudioFile
skillName

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.addSkillAudioFileResponse
class AdminWebService.addSkillsToCampaign
campaignName

type: AdminWebService.StringType

skills

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.addSkillsToCampaignResponse
class AdminWebService.addToList
listName

type: AdminWebService.StringType

listUpdateSettings

type: AdminWebService.listUpdateSettings

importData

type: AdminWebService.importData

class AdminWebService.addToListCsv
listName

type: AdminWebService.StringType

listUpdateSettings

type: AdminWebService.listUpdateSettings

csvData

type: AdminWebService.StringType

class AdminWebService.addToListCsvResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.addToListFtp
listName

type: AdminWebService.StringType

updateSettings

type: AdminWebService.listUpdateSettings

ftpSettings

type: AdminWebService.ftpImportSettings

class AdminWebService.addToListFtpResponse
class AdminWebService.addToListResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.adminConfigTranslation
comment

type: AdminWebService.StringType

objectField

type: AdminWebService.i18NObjectField

objectId

type: AdminWebService.LongType

objectType

type: AdminWebService.i18NObjectType

value

type: AdminWebService.StringType

class AdminWebService.adminPermission
type

type: AdminWebService.adminPermissionType

value

type: AdminWebService.BooleanType

class AdminWebService.adminPermissionType

Values:

  • FullPermissions
  • ManageUsers
  • ManageSkills
  • ManageAgentGroups
  • ManageCampaignsStartStop
  • ManageCampaignsResetDispositions
  • ManageCampaignsResetListPosition
  • ManageCampaignsReset
  • ManageCampaignsProperties
  • ManageLists
  • ManageCRM
  • ManageDNC
  • EditIvr
  • EditProfiles
  • EditConnectors
  • EditDispositions
  • EditPrompts
  • EditReasonCodes
  • EditWorkflowRules
  • AccessConfigANI
  • EditCallAttachedData
  • EditTrustedIPAddresses
  • NICEEnabled
  • AccessBillingApplication
  • EditDomainEMailNotification
  • EditCampaignEMailNotification
class AdminWebService.adminRole
permissions

type: AdminWebService.adminPermission

This is a list with an unlimited number of items.

class AdminWebService.agentAuditReportCriteria
agentStates

type: AdminWebService.agentState

This is a list with an unlimited number of items.

agents

type: AdminWebService.StringType

This is a list with an unlimited number of items.

logoutReasonCodes

type: AdminWebService.StringType

This is a list with an unlimited number of items.

notReadyReasonCodes

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.agentAvailability

Values:

  • ReadyToReceiveCalls
  • ReadyToReceiveCallsOrBusy
  • LoggedIn
class AdminWebService.agentGroup
agents

type: AdminWebService.StringType

This is a list with an unlimited number of items.

description

type: AdminWebService.StringType

id

type: AdminWebService.LongType

name

type: AdminWebService.StringType

class AdminWebService.agentPermission
type

type: AdminWebService.agentPermissionType

value

type: AdminWebService.BooleanType

class AdminWebService.agentPermissionType

Values:

  • ReceiveTransfer
  • ProcessVoiceMail
  • DeleteVoiceMail
  • TransferVoiceMail
  • MakeRecordings
  • SendMessages
  • CreateChatSessions
  • TrainingMode
  • CannotRemoveCRM
  • CannotEditSession
  • CallForwarding
  • AddingToDNC
  • DialManuallyDNC
  • CreateCallbacks
  • PlayAudioFiles
  • SkipCrmInPreviewDialMode
  • ManageAvailabilityBySkill
  • BrowseWebInEmbeddedBrowser
  • ChangePreviewPreferences
  • CanWrapCall
  • CanPlaceCallOnHold
  • CanParkCall
  • CanRejectCalls
  • CanConfigureAutoAnswer
  • NICEEnabled
  • ScreenRecording
  • RecycleDispositionAllowed
  • MakeTransferToAgents
  • MakeTransferToSkills
  • MakeTransferToInboundCampaigns
  • MakeTransferToExternalCalls
  • CreateConferenceWithAgents
  • CreateConferenceWithSkills
  • CreateConferenceWithInboundCampaigns
  • CreateConferenceWithExternalCalls
  • MakeCallToAgents
  • MakeCallToSkills
  • MakeCallToExternalCalls
  • CanRunJavaClient
  • CanRunWebClient
  • MakeCallToSpeedDialNumber
  • CreateConferenceWithSpeedDialNumber
  • MakeTransferToSpeedDialNumber
  • CanSelectDisplayLanguage
  • CanViewMissedCalls
  • CanViewWebAnalytics
class AdminWebService.agentProductivity
longACWTime

type: AdminWebService.IntType

longCallDuration

type: AdminWebService.IntType

longHoldDuration

type: AdminWebService.IntType

longParkDuration

type: AdminWebService.IntType

shortACWTime

type: AdminWebService.IntType

shortCallDuration

type: AdminWebService.IntType

class AdminWebService.agentRole
alwaysRecorded

type: AdminWebService.BooleanType

attachVmToEmail

type: AdminWebService.BooleanType

permissions

type: AdminWebService.agentPermission

This is a list with an unlimited number of items.

sendEmailOnVm

type: AdminWebService.BooleanType

class AdminWebService.agentState

Values:

  • AVAILABLE_FOR_CALLS
  • AVAILABLE_FOR_VMS
  • LOGIN
  • LOGOUT
  • NOT_AVAILABLE_FOR_CALLS
  • NOT_AVAILABLE_FOR_VMS
  • NOT_READY
  • READY
  • VM_IN_PROGRESS
  • VM_NOT_AVAILABLE
  • WAITING
class AdminWebService.apiOperationType

Values:

  • Query
  • Modify
  • Upload
  • SingleUpload
  • ReportRequest
  • RetrieveReport
  • AsynchronousUpload
  • QueryStatistics
  • QueryChangedStatistics
  • Web2CampaignUpload
  • VIVRCreateSession
class AdminWebService.asyncAddRecordsToList
listName

type: AdminWebService.StringType

listUpdateSettings

type: AdminWebService.listUpdateSettings

importData

type: AdminWebService.importData

resetDispositionsInCampaignsImportData

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.asyncAddRecordsToListResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.asyncDeleteRecordsFromList
listName

type: AdminWebService.StringType

listDeleteSettings

type: AdminWebService.listDeleteSettings

importData

type: AdminWebService.importData

class AdminWebService.asyncDeleteRecordsFromListResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.asyncUpdateCampaignDispositions
campaignName

type: AdminWebService.StringType

dispositionsUpdateSettings

type: AdminWebService.dispositionsUpdateSettings

importData

type: AdminWebService.importData

class AdminWebService.asyncUpdateCampaignDispositionsResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.asyncUpdateCrmRecords
crmUpdateSettings

type: AdminWebService.crmUpdateSettings

importData

type: AdminWebService.importData

class AdminWebService.asyncUpdateCrmRecordsResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.autodialCampaign
description

type: AdminWebService.StringType

mode

type: AdminWebService.campaignMode

name

type: AdminWebService.StringType

profileName

type: AdminWebService.StringType

state

type: AdminWebService.campaignState

trainingMode

type: AdminWebService.BooleanType

type

type: AdminWebService.campaignType

autoRecord

type: AdminWebService.BooleanType

callWrapup

type: AdminWebService.campaignCallWrapup

ftpHost

type: AdminWebService.StringType

ftpPassword

type: AdminWebService.StringType

ftpUser

type: AdminWebService.StringType

recordingNameAsSid

type: AdminWebService.BooleanType

useFtp

type: AdminWebService.BooleanType

analyzeLevel

type: AdminWebService.IntType

CRMRedialTimeout

type: AdminWebService.timer

dnisAsAni

type: AdminWebService.BooleanType

enableListDialingRatios

type: AdminWebService.BooleanType

listDialingMode

type: AdminWebService.listDialingMode

noOutOfNumbersAlert

type: AdminWebService.BooleanType

stateDialingRule

type: AdminWebService.campaignStateDialingRule

timeZoneAssignment

type: AdminWebService.campaignTimeZoneAssignment

agentAvailability

type: AdminWebService.agentAvailability

agentSkillName

type: AdminWebService.StringType

defaultIvrSchedule

type: AdminWebService.ivrScriptSchedule

dialIfAgentsAvailable

type: AdminWebService.BooleanType

maxNumOfLines

type: AdminWebService.IntType

class AdminWebService.baseOutboundCampaign
description

type: AdminWebService.StringType

mode

type: AdminWebService.campaignMode

name

type: AdminWebService.StringType

profileName

type: AdminWebService.StringType

state

type: AdminWebService.campaignState

trainingMode

type: AdminWebService.BooleanType

type

type: AdminWebService.campaignType

autoRecord

type: AdminWebService.BooleanType

callWrapup

type: AdminWebService.campaignCallWrapup

ftpHost

type: AdminWebService.StringType

ftpPassword

type: AdminWebService.StringType

ftpUser

type: AdminWebService.StringType

recordingNameAsSid

type: AdminWebService.BooleanType

useFtp

type: AdminWebService.BooleanType

analyzeLevel

type: AdminWebService.IntType

CRMRedialTimeout

type: AdminWebService.timer

dnisAsAni

type: AdminWebService.BooleanType

enableListDialingRatios

type: AdminWebService.BooleanType

listDialingMode

type: AdminWebService.listDialingMode

noOutOfNumbersAlert

type: AdminWebService.BooleanType

stateDialingRule

type: AdminWebService.campaignStateDialingRule

timeZoneAssignment

type: AdminWebService.campaignTimeZoneAssignment

class AdminWebService.basicImportResult
failureMessage

type: AdminWebService.StringType

importIdentifier

type: AdminWebService.StringType

importTroubles

type: AdminWebService.importTrouble

This is a list with an unlimited number of items.

keyFields

type: AdminWebService.StringType

This is a list with an unlimited number of items.

success

type: AdminWebService.BooleanType

uploadDuplicatesCount

type: AdminWebService.LongType

uploadErrorsCount

type: AdminWebService.LongType

warningsCount

type: AdminWebService.StringType

class AdminWebService.basicImportSettings
allowDataCleanup

type: AdminWebService.BooleanType

callbackFormat

type: AdminWebService.callbackFormat

callbackUrl

type: AdminWebService.StringType

countryCode

type: AdminWebService.StringType

failOnFieldParseError

type: AdminWebService.BooleanType

fieldsMapping

type: AdminWebService.fieldEntry

This is a list with an unlimited number of items.

reportEmail

type: AdminWebService.StringType

separator

type: AdminWebService.StringType

skipHeaderLine

type: AdminWebService.BooleanType

class AdminWebService.callAnalysisMode

Values:

  • NO_ANALYSIS
  • FAX_ONLY
  • FAX_AND_ANSWERING_MACHINE
class AdminWebService.callCounterState
limit

type: AdminWebService.LongType

operationType

type: AdminWebService.apiOperationType

value

type: AdminWebService.LongType

class AdminWebService.callLogReportCriteria
ANI

type: AdminWebService.StringType

agents

type: AdminWebService.StringType

This is a list with an unlimited number of items.

callTypes

type: AdminWebService.callType

This is a list with an unlimited number of items.

campaigns

type: AdminWebService.StringType

This is a list with an unlimited number of items.

DNIS

type: AdminWebService.StringType

dispositions

type: AdminWebService.StringType

This is a list with an unlimited number of items.

lists

type: AdminWebService.StringType

This is a list with an unlimited number of items.

skillGroups

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.callNowMode

Values:

  • NONE
  • NEW_CRM_ONLY
  • NEW_LIST_ONLY
  • ANY
class AdminWebService.callType

Values:

  • AGENT
  • AUTODIAL
  • INBOUND
  • INBOUND_VOICEMAIL
  • INTERNAL
  • INTERNAL_VOICEMAIL
  • OUTBOUND
  • OUTBOUND_PREVIEW
  • OUTBOUND_VOICEMAIL
  • TEST
class AdminWebService.callVariable
applyToAllDispositions

type: AdminWebService.BooleanType

defaultValue

type: AdminWebService.StringType

description

type: AdminWebService.StringType

dispositions

type: AdminWebService.StringType

This is a list with an unlimited number of items.

group

type: AdminWebService.StringType

name

type: AdminWebService.StringType

reporting

type: AdminWebService.BooleanType

restrictions

type: AdminWebService.callVariableRestriction

This is a list with an unlimited number of items.

sensitiveData

type: AdminWebService.BooleanType

type

type: AdminWebService.callVariableType

class AdminWebService.callVariableRestriction
type

type: AdminWebService.cavRestrictionType

value

type: AdminWebService.StringType

class AdminWebService.callVariableType

Values:

  • STRING
  • NUMBER
  • DATE
  • TIME
  • DATE_TIME
  • CURRENCY
  • BOOLEAN
  • PERCENT
  • EMAIL
  • URL
  • PHONE
  • TIME_PERIOD
class AdminWebService.callVariablesGroup
description

type: AdminWebService.StringType

name

type: AdminWebService.StringType

variables

type: AdminWebService.callVariable

This is a list with an unlimited number of items.

class AdminWebService.callbackFormat

Values:

  • XML
  • JSON
class AdminWebService.campaign
description

type: AdminWebService.StringType

mode

type: AdminWebService.campaignMode

name

type: AdminWebService.StringType

profileName

type: AdminWebService.StringType

state

type: AdminWebService.campaignState

trainingMode

type: AdminWebService.BooleanType

type

type: AdminWebService.campaignType

class AdminWebService.campaignCallWrapup
agentNotReady

type: AdminWebService.BooleanType

dispostionName

type: AdminWebService.StringType

enabled

type: AdminWebService.BooleanType

reasonCodeName

type: AdminWebService.StringType

timeout

type: AdminWebService.timer

class AdminWebService.campaignDialNumber

Values:

  • Primary
  • Alt1
  • Alt2
class AdminWebService.campaignDialingAction
actionArgument

type: AdminWebService.StringType

actionType

type: AdminWebService.campaignDialingActionType

maxWaitTime

type: AdminWebService.timer

class AdminWebService.campaignDialingActionType

Values:

  • DROP_CALL
  • PLAY_PROMPT
  • START_IVR_SCRIPT
class AdminWebService.campaignDialingMode

Values:

  • PREDICTIVE
  • PROGRESSIVE
  • PREVIEW
  • POWER
class AdminWebService.campaignDialingOrder

Values:

  • PrimaryAlt1Alt2
  • PrimaryAlt2Alt1
  • Alt1PrimaryAlt2
  • Alt1Alt2Primary
  • Alt2PrimaryAlt1
  • Alt2Alt1Primary
class AdminWebService.campaignDialingSchedule
dialASAPSortOrder

type: AdminWebService.dialSortOrder

dialASAPTimeout

type: AdminWebService.IntType

dialASAPTimeoutPeriod

type: AdminWebService.timePeriod

dialingOrder

type: AdminWebService.campaignDialingOrder

dialingSchedules

type: AdminWebService.campaignNumberSchedule

This is a list with an unlimited number of items.

includeNumbers

type: AdminWebService.campaignDialNumber

This is a list with an unlimited number of items.

class AdminWebService.campaignFilterCriterion
compareOperator

type: AdminWebService.compareOperatorType

leftValue

type: AdminWebService.StringType

rightValue

type: AdminWebService.StringType

class AdminWebService.campaignMode

Values:

  • BASIC
  • ADVANCED
class AdminWebService.campaignNumberSchedule
number

type: AdminWebService.campaignDialNumber

startTime

type: AdminWebService.timer

stopTime

type: AdminWebService.timer

class AdminWebService.campaignProfileFilter
crmCriteria

type: AdminWebService.campaignFilterCriterion

This is a list with an unlimited number of items.

grouping

type: AdminWebService.crmCriteriaGrouping

orderByFields

type: AdminWebService.orderByField

This is a list with an unlimited number of items.

class AdminWebService.campaignProfileInfo
ANI

type: AdminWebService.StringType

description

type: AdminWebService.StringType

dialingSchedule

type: AdminWebService.campaignDialingSchedule

dialingTimeout

type: AdminWebService.IntType

initialCallPriority

type: AdminWebService.IntType

maxCharges

type: AdminWebService.IntType

name

type: AdminWebService.StringType

numberOfAttempts

type: AdminWebService.IntType

class AdminWebService.campaignState

Values:

  • NOT_RUNNING
  • STARTING
  • RUNNING
  • STOPPING
  • RESETTING
class AdminWebService.campaignStateDialingRule

Values:

  • FOLLOW_STATE_RESTRICTIONS
  • INHERIT_DOMAIN_SETTINGS
  • REGION
  • REGION_THEN_PHONE_NUMBER
  • REGION_THEN_POSTCODE
class AdminWebService.campaignStrategies
strategies

type: AdminWebService.campaignStrategy

This is a list with an unlimited number of items.

class AdminWebService.campaignStrategy
description

type: AdminWebService.StringType

enabled

type: AdminWebService.BooleanType

filter

type: AdminWebService.campaignStrategyFilter

name

type: AdminWebService.StringType

schedule

type: AdminWebService.campaignStrategyPeriod

This is a list with an unlimited number of items.

startAfterTimeMins

type: AdminWebService.LongType

class AdminWebService.campaignStrategyFilter
conditionGroupingType

type: AdminWebService.crmCriteriaGroupingType

conditions

type: AdminWebService.campaignFilterCriterion

This is a list with an unlimited number of items.

customGrouping

type: AdminWebService.StringType

class AdminWebService.campaignStrategyPeriod
redialAfterMins

type: AdminWebService.LongType

startFromDay

type: AdminWebService.LongType

class AdminWebService.campaignTimeZoneAssignment

Values:

  • INHERIT_DOMAIN_SETTINGS
  • PHONE_NUMBER
  • POSTCODE_THEN_PHONE_NUMBER
  • REGION_THEN_PHONE_NUMBER
class AdminWebService.campaignType

Values:

  • OUTBOUND
  • AUTODIAL
  • INBOUND
class AdminWebService.campaignsSettings
gracefulAgentStateTransitionDelay

type: AdminWebService.IntType

gracefulAgentStateTransitionModeEnabled

type: AdminWebService.BooleanType

priorityEnabled

type: AdminWebService.BooleanType

ratioEnabled

type: AdminWebService.BooleanType

class AdminWebService.cannedReport
index

type: AdminWebService.IntType

name

type: AdminWebService.StringType

class AdminWebService.cavRestrictionType

Values:

  • MinValue
  • MaxValue
  • Regexp
  • Required
  • Set
  • Multiset
  • Precision
  • Scale
  • TimeFormat
  • DateFormat
  • TimePeriodFormat
  • CurrencyType
class AdminWebService.checkDncForNumbers
numbers

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.checkDncForNumbersResponse
return

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.closeSession
class AdminWebService.closeSessionResponse
class AdminWebService.compareOperatorType

Values:

  • Contains
  • DontContains
  • IsNull
  • IsNotNull
  • EndsWith
  • Equals
  • NotEqual
  • Greater
  • GreaterOrEqual
  • Less
  • LessOrEqual
  • Like
  • StartsWith
class AdminWebService.contactField
displayAs

type: AdminWebService.contactFieldDisplay

mapTo

type: AdminWebService.contactFieldMapping

name

type: AdminWebService.StringType

restrictions

type: AdminWebService.contactFieldRestriction

This is a list with an unlimited number of items.

system

type: AdminWebService.BooleanType

type

type: AdminWebService.contactFieldType

class AdminWebService.contactFieldDisplay

Values:

  • Short
  • Long
  • Invisible
class AdminWebService.contactFieldMapping

Values:

  • None
  • LastAgent
  • LastDisposition
  • LastSystemDisposition
  • LastAgentDisposition
  • LastDispositionDateTime
  • LastSystemDispositionDateTime
  • LastAgentDispositionDateTime
  • LastAttemptedNumber
  • LastAttemptedNumberN1N2N3
  • LastCampaign
  • AttemptsForLastCampaign
  • LastList
  • CreatedDateTime
  • LastModifiedDateTime
class AdminWebService.contactFieldRestriction
type

type: AdminWebService.contactFieldRestrictionType

value

type: AdminWebService.StringType

class AdminWebService.contactFieldRestrictionType

Values:

  • MinValue
  • MaxValue
  • Regexp
  • Required
  • Set
  • Multiset
  • Precision
  • Scale
  • TimeFormat
  • DateFormat
  • TimePeriodFormat
  • CurrencyType
class AdminWebService.contactFieldType

Values:

  • STRING
  • NUMBER
  • DATE
  • TIME
  • DATE_TIME
  • CURRENCY
  • BOOLEAN
  • PERCENT
  • EMAIL
  • URL
  • PHONE
  • TIME_PERIOD
class AdminWebService.contactsLookupResult
fields

type: AdminWebService.StringType

This is a list with an unlimited number of items.

records

type: AdminWebService.record

This is a list with an unlimited number of items.

class AdminWebService.createAgentGroup
group

type: AdminWebService.agentGroup

class AdminWebService.createAgentGroupResponse
return

type: AdminWebService.agentGroup

class AdminWebService.createAutodialCampaign
campaign

type: AdminWebService.autodialCampaign

class AdminWebService.createAutodialCampaignResponse
class AdminWebService.createCallVariable
variable

type: AdminWebService.callVariable

class AdminWebService.createCallVariableResponse
class AdminWebService.createCallVariablesGroup
name

type: AdminWebService.StringType

description

type: AdminWebService.StringType

class AdminWebService.createCallVariablesGroupResponse
class AdminWebService.createCampaignProfile
campaignProfile

type: AdminWebService.campaignProfileInfo

class AdminWebService.createCampaignProfileResponse
return

type: AdminWebService.campaignProfileInfo

class AdminWebService.createContactField
field

type: AdminWebService.contactField

class AdminWebService.createContactFieldResponse
class AdminWebService.createDisposition
disposition

type: AdminWebService.disposition

class AdminWebService.createDispositionResponse
class AdminWebService.createIVRScript
name

type: AdminWebService.StringType

class AdminWebService.createIVRScriptResponse
return

type: AdminWebService.ivrScriptDef

class AdminWebService.createInboundCampaign
campaign

type: AdminWebService.inboundCampaign

class AdminWebService.createInboundCampaignResponse
class AdminWebService.createList
listName

type: AdminWebService.StringType

class AdminWebService.createListResponse
class AdminWebService.createOutboundCampaign
campaign

type: AdminWebService.outboundCampaign

class AdminWebService.createOutboundCampaignResponse
class AdminWebService.createReasonCode
reasonCode

type: AdminWebService.reasonCode

class AdminWebService.createReasonCodeResponse
class AdminWebService.createSkill
skillInfo

type: AdminWebService.skillInfo

class AdminWebService.createSkillResponse
return

type: AdminWebService.skillInfo

class AdminWebService.createUser
userInfo

type: AdminWebService.userInfo

class AdminWebService.createUserProfile
userProfile

type: AdminWebService.userProfile

class AdminWebService.createUserProfileResponse
return

type: AdminWebService.userProfile

class AdminWebService.createUserResponse
return

type: AdminWebService.userInfo

class AdminWebService.createWebConnector
connector

type: AdminWebService.webConnector

class AdminWebService.createWebConnectorResponse
class AdminWebService.crmAddMode

Values:

  • ADD_NEW
  • DONT_ADD
class AdminWebService.crmCriteriaGrouping
expression

type: AdminWebService.StringType

type

type: AdminWebService.crmCriteriaGroupingType

class AdminWebService.crmCriteriaGroupingType

Values:

  • All
  • Any
  • Custom
class AdminWebService.crmDeleteMode

Values:

  • DELETE_ALL
  • DELETE_SOLE_MATCHES
  • DELETE_EXCEPT_FIRST
class AdminWebService.crmDeleteSettings
allowDataCleanup

type: AdminWebService.BooleanType

callbackFormat

type: AdminWebService.callbackFormat

callbackUrl

type: AdminWebService.StringType

countryCode

type: AdminWebService.StringType

failOnFieldParseError

type: AdminWebService.BooleanType

fieldsMapping

type: AdminWebService.fieldEntry

This is a list with an unlimited number of items.

reportEmail

type: AdminWebService.StringType

separator

type: AdminWebService.StringType

skipHeaderLine

type: AdminWebService.BooleanType

crmDeleteMode

type: AdminWebService.crmDeleteMode

class AdminWebService.crmFieldCriterion
field

type: AdminWebService.StringType

value

type: AdminWebService.StringType

class AdminWebService.crmImportResult
failureMessage

type: AdminWebService.StringType

importIdentifier

type: AdminWebService.StringType

importTroubles

type: AdminWebService.importTrouble

This is a list with an unlimited number of items.

keyFields

type: AdminWebService.StringType

This is a list with an unlimited number of items.

success

type: AdminWebService.BooleanType

uploadDuplicatesCount

type: AdminWebService.LongType

uploadErrorsCount

type: AdminWebService.LongType

warningsCount

type: AdminWebService.StringType

crmRecordsDeleted

type: AdminWebService.LongType

crmRecordsInserted

type: AdminWebService.LongType

crmRecordsUpdated

type: AdminWebService.LongType

class AdminWebService.crmLookupCriteria
contactIdField

type: AdminWebService.StringType

criteria

type: AdminWebService.crmFieldCriterion

This is a list with an unlimited number of items.

class AdminWebService.crmUpdateMode

Values:

  • UPDATE_FIRST
  • UPDATE_ALL
  • UPDATE_SOLE_MATCHES
  • DONT_UPDATE
class AdminWebService.crmUpdateSettings
allowDataCleanup

type: AdminWebService.BooleanType

callbackFormat

type: AdminWebService.callbackFormat

callbackUrl

type: AdminWebService.StringType

countryCode

type: AdminWebService.StringType

failOnFieldParseError

type: AdminWebService.BooleanType

fieldsMapping

type: AdminWebService.fieldEntry

This is a list with an unlimited number of items.

reportEmail

type: AdminWebService.StringType

separator

type: AdminWebService.StringType

skipHeaderLine

type: AdminWebService.BooleanType

crmAddMode

type: AdminWebService.crmAddMode

crmUpdateMode

type: AdminWebService.crmUpdateMode

class AdminWebService.cssTheme

Values:

  • a
  • b
  • c
  • d
class AdminWebService.customDispositionType

Values:

  • FinalDisp
  • FinalApplyToCampaigns
  • AddActiveNumber
  • AddAndFinalize
  • AddAllNumbers
  • DoNotDial
  • RedialNumber
class AdminWebService.customReportCriteria
reportObjects

type: AdminWebService.reportObjectList

This is a list with an unlimited number of items.

time

type: AdminWebService.reportTimeCriteria

class AdminWebService.dateRange
daysOfWeek

type: AdminWebService.dayOfWeek

This is a list with an unlimited number of items.

endDate

type: AdminWebService.DateTimeType

startDate

type: AdminWebService.DateTimeType

class AdminWebService.dayOfWeek

Values:

  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
class AdminWebService.deleteAgentGroup
groupName

type: AdminWebService.StringType

class AdminWebService.deleteAgentGroupResponse
class AdminWebService.deleteAllFromList
listName

type: AdminWebService.StringType

reportEmail

type: AdminWebService.StringType

callbackUrl

type: AdminWebService.StringType

callbackFormat

type: AdminWebService.callbackFormat

class AdminWebService.deleteAllFromListResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.deleteCallVariable
name

type: AdminWebService.StringType

groupName

type: AdminWebService.StringType

class AdminWebService.deleteCallVariableResponse
class AdminWebService.deleteCallVariablesGroup
name

type: AdminWebService.StringType

class AdminWebService.deleteCallVariablesGroupResponse
class AdminWebService.deleteCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.deleteCampaignProfile
profileName

type: AdminWebService.StringType

class AdminWebService.deleteCampaignProfileResponse
class AdminWebService.deleteCampaignResponse
class AdminWebService.deleteContactField
fieldName

type: AdminWebService.StringType

class AdminWebService.deleteContactFieldResponse
class AdminWebService.deleteFromContacts
crmDeleteSettings

type: AdminWebService.crmDeleteSettings

importData

type: AdminWebService.importData

class AdminWebService.deleteFromContactsCsv
crmDeleteSettings

type: AdminWebService.crmDeleteSettings

csvData

type: AdminWebService.StringType

class AdminWebService.deleteFromContactsCsvResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.deleteFromContactsFtp
deleteSettings

type: AdminWebService.crmDeleteSettings

ftpSettings

type: AdminWebService.ftpImportSettings

class AdminWebService.deleteFromContactsFtpResponse
class AdminWebService.deleteFromContactsResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.deleteFromList
listName

type: AdminWebService.StringType

listDeleteSettings

type: AdminWebService.listDeleteSettings

importData

type: AdminWebService.importData

class AdminWebService.deleteFromListCsv
listName

type: AdminWebService.StringType

listDeleteSettings

type: AdminWebService.listDeleteSettings

csvData

type: AdminWebService.StringType

class AdminWebService.deleteFromListCsvResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.deleteFromListFtp
listName

type: AdminWebService.StringType

deleteSettings

type: AdminWebService.listDeleteSettings

ftpSettings

type: AdminWebService.ftpImportSettings

class AdminWebService.deleteFromListFtpResponse
class AdminWebService.deleteFromListResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.deleteIVRScript
name

type: AdminWebService.StringType

class AdminWebService.deleteIVRScriptResponse
class AdminWebService.deleteLanguagePrompt
promptName

type: AdminWebService.StringType

language

type: AdminWebService.StringType

class AdminWebService.deleteLanguagePromptResponse
class AdminWebService.deleteList
listName

type: AdminWebService.StringType

class AdminWebService.deleteListResponse
class AdminWebService.deletePrompt
promptName

type: AdminWebService.StringType

class AdminWebService.deletePromptResponse
class AdminWebService.deleteReasonCode
reasonCodeName

type: AdminWebService.StringType

class AdminWebService.deleteReasonCodeByType
reasonCodeName

type: AdminWebService.StringType

type

type: AdminWebService.reasonCodeType

class AdminWebService.deleteReasonCodeByTypeResponse
class AdminWebService.deleteReasonCodeResponse
class AdminWebService.deleteRecordFromList
listName

type: AdminWebService.StringType

listDeleteSettings

type: AdminWebService.listDeleteSettings

record

type: AdminWebService.recordData

class AdminWebService.deleteRecordFromListResponse
return

type: AdminWebService.listImportResult

class AdminWebService.deleteSkill
skillName

type: AdminWebService.StringType

class AdminWebService.deleteSkillResponse
class AdminWebService.deleteUser
userName

type: AdminWebService.StringType

class AdminWebService.deleteUserProfile
userProfileName

type: AdminWebService.StringType

class AdminWebService.deleteUserProfileResponse
class AdminWebService.deleteUserResponse
class AdminWebService.deleteWebConnector
name

type: AdminWebService.StringType

class AdminWebService.deleteWebConnectorResponse
class AdminWebService.dialSortOrder

Values:

  • LIFO
  • FIFO
  • ContactFields
class AdminWebService.dialingRule
applyToManualCalls

type: AdminWebService.BooleanType

contactText

type: AdminWebService.StringType

dateRange

type: AdminWebService.dateRange

fixedTimeZone

type: AdminWebService.StringType

name

type: AdminWebService.StringType

state

type: AdminWebService.stateProvince

timeRange

type: AdminWebService.timeRange

class AdminWebService.disposition
agentMustCompleteWorksheet

type: AdminWebService.BooleanType

agentMustConfirm

type: AdminWebService.BooleanType

description

type: AdminWebService.StringType

name

type: AdminWebService.StringType

resetAttemptsCounter

type: AdminWebService.BooleanType

sendEmailNotification

type: AdminWebService.BooleanType

sendIMNotification

type: AdminWebService.BooleanType

trackAsFirstCallResolution

type: AdminWebService.BooleanType

type

type: AdminWebService.customDispositionType

typeParameters

type: AdminWebService.dispositionTypeParams

class AdminWebService.dispositionCount
count

type: AdminWebService.IntType

dispositions

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.dispositionTypeParams
allowChangeTimer

type: AdminWebService.BooleanType

attempts

type: AdminWebService.StringType

timer

type: AdminWebService.timer

useTimer

type: AdminWebService.BooleanType

class AdminWebService.dispositionsImportResult
failureMessage

type: AdminWebService.StringType

importIdentifier

type: AdminWebService.StringType

importTroubles

type: AdminWebService.importTrouble

This is a list with an unlimited number of items.

keyFields

type: AdminWebService.StringType

This is a list with an unlimited number of items.

success

type: AdminWebService.BooleanType

uploadDuplicatesCount

type: AdminWebService.LongType

uploadErrorsCount

type: AdminWebService.LongType

warningsCount

type: AdminWebService.StringType

dispRecordsUpdated

type: AdminWebService.LongType

class AdminWebService.dispositionsUpdateMode

Values:

  • UPDATE_ALL
  • UPDATE_IF_SOLE_CRM_MATCH
class AdminWebService.dispositionsUpdateSettings
allowDataCleanup

type: AdminWebService.BooleanType

callbackFormat

type: AdminWebService.callbackFormat

callbackUrl

type: AdminWebService.StringType

countryCode

type: AdminWebService.StringType

failOnFieldParseError

type: AdminWebService.BooleanType

fieldsMapping

type: AdminWebService.fieldEntry

This is a list with an unlimited number of items.

reportEmail

type: AdminWebService.StringType

separator

type: AdminWebService.StringType

skipHeaderLine

type: AdminWebService.BooleanType

commonDispositionValue

type: AdminWebService.StringType

dispositionColumnNumber

type: AdminWebService.IntType

dispositionsUpdateMode

type: AdminWebService.dispositionsUpdateMode

updateToCommonDisposition

type: AdminWebService.BooleanType

warnIfNoCrmMatchFound

type: AdminWebService.BooleanType

class AdminWebService.distributionAlgorithm

Values:

  • LongestReadyTime
  • LongestReadyTimeExcludeMC
  • RoundRobin
  • MinCallsHandled
  • MinHandleTime
class AdminWebService.distributionTimeFrame

Values:

  • minutes15
  • minutes30
  • minutes60
  • hours8
  • hours24
  • thisDay
class AdminWebService.emailNotifications
emailAddress

type: AdminWebService.StringType

maxAttachmentSize

type: AdminWebService.IntType

newUserNotification

type: AdminWebService.BooleanType

class AdminWebService.extensionSettings
maximalExtensionLength

type: AdminWebService.IntType

minimalExtensionLength

type: AdminWebService.IntType

minimalGeneratedExtension

type: AdminWebService.StringType

class AdminWebService.fieldEntry
columnNumber

type: AdminWebService.IntType

fieldName

type: AdminWebService.StringType

key

type: AdminWebService.BooleanType

class AdminWebService.forceStopCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.forceStopCampaignResponse
class AdminWebService.ftpImportSettings
hostname

type: AdminWebService.StringType

password

type: AdminWebService.StringType

path

type: AdminWebService.StringType

username

type: AdminWebService.StringType

class AdminWebService.generalCampaign
description

type: AdminWebService.StringType

mode

type: AdminWebService.campaignMode

name

type: AdminWebService.StringType

profileName

type: AdminWebService.StringType

state

type: AdminWebService.campaignState

trainingMode

type: AdminWebService.BooleanType

type

type: AdminWebService.campaignType

autoRecord

type: AdminWebService.BooleanType

callWrapup

type: AdminWebService.campaignCallWrapup

ftpHost

type: AdminWebService.StringType

ftpPassword

type: AdminWebService.StringType

ftpUser

type: AdminWebService.StringType

recordingNameAsSid

type: AdminWebService.BooleanType

useFtp

type: AdminWebService.BooleanType

class AdminWebService.getAgentAuditReport
time

type: AdminWebService.reportTimeCriteria

criteria

type: AdminWebService.agentAuditReportCriteria

class AdminWebService.getAgentAuditReportCsv
time

type: AdminWebService.reportTimeCriteria

criteria

type: AdminWebService.agentAuditReportCriteria

class AdminWebService.getAgentAuditReportCsvResponse
return

type: AdminWebService.StringType

class AdminWebService.getAgentAuditReportResponse
return

type: AdminWebService.reportRowData

class AdminWebService.getAgentGroup
groupName

type: AdminWebService.StringType

class AdminWebService.getAgentGroupResponse
return

type: AdminWebService.agentGroup

class AdminWebService.getAgentGroups
groupNamePattern

type: AdminWebService.StringType

class AdminWebService.getAgentGroupsResponse
return

type: AdminWebService.agentGroup

This is a list with an unlimited number of items.

class AdminWebService.getApiVersions
class AdminWebService.getApiVersionsResponse
return

type: AdminWebService.versions

class AdminWebService.getAutodialCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.getAutodialCampaignResponse
return

type: AdminWebService.autodialCampaign

class AdminWebService.getAvailableLocales
class AdminWebService.getAvailableLocalesResponse
return

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.getCallCountersState
class AdminWebService.getCallCountersStateResponse
return

type: AdminWebService.limitTimeoutState

This is a list with an unlimited number of items.

class AdminWebService.getCallLogReport
time

type: AdminWebService.reportTimeCriteria

criteria

type: AdminWebService.callLogReportCriteria

class AdminWebService.getCallLogReportCsv
time

type: AdminWebService.reportTimeCriteria

criteria

type: AdminWebService.callLogReportCriteria

class AdminWebService.getCallLogReportCsvResponse
return

type: AdminWebService.StringType

class AdminWebService.getCallLogReportResponse
return

type: AdminWebService.reportRowData

class AdminWebService.getCallVariableGroups
namePattern

type: AdminWebService.StringType

class AdminWebService.getCallVariableGroupsResponse
return

type: AdminWebService.callVariablesGroup

This is a list with an unlimited number of items.

class AdminWebService.getCallVariables
namePattern

type: AdminWebService.StringType

groupName

type: AdminWebService.StringType

class AdminWebService.getCallVariablesResponse
return

type: AdminWebService.callVariable

This is a list with an unlimited number of items.

class AdminWebService.getCampaignDNISList
campaignName

type: AdminWebService.StringType

class AdminWebService.getCampaignDNISListResponse
return

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.getCampaignProfileDispositions
profileName

type: AdminWebService.StringType

class AdminWebService.getCampaignProfileDispositionsResponse
return

type: AdminWebService.dispositionCount

This is a list with an unlimited number of items.

class AdminWebService.getCampaignProfileFilter
profileName

type: AdminWebService.StringType

class AdminWebService.getCampaignProfileFilterResponse
return

type: AdminWebService.campaignProfileFilter

class AdminWebService.getCampaignProfiles
namePattern

type: AdminWebService.StringType

class AdminWebService.getCampaignProfilesResponse
return

type: AdminWebService.campaignProfileInfo

This is a list with an unlimited number of items.

class AdminWebService.getCampaignState
campaignName

type: AdminWebService.StringType

waitUntilChange

type: AdminWebService.LongType

class AdminWebService.getCampaignStateResponse
return

type: AdminWebService.campaignState

class AdminWebService.getCampaignStrategies
campaignName

type: AdminWebService.StringType

class AdminWebService.getCampaignStrategiesResponse
return

type: AdminWebService.campaignStrategies

class AdminWebService.getCampaigns
campaignNamePattern

type: AdminWebService.StringType

campaignType

type: AdminWebService.campaignType

class AdminWebService.getCampaignsResponse
return

type: AdminWebService.campaign

This is a list with an unlimited number of items.

class AdminWebService.getConfigurationTranslations
localeName

type: AdminWebService.StringType

class AdminWebService.getConfigurationTranslationsResponse
return

type: AdminWebService.adminConfigTranslation

This is a list with an unlimited number of items.

class AdminWebService.getContactFields
namePattern

type: AdminWebService.StringType

class AdminWebService.getContactFieldsResponse
return

type: AdminWebService.contactField

This is a list with an unlimited number of items.

class AdminWebService.getContactRecords
lookupCriteria

type: AdminWebService.crmLookupCriteria

class AdminWebService.getContactRecordsResponse
return

type: AdminWebService.contactsLookupResult

class AdminWebService.getCrmImportResult
identifier

type: AdminWebService.importIdentifier

class AdminWebService.getCrmImportResultResponse
return

type: AdminWebService.crmImportResult

class AdminWebService.getDNISList
selectUnassigned

type: AdminWebService.BooleanType

class AdminWebService.getDNISListResponse
return

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.getDialingRules
namePattern

type: AdminWebService.StringType

class AdminWebService.getDialingRulesResponse
return

type: AdminWebService.dialingRule

This is a list with an unlimited number of items.

class AdminWebService.getDisposition
dispositionName

type: AdminWebService.StringType

class AdminWebService.getDispositionResponse
return

type: AdminWebService.disposition

class AdminWebService.getDispositions
dispositionNamePattern

type: AdminWebService.StringType

class AdminWebService.getDispositionsImportResult
identifier

type: AdminWebService.importIdentifier

class AdminWebService.getDispositionsImportResultResponse
return

type: AdminWebService.dispositionsImportResult

class AdminWebService.getDispositionsResponse
return

type: AdminWebService.disposition

This is a list with an unlimited number of items.

class AdminWebService.getIVRScripts
namePattern

type: AdminWebService.StringType

class AdminWebService.getIVRScriptsResponse
return

type: AdminWebService.ivrScriptDef

This is a list with an unlimited number of items.

class AdminWebService.getInboundCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.getInboundCampaignResponse
return

type: AdminWebService.inboundCampaign

class AdminWebService.getListImportResult
identifier

type: AdminWebService.importIdentifier

class AdminWebService.getListImportResultResponse
return

type: AdminWebService.listImportResult

class AdminWebService.getListsForCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.getListsForCampaignResponse
return

type: AdminWebService.listState

This is a list with an unlimited number of items.

class AdminWebService.getListsInfo
listNamePattern

type: AdminWebService.StringType

class AdminWebService.getListsInfoResponse
return

type: AdminWebService.listInfo

This is a list with an unlimited number of items.

class AdminWebService.getLocale
class AdminWebService.getLocaleResponse
return

type: AdminWebService.StringType

class AdminWebService.getOutboundCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.getOutboundCampaignResponse
return

type: AdminWebService.outboundCampaign

class AdminWebService.getPrompt
promptName

type: AdminWebService.StringType

class AdminWebService.getPromptResponse
return

type: AdminWebService.promptInfo

class AdminWebService.getPrompts
class AdminWebService.getPromptsResponse
prompts

type: AdminWebService.promptInfo

This is a list with an unlimited number of items.

class AdminWebService.getReasonCode
reasonCodeName

type: AdminWebService.StringType

class AdminWebService.getReasonCodeByType
reasonCodeName

type: AdminWebService.StringType

type

type: AdminWebService.reasonCodeType

class AdminWebService.getReasonCodeByTypeResponse
return

type: AdminWebService.reasonCode

class AdminWebService.getReasonCodeResponse
return

type: AdminWebService.reasonCode

class AdminWebService.getReportResult
identifier

type: AdminWebService.StringType

class AdminWebService.getReportResultCsv
identifier

type: AdminWebService.StringType

class AdminWebService.getReportResultCsvResponse
return

type: AdminWebService.StringType

class AdminWebService.getReportResultResponse
return

type: AdminWebService.reportRowData

class AdminWebService.getSkill
skillName

type: AdminWebService.StringType

class AdminWebService.getSkillAudioFiles
skillName

type: AdminWebService.StringType

class AdminWebService.getSkillAudioFilesResponse
prompts

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.getSkillInfo
skillName

type: AdminWebService.StringType

class AdminWebService.getSkillInfoResponse
return

type: AdminWebService.skillInfo

class AdminWebService.getSkillResponse
return

type: AdminWebService.skill

class AdminWebService.getSkillVoicemailGreeting
skillName

type: AdminWebService.StringType

class AdminWebService.getSkillVoicemailGreetingResponse
return

type: AdminWebService.StringType

class AdminWebService.getSkills
skillNamePattern

type: AdminWebService.StringType

class AdminWebService.getSkillsInfo
skillNamePattern

type: AdminWebService.StringType

class AdminWebService.getSkillsInfoResponse
return

type: AdminWebService.skillInfo

This is a list with an unlimited number of items.

class AdminWebService.getSkillsResponse
return

type: AdminWebService.skill

This is a list with an unlimited number of items.

class AdminWebService.getUserGeneralInfo
userName

type: AdminWebService.StringType

class AdminWebService.getUserGeneralInfoResponse
return

type: AdminWebService.userGeneralInfo

class AdminWebService.getUserInfo
userName

type: AdminWebService.StringType

class AdminWebService.getUserInfoResponse
return

type: AdminWebService.userInfo

class AdminWebService.getUserProfile
userProfileName

type: AdminWebService.StringType

class AdminWebService.getUserProfileResponse
return

type: AdminWebService.userProfile

class AdminWebService.getUserProfiles
userProfileNamePatern

type: AdminWebService.StringType

class AdminWebService.getUserProfilesResponse
return

type: AdminWebService.userProfile

This is a list with an unlimited number of items.

class AdminWebService.getUserVoicemailGreeting
userName

type: AdminWebService.StringType

class AdminWebService.getUserVoicemailGreetingResponse
return

type: AdminWebService.StringType

class AdminWebService.getUsersGeneralInfo
userNamePattern

type: AdminWebService.StringType

class AdminWebService.getUsersGeneralInfoResponse
return

type: AdminWebService.userGeneralInfo

This is a list with an unlimited number of items.

class AdminWebService.getUsersInfo
userNamePattern

type: AdminWebService.StringType

class AdminWebService.getUsersInfoResponse
return

type: AdminWebService.userInfo

This is a list with an unlimited number of items.

class AdminWebService.getVCCConfiguration
class AdminWebService.getVCCConfigurationResponse
return

type: AdminWebService.vccConfiguration

class AdminWebService.getWebConnectors
namePattern

type: AdminWebService.StringType

class AdminWebService.getWebConnectorsResponse
return

type: AdminWebService.webConnector

This is a list with an unlimited number of items.

class AdminWebService.i18NObjectField

Values:

  • NAME
  • DESCRIPTION
class AdminWebService.i18NObjectType

Values:

  • REASON_CODE
  • CAMPAIGN
  • SKILL
  • CONNECTOR
  • SPEED_DIAL
  • DISPOSITION
  • CONTACT_FIELD
  • FIELD_VIEW
  • LIST
  • CALL_TYPE
  • EVENT_TYPE
  • MEDIA_TYPE
  • SEGMENT_TYPE
  • IVR_MODULE_TYPE
  • OUTREACH_IND
  • WORK_ITEM_STATUS
class AdminWebService.importData
values

type: AdminWebService.stringArray

This is a list with an unlimited number of items.

class AdminWebService.importIdentifier
identifier

type: AdminWebService.StringType

class AdminWebService.importTrouble
key

type: AdminWebService.StringType

This is a list with an unlimited number of items.

kind

type: AdminWebService.importTroubleKind

rowNumber

type: AdminWebService.IntType

troubleMessage

type: AdminWebService.StringType

class AdminWebService.importTroubleKind

Values:

  • ParseError
  • DuplicateKey
  • AllKeyFieldsAreEmpty
  • NoMatchesInContacts
  • OneMatchInContacts
  • MultipleMatchesInContacts
  • InternalImportError
class AdminWebService.inboundCampaign
description

type: AdminWebService.StringType

mode

type: AdminWebService.campaignMode

name

type: AdminWebService.StringType

profileName

type: AdminWebService.StringType

state

type: AdminWebService.campaignState

trainingMode

type: AdminWebService.BooleanType

type

type: AdminWebService.campaignType

autoRecord

type: AdminWebService.BooleanType

callWrapup

type: AdminWebService.campaignCallWrapup

ftpHost

type: AdminWebService.StringType

ftpPassword

type: AdminWebService.StringType

ftpUser

type: AdminWebService.StringType

recordingNameAsSid

type: AdminWebService.BooleanType

useFtp

type: AdminWebService.BooleanType

defaultIvrSchedule

type: AdminWebService.inboundIvrScriptSchedule

maxNumOfLines

type: AdminWebService.IntType

class AdminWebService.inboundIvrScriptSchedule
ivrSchedule

type: AdminWebService.ivrScriptSchedule

visualModeSettings

type: AdminWebService.visualModeSettings

class AdminWebService.isImportRunning
identifier

type: AdminWebService.importIdentifier

waitTime

type: AdminWebService.LongType

class AdminWebService.isImportRunningResponse
return

type: AdminWebService.BooleanType

class AdminWebService.isReportRunning
identifier

type: AdminWebService.StringType

timeout

type: AdminWebService.LongType

class AdminWebService.isReportRunningResponse
return

type: AdminWebService.BooleanType

class AdminWebService.ivrScriptDef
description

type: AdminWebService.StringType

name

type: AdminWebService.StringType

xmlDefinition

type: AdminWebService.StringType

class AdminWebService.ivrScriptSchedule
name

type: AdminWebService.StringType

scriptName

type: AdminWebService.StringType

scriptParameters

type: AdminWebService.scriptParameterValue

This is a list with an unlimited number of items.

class AdminWebService.keyPerfomanceIndicators
minTimeOfResponse

type: AdminWebService.IntType

speedOfAnswer

type: AdminWebService.IntType

class AdminWebService.keyValuePair
key

type: AdminWebService.StringType

value

type: AdminWebService.StringType

class AdminWebService.limitTimeoutState
callCounterStates

type: AdminWebService.callCounterState

This is a list with an unlimited number of items.

timeout

type: AdminWebService.LongType

class AdminWebService.listAddMode

Values:

  • ADD_FIRST
  • ADD_ALL
  • ADD_IF_SOLE_CRM_MATCH
class AdminWebService.listDeleteMode

Values:

  • DELETE_ALL
  • DELETE_IF_SOLE_CRM_MATCH
  • DELETE_EXCEPT_FIRST
class AdminWebService.listDeleteSettings
allowDataCleanup

type: AdminWebService.BooleanType

callbackFormat

type: AdminWebService.callbackFormat

callbackUrl

type: AdminWebService.StringType

countryCode

type: AdminWebService.StringType

failOnFieldParseError

type: AdminWebService.BooleanType

fieldsMapping

type: AdminWebService.fieldEntry

This is a list with an unlimited number of items.

reportEmail

type: AdminWebService.StringType

separator

type: AdminWebService.StringType

skipHeaderLine

type: AdminWebService.BooleanType

listDeleteMode

type: AdminWebService.listDeleteMode

class AdminWebService.listDialingMode

Values:

  • VERTICAL_DIALING
  • LIST_PENETRATION
  • EXTENDED_STRATEGY
class AdminWebService.listImportResult
failureMessage

type: AdminWebService.StringType

importIdentifier

type: AdminWebService.StringType

importTroubles

type: AdminWebService.importTrouble

This is a list with an unlimited number of items.

keyFields

type: AdminWebService.StringType

This is a list with an unlimited number of items.

success

type: AdminWebService.BooleanType

uploadDuplicatesCount

type: AdminWebService.LongType

uploadErrorsCount

type: AdminWebService.LongType

warningsCount

type: AdminWebService.StringType

callNowQueued

type: AdminWebService.LongType

crmRecordsInserted

type: AdminWebService.LongType

crmRecordsUpdated

type: AdminWebService.LongType

listName

type: AdminWebService.StringType

listRecordsDeleted

type: AdminWebService.LongType

listRecordsInserted

type: AdminWebService.LongType

recordDispositionsReset

type: AdminWebService.LongType

class AdminWebService.listInfo
name

type: AdminWebService.StringType

size

type: AdminWebService.IntType

class AdminWebService.listState
campaignName

type: AdminWebService.StringType

dialingPriority

type: AdminWebService.IntType

dialingRatio

type: AdminWebService.IntType

listName

type: AdminWebService.StringType

priority

type: AdminWebService.IntType

class AdminWebService.listUpdateSettings
allowDataCleanup

type: AdminWebService.BooleanType

callbackFormat

type: AdminWebService.callbackFormat

callbackUrl

type: AdminWebService.StringType

countryCode

type: AdminWebService.StringType

failOnFieldParseError

type: AdminWebService.BooleanType

fieldsMapping

type: AdminWebService.fieldEntry

This is a list with an unlimited number of items.

reportEmail

type: AdminWebService.StringType

separator

type: AdminWebService.StringType

skipHeaderLine

type: AdminWebService.BooleanType

callNowColumnNumber

type: AdminWebService.IntType

callNowMode

type: AdminWebService.callNowMode

callTime

type: AdminWebService.LongType

callTimeColumnNumber

type: AdminWebService.IntType

cleanListBeforeUpdate

type: AdminWebService.BooleanType

crmAddMode

type: AdminWebService.crmAddMode

crmUpdateMode

type: AdminWebService.crmUpdateMode

listAddMode

type: AdminWebService.listAddMode

class AdminWebService.listUpdateSimpleSettings
callAsap

type: AdminWebService.BooleanType

countryCode

type: AdminWebService.StringType

fieldsMapping

type: AdminWebService.fieldEntry

This is a list with an unlimited number of items.

timeToCall

type: AdminWebService.LongType

updateCRM

type: AdminWebService.BooleanType

class AdminWebService.mediaType

Values:

  • VOICE
  • CHAT
  • SOCIAL
  • EMAIL
  • VIDEO
class AdminWebService.mediaTypeConfig
mediaTypes

type: AdminWebService.mediaTypeItem

This is a list with an unlimited number of items.

class AdminWebService.mediaTypeItem
enabled

type: AdminWebService.BooleanType

intlligentRouting

type: AdminWebService.BooleanType

maxAlowed

type: AdminWebService.StringType

type

type: AdminWebService.mediaType

class AdminWebService.miscVccOptions
defaultCampaign

type: AdminWebService.StringType

enableReasonCodes

type: AdminWebService.BooleanType

internalCallTimeout

type: AdminWebService.IntType

maySelectCampaign

type: AdminWebService.BooleanType

maySelectNone

type: AdminWebService.BooleanType

showDialAttempts

type: AdminWebService.BooleanType

voicemailTimeout

type: AdminWebService.IntType

class AdminWebService.modifyAgentGroup
group

type: AdminWebService.agentGroup

addAgents

type: AdminWebService.StringType

This is a list with an unlimited number of items.

removeAgents

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.modifyAgentGroupResponse
class AdminWebService.modifyAutodialCampaign
campaign

type: AdminWebService.autodialCampaign

class AdminWebService.modifyAutodialCampaignResponse
class AdminWebService.modifyCallVariable
variable

type: AdminWebService.callVariable

class AdminWebService.modifyCallVariableResponse
class AdminWebService.modifyCallVariablesGroup
name

type: AdminWebService.StringType

description

type: AdminWebService.StringType

class AdminWebService.modifyCallVariablesGroupResponse
class AdminWebService.modifyCampaignLists
campaignName

type: AdminWebService.StringType

lists

type: AdminWebService.listState

This is a list with an unlimited number of items.

class AdminWebService.modifyCampaignListsResponse
class AdminWebService.modifyCampaignProfile
campaignProfile

type: AdminWebService.campaignProfileInfo

class AdminWebService.modifyCampaignProfileCrmCriteria
profileName

type: AdminWebService.StringType

grouping

type: AdminWebService.crmCriteriaGrouping

addCriteria

type: AdminWebService.campaignFilterCriterion

This is a list with an unlimited number of items.

removeCriteria

type: AdminWebService.campaignFilterCriterion

This is a list with an unlimited number of items.

class AdminWebService.modifyCampaignProfileCrmCriteriaResponse
class AdminWebService.modifyCampaignProfileDispositions
profileName

type: AdminWebService.StringType

addDispositionCounts

type: AdminWebService.dispositionCount

This is a list with an unlimited number of items.

removeDispositionCounts

type: AdminWebService.dispositionCount

This is a list with an unlimited number of items.

class AdminWebService.modifyCampaignProfileDispositionsResponse
class AdminWebService.modifyCampaignProfileFilterOrder
campaignProfile

type: AdminWebService.StringType

addOrderByField

type: AdminWebService.orderByField

This is a list with an unlimited number of items.

removeOrderByField

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.modifyCampaignProfileFilterOrderResponse
class AdminWebService.modifyCampaignProfileResponse
class AdminWebService.modifyContactField
field

type: AdminWebService.contactField

class AdminWebService.modifyContactFieldResponse
class AdminWebService.modifyDisposition
disposition

type: AdminWebService.disposition

class AdminWebService.modifyDispositionResponse
class AdminWebService.modifyIVRScript
scriptDef

type: AdminWebService.ivrScriptDef

class AdminWebService.modifyIVRScriptResponse
class AdminWebService.modifyInboundCampaign
campaign

type: AdminWebService.inboundCampaign

class AdminWebService.modifyInboundCampaignResponse
class AdminWebService.modifyOutboundCampaign
campaign

type: AdminWebService.outboundCampaign

class AdminWebService.modifyOutboundCampaignResponse
class AdminWebService.modifyPromptTTS
prompt

type: AdminWebService.promptInfo

ttsInfo

type: AdminWebService.ttsInfo

class AdminWebService.modifyPromptTTSResponse
class AdminWebService.modifyPromptWav
prompt

type: AdminWebService.promptInfo

wavFile

type: AdminWebService.swaRef

class AdminWebService.modifyPromptWavInline
prompt

type: AdminWebService.promptInfo

wavFile

type: AdminWebService.StringType

class AdminWebService.modifyPromptWavInlineResponse
class AdminWebService.modifyPromptWavResponse
class AdminWebService.modifyReasonCode
reasonCode

type: AdminWebService.reasonCode

class AdminWebService.modifyReasonCodeResponse
class AdminWebService.modifySkill
skill

type: AdminWebService.skill

class AdminWebService.modifySkillResponse
return

type: AdminWebService.skillInfo

class AdminWebService.modifyUser
userGeneralInfo

type: AdminWebService.userGeneralInfo

rolesToSet

type: AdminWebService.userRoles

rolesToRemove

type: AdminWebService.userRoleType

This is a list with an unlimited number of items.

class AdminWebService.modifyUserCannedReports
userName

type: AdminWebService.StringType

cannedReportsToAdd

type: AdminWebService.cannedReport

This is a list with an unlimited number of items.

cannedReportsToRemove

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.modifyUserCannedReportsResponse
return

type: AdminWebService.userInfo

class AdminWebService.modifyUserProfile
userProfile

type: AdminWebService.userProfile

class AdminWebService.modifyUserProfileResponse
class AdminWebService.modifyUserProfileSkills
userProfileName

type: AdminWebService.StringType

addSkills

type: AdminWebService.StringType

This is a list with an unlimited number of items.

removeSkills

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.modifyUserProfileSkillsResponse
class AdminWebService.modifyUserProfileUserList
userProfileName

type: AdminWebService.StringType

addUsers

type: AdminWebService.StringType

This is a list with an unlimited number of items.

removeUsers

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.modifyUserProfileUserListResponse
class AdminWebService.modifyUserResponse
return

type: AdminWebService.userInfo

class AdminWebService.modifyVCCConfiguration
configuration

type: AdminWebService.vccConfiguration

class AdminWebService.modifyVCCConfigurationResponse
class AdminWebService.modifyWebConnector
connector

type: AdminWebService.webConnector

class AdminWebService.modifyWebConnectorResponse
class AdminWebService.niceLicenseType

Values:

  • USER
  • SCREEN_RECORDED_AGENT
  • IEX_SCHEDULED_AGENT
class AdminWebService.operationType

Values:

  • Add
  • Update
  • Remove
class AdminWebService.orderByField
descending

type: AdminWebService.BooleanType

fieldName

type: AdminWebService.StringType

rank

type: AdminWebService.IntType

class AdminWebService.outboundCampaign
description

type: AdminWebService.StringType

mode

type: AdminWebService.campaignMode

name

type: AdminWebService.StringType

profileName

type: AdminWebService.StringType

state

type: AdminWebService.campaignState

trainingMode

type: AdminWebService.BooleanType

type

type: AdminWebService.campaignType

autoRecord

type: AdminWebService.BooleanType

callWrapup

type: AdminWebService.campaignCallWrapup

ftpHost

type: AdminWebService.StringType

ftpPassword

type: AdminWebService.StringType

ftpUser

type: AdminWebService.StringType

recordingNameAsSid

type: AdminWebService.BooleanType

useFtp

type: AdminWebService.BooleanType

analyzeLevel

type: AdminWebService.IntType

CRMRedialTimeout

type: AdminWebService.timer

dnisAsAni

type: AdminWebService.BooleanType

enableListDialingRatios

type: AdminWebService.BooleanType

listDialingMode

type: AdminWebService.listDialingMode

noOutOfNumbersAlert

type: AdminWebService.BooleanType

stateDialingRule

type: AdminWebService.campaignStateDialingRule

timeZoneAssignment

type: AdminWebService.campaignTimeZoneAssignment

actionOnAnswerMachine

type: AdminWebService.campaignDialingAction

actionOnQueueExpiration

type: AdminWebService.campaignDialingAction

callAnalysisMode

type: AdminWebService.callAnalysisMode

callsAgentRatio

type: AdminWebService.FloatType

dialNumberOnTimeout

type: AdminWebService.BooleanType

dialingMode

type: AdminWebService.campaignDialingMode

dialingPriority

type: AdminWebService.IntType

dialingRatio

type: AdminWebService.IntType

distributionAlgorithm

type: AdminWebService.distributionAlgorithm

distributionTimeFrame

type: AdminWebService.distributionTimeFrame

limitPreviewTime

type: AdminWebService.BooleanType

maxDroppedCallsPercentage

type: AdminWebService.FloatType

maxPreviewTime

type: AdminWebService.timer

maxQueueTime

type: AdminWebService.timer

monitorDroppedCalls

type: AdminWebService.BooleanType

previewDialImmediately

type: AdminWebService.BooleanType

useTelemarketingMaxQueTimeEq1

type: AdminWebService.BooleanType

class AdminWebService.passwordPolicies
adminLoginAttempts

type: AdminWebService.IntType

enforcePasswordHistory

type: AdminWebService.IntType

loginAttempts

type: AdminWebService.IntType

minCapitalCharacters

type: AdminWebService.IntType

minNumberCharacters

type: AdminWebService.IntType

minPasswordLength

type: AdminWebService.IntType

minSpecialCharacters

type: AdminWebService.IntType

passwordExpires

type: AdminWebService.IntType

class AdminWebService.promptInfo
description

type: AdminWebService.StringType

languages

type: AdminWebService.StringType

This is a list with an unlimited number of items.

name

type: AdminWebService.StringType

type

type: AdminWebService.promptType

class AdminWebService.promptType

Values:

  • TTSGenerated
  • PreRecorded
class AdminWebService.reasonCode
enabled

type: AdminWebService.BooleanType

name

type: AdminWebService.StringType

paidTime

type: AdminWebService.BooleanType

shortcut

type: AdminWebService.IntType

type

type: AdminWebService.reasonCodeType

class AdminWebService.reasonCodeType

Values:

  • NotReady
  • Logout
class AdminWebService.record
values

type: AdminWebService.StringType

class AdminWebService.recordData
fields

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.remoteHostLoginSettings
hostName

type: AdminWebService.StringType

password

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.removeDNISFromCampaign
campaignName

type: AdminWebService.StringType

DNISList

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.removeDNISFromCampaignResponse
class AdminWebService.removeDisposition
dispositionName

type: AdminWebService.StringType

class AdminWebService.removeDispositionResponse
class AdminWebService.removeDispositionsFromCampaign
campaignName

type: AdminWebService.StringType

dispositions

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.removeDispositionsFromCampaignResponse
class AdminWebService.removeListsFromCampaign
campaignName

type: AdminWebService.StringType

lists

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.removeListsFromCampaignResponse
class AdminWebService.removeNumbersFromDnc
numbers

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.removeNumbersFromDncResponse
return

type: AdminWebService.IntType

class AdminWebService.removeSkillAudioFile
skillName

type: AdminWebService.StringType

promptName

type: AdminWebService.StringType

class AdminWebService.removeSkillAudioFileResponse
class AdminWebService.removeSkillsFromCampaign
campaignName

type: AdminWebService.StringType

skills

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.removeSkillsFromCampaignResponse
class AdminWebService.renameCampaign
campaignName

type: AdminWebService.StringType

campaignNewName

type: AdminWebService.StringType

class AdminWebService.renameCampaignResponse
class AdminWebService.renameDisposition
dispositionName

type: AdminWebService.StringType

dispositionNewName

type: AdminWebService.StringType

class AdminWebService.renameDispositionResponse
class AdminWebService.reportObjectList
objectNames

type: AdminWebService.StringType

This is a list with an unlimited number of items.

objectType

type: AdminWebService.wsObjectType

class AdminWebService.reportRowData
header

type: AdminWebService.record

records

type: AdminWebService.record

This is a list with an unlimited number of items.

class AdminWebService.reportTimeCriteria
end

type: AdminWebService.DateTimeType

start

type: AdminWebService.DateTimeType

class AdminWebService.reportingPermission
type

type: AdminWebService.reportingPermissionType

value

type: AdminWebService.BooleanType

class AdminWebService.reportingPermissionType

Values:

  • CanScheduleReportsViaFtp
  • CanAccessRecordingsColumn
  • NICEEnabled
  • CanViewStandardReports
  • CanViewCustomReports
  • CanViewScheduledReports
  • CanViewRecentReports
  • CanViewRelease7Reports
  • CanViewCannedReports
  • CanViewDashboards
  • CanViewAllSkills
  • CanViewAllGroups
  • CanViewSocialReports
class AdminWebService.reportingRole
permissions

type: AdminWebService.reportingPermission

This is a list with an unlimited number of items.

class AdminWebService.resetCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.resetCampaignDispositions
campaignName

type: AdminWebService.StringType

dispositions

type: AdminWebService.StringType

This is a list with an unlimited number of items.

after

type: AdminWebService.DateTimeType

before

type: AdminWebService.DateTimeType

class AdminWebService.resetCampaignDispositionsResponse
class AdminWebService.resetCampaignResponse
class AdminWebService.resetListPosition
campaignName

type: AdminWebService.StringType

class AdminWebService.resetListPositionResponse
class AdminWebService.runReport
folderName

type: AdminWebService.StringType

reportName

type: AdminWebService.StringType

criteria

type: AdminWebService.customReportCriteria

class AdminWebService.runReportResponse
return

type: AdminWebService.StringType

class AdminWebService.sForceEmailAccount
consumerKey

type: AdminWebService.StringType

consumerSecret

type: AdminWebService.StringType

enabled

type: AdminWebService.BooleanType

password

type: AdminWebService.StringType

securityToken

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.sayAs

Values:

  • Default
  • Words
  • Acronym
  • Address
  • Cardinal
  • Currency
  • Date
  • Decimal
  • Digits
  • Duration
  • Fraction
  • Letters
  • Measure
  • Name
  • Net
  • Telephone
  • Ordinal
  • Spell
  • Time
class AdminWebService.sayAsFormat

Values:

  • NoFormat
  • Default
  • Date_MDY
  • Date_DMY
  • Date_YMD
  • Date_YM
  • Date_MY
  • Date_DM
  • Date_MD
  • Date_Y
  • Date_M
  • Date_D
  • Duration_HMS
  • Duration_HM
  • Duration_MS
  • Duration_H
  • Duration_M
  • Duration_S
  • Net_URI
  • Net_EMAIL
  • Time_HMS
  • Time_HM
  • Time_H
class AdminWebService.scriptParameterValue
name

type: AdminWebService.StringType

value

type: AdminWebService.StringType

class AdminWebService.setCampaignStrategies
campaignName

type: AdminWebService.StringType

campaignStrategies

type: AdminWebService.campaignStrategies

class AdminWebService.setCampaignStrategiesResponse
class AdminWebService.setDefaultIVRSchedule
campaignName

type: AdminWebService.StringType

scriptName

type: AdminWebService.StringType

params

type: AdminWebService.scriptParameterValue

This is a list with an unlimited number of items.

isVisualModeEnabled

type: AdminWebService.BooleanType

isChatEnabled

type: AdminWebService.BooleanType

class AdminWebService.setDefaultIVRScheduleResponse
class AdminWebService.setDialingRules
setRules

type: AdminWebService.dialingRule

This is a list with an unlimited number of items.

removeRules

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.setDialingRulesResponse
class AdminWebService.setLocale
localeName

type: AdminWebService.StringType

class AdminWebService.setLocaleResponse
class AdminWebService.setSkillVoicemailGreeting
skillName

type: AdminWebService.StringType

wavFile

type: AdminWebService.StringType

class AdminWebService.setSkillVoicemailGreetingResponse
class AdminWebService.setUserVoicemailGreeting
userName

type: AdminWebService.StringType

wavFile

type: AdminWebService.StringType

class AdminWebService.setUserVoicemailGreetingResponse
class AdminWebService.skill
description

type: AdminWebService.StringType

id

type: AdminWebService.LongType

messageOfTheDay

type: AdminWebService.StringType

name

type: AdminWebService.StringType

routeVoiceMails

type: AdminWebService.BooleanType

class AdminWebService.skillInfo
skill

type: AdminWebService.skill

users

type: AdminWebService.userSkill

This is a list with an unlimited number of items.

class AdminWebService.startCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.startCampaignResponse
class AdminWebService.stateDialingRule

Values:

  • REGION
  • REGION_THEN_PHONE_NUMBER
  • REGION_THEN_POSTCODE
class AdminWebService.stateProvince

Values:

  • ANY
  • US_ALABAMA
  • US_ALASKA
  • US_ARIZONA
  • US_ARKANSAS
  • US_CALIFORNIA
  • US_COLORADO
  • US_CONNECTICUT
  • US_DELAWARE
  • US_FLORIDA
  • US_GEORGIA
  • US_HAWAII
  • US_IDAHO
  • US_ILLINOIS
  • US_INDIANA
  • US_IOWA
  • US_KANSAS
  • US_KENTUCKY
  • US_LOUISIANA
  • US_MAINE
  • US_MARYLAND
  • US_MASSACHUSETTS
  • US_MICHIGAN
  • US_MINNESOTA
  • US_MISSISSIPPI
  • US_MISSOURI
  • US_MONTANA
  • US_NEBRASKA
  • US_NEVADA
  • US_NEW_HAMPSHIRE
  • US_NEW_JERSEY
  • US_NEW_MEXICO
  • US_NEW_YORK
  • US_NORTH_CAROLINA
  • US_NORTH_DAKOTA
  • US_OHIO
  • US_OKLAHOMA
  • US_OREGON
  • US_PENNSYLVANIA
  • US_RHODE_ISLAND
  • US_SOUTH_CAROLINA
  • US_SOUTH_DAKOTA
  • US_TENNESSEE
  • US_TEXAS
  • US_UTAH
  • US_VERMONT
  • US_VIRGINIA
  • US_WASHINGTON
  • US_WEST_VIRGINIA
  • US_WISCONSIN
  • US_WYOMING
  • CA_ALBERTA
  • CA_BRITISH_COLUMBIA
  • CA_MANITOBA
  • CA_NEW_BRUNSWICK
  • CA_NEWFOUNDLAND_AND_LABRADOR
  • CA_NOVA_SCOTIA
  • CA_ONTARIO
  • CA_PRINCE_EDWARD_ISLAND
  • CA_QUEBEC
  • CA_SASKATCHEWAN
  • UT_PUERTO_RICO
  • UT_WASHINGTON
  • OTHER
class AdminWebService.stopCampaign
campaignName

type: AdminWebService.StringType

class AdminWebService.stopCampaignResponse
class AdminWebService.stringArray
item

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.supervisorPermission
type

type: AdminWebService.supervisorPermissionType

value

type: AdminWebService.BooleanType

class AdminWebService.supervisorPermissionType

Values:

  • Users
  • Agents
  • CallMonitoring
  • Stations
  • ChatSessions
  • Campaigns
  • CampaignManagement
  • AllSkills
  • BillingInfo
  • BargeInMonitor
  • WhisperMonitor
  • ViewDataForAllAgentGroups
  • ReviewVoiceRecordings
  • EditAgentSkills
  • NICEEnabled
  • CanAccessDashboardMenu
  • CampaignManagementStart
  • CampaignManagementStop
  • CampaignManagementReset
  • CampaignManagementResetDispositions
  • CampaignManagementResetListPositions
  • CampaignManagementResetAbandonCallRate
  • CanViewTextDetailsTab
  • CanAccessShowFields
class AdminWebService.supervisorRole
permissions

type: AdminWebService.supervisorPermission

This is a list with an unlimited number of items.

class AdminWebService.swaRef
class AdminWebService.timePeriod

Values:

  • Second
  • Minute
  • Hour
  • Day
class AdminWebService.timeRange
startHour

type: AdminWebService.IntType

startMinute

type: AdminWebService.IntType

stopHour

type: AdminWebService.IntType

stopMinute

type: AdminWebService.IntType

class AdminWebService.timeZoneAssignment

Values:

  • PHONE_NUMBER
  • POSTCODE_THEN_PHONE_NUMBER
  • REGION_THEN_PHONE_NUMBER
class AdminWebService.timer
days

type: AdminWebService.IntType

hours

type: AdminWebService.IntType

minutes

type: AdminWebService.IntType

seconds

type: AdminWebService.IntType

class AdminWebService.ttsInfo
language

type: AdminWebService.StringType

sayAs

type: AdminWebService.sayAs

sayAsFormat

type: AdminWebService.sayAsFormat

text

type: AdminWebService.StringType

voice

type: AdminWebService.StringType

class AdminWebService.updateConfigurationTranslations
localeName

type: AdminWebService.StringType

diffTranslations

type: AdminWebService.adminConfigTranslation

This is a list with an unlimited number of items.

class AdminWebService.updateConfigurationTranslationsResponse
translationsWithNonExistingKey

type: AdminWebService.adminConfigTranslation

This is a list with an unlimited number of items.

class AdminWebService.updateContacts
crmUpdateSettings

type: AdminWebService.crmUpdateSettings

importData

type: AdminWebService.importData

class AdminWebService.updateContactsCsv
crmUpdateSettings

type: AdminWebService.crmUpdateSettings

csvData

type: AdminWebService.StringType

class AdminWebService.updateContactsCsvResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.updateContactsFtp
updateSettings

type: AdminWebService.crmUpdateSettings

ftpSettings

type: AdminWebService.ftpImportSettings

class AdminWebService.updateContactsFtpResponse
class AdminWebService.updateContactsResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.updateCrmRecord
crmUpdateSettings

type: AdminWebService.crmUpdateSettings

record

type: AdminWebService.recordData

class AdminWebService.updateCrmRecordResponse
return

type: AdminWebService.crmImportResult

class AdminWebService.updateDispositions
campaignName

type: AdminWebService.StringType

DispositionsUpdateSettings

type: AdminWebService.dispositionsUpdateSettings

importData

type: AdminWebService.importData

class AdminWebService.updateDispositionsCsv
campaignName

type: AdminWebService.StringType

DispositionsUpdateSettings

type: AdminWebService.dispositionsUpdateSettings

csvData

type: AdminWebService.StringType

class AdminWebService.updateDispositionsCsvResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.updateDispositionsFtp
campaignName

type: AdminWebService.StringType

updateSettings

type: AdminWebService.dispositionsUpdateSettings

ftpSettings

type: AdminWebService.ftpImportSettings

class AdminWebService.updateDispositionsFtpResponse
class AdminWebService.updateDispositionsResponse
return

type: AdminWebService.importIdentifier

class AdminWebService.userGeneralInfo
active

type: AdminWebService.BooleanType

canChangePassword

type: AdminWebService.BooleanType

EMail

type: AdminWebService.StringType

extension

type: AdminWebService.StringType

firstName

type: AdminWebService.StringType

fullName

type: AdminWebService.StringType

IEXScheduled

type: AdminWebService.BooleanType

id

type: AdminWebService.LongType

lastName

type: AdminWebService.StringType

locale

type: AdminWebService.StringType

mediaTypeConfig

type: AdminWebService.mediaTypeConfig

mustChangePassword

type: AdminWebService.BooleanType

osLogin

type: AdminWebService.StringType

password

type: AdminWebService.StringType

phoneNumber

type: AdminWebService.StringType

startDate

type: AdminWebService.DateTimeType

unifiedCommunicaionId

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

userProfileName

type: AdminWebService.StringType

class AdminWebService.userInfo
agentGroups

type: AdminWebService.StringType

This is a list with an unlimited number of items.

cannedReports

type: AdminWebService.cannedReport

This is a list with an unlimited number of items.

generalInfo

type: AdminWebService.userGeneralInfo

roles

type: AdminWebService.userRoles

skills

type: AdminWebService.userSkill

This is a list with an unlimited number of items.

class AdminWebService.userProfile
description

type: AdminWebService.StringType

IEXScheduled

type: AdminWebService.BooleanType

locale

type: AdminWebService.StringType

mediaTypeConfig

type: AdminWebService.mediaTypeConfig

name

type: AdminWebService.StringType

roles

type: AdminWebService.userRoles

skills

type: AdminWebService.StringType

This is a list with an unlimited number of items.

users

type: AdminWebService.StringType

This is a list with an unlimited number of items.

class AdminWebService.userRoleType

Values:

  • DomainAdmin
  • Agent
  • Supervisor
  • Reporting
class AdminWebService.userRoles
admin

type: AdminWebService.adminRole

agent

type: AdminWebService.agentRole

reporting

type: AdminWebService.reportingRole

supervisor

type: AdminWebService.supervisorRole

class AdminWebService.userSkill
id

type: AdminWebService.LongType

level

type: AdminWebService.IntType

skillName

type: AdminWebService.StringType

userName

type: AdminWebService.StringType

class AdminWebService.userSkillAdd
userSkill

type: AdminWebService.userSkill

class AdminWebService.userSkillAddResponse
class AdminWebService.userSkillModify
userSkill

type: AdminWebService.userSkill

class AdminWebService.userSkillModifyResponse
class AdminWebService.userSkillRemove
userSkill

type: AdminWebService.userSkill

class AdminWebService.userSkillRemoveResponse
class AdminWebService.vccConfiguration
agentProductivity

type: AdminWebService.agentProductivity

campaignsSettings

type: AdminWebService.campaignsSettings

domainId

type: AdminWebService.LongType

domainName

type: AdminWebService.StringType

emailProperties

type: AdminWebService.emailNotifications

extensionSettings

type: AdminWebService.extensionSettings

keyPerfomanceIndicators

type: AdminWebService.keyPerfomanceIndicators

miscOptions

type: AdminWebService.miscVccOptions

passwordPolicies

type: AdminWebService.passwordPolicies

recordingsServer

type: AdminWebService.remoteHostLoginSettings

reportsServer

type: AdminWebService.remoteHostLoginSettings

saleforceEmailAccount

type: AdminWebService.sForceEmailAccount

stateDialingRule

type: AdminWebService.stateDialingRule

timeZoneAssignment

type: AdminWebService.timeZoneAssignment

transcriptsServer

type: AdminWebService.remoteHostLoginSettings

class AdminWebService.versions
maxVersion

type: AdminWebService.StringType

minVersion

type: AdminWebService.StringType

class AdminWebService.visualModeSettings
callbackEnabled

type: AdminWebService.BooleanType

chatEnabled

type: AdminWebService.BooleanType

cssTheme

type: AdminWebService.cssTheme

emailEnabled

type: AdminWebService.BooleanType

sentimentFeedbackEnabled

type: AdminWebService.BooleanType

videoEnabled

type: AdminWebService.BooleanType

visualModeEnabled

type: AdminWebService.BooleanType

xFrameOption

type: AdminWebService.xFrameOption

xFrameOptionUrl

type: AdminWebService.StringType

xFrameOptionsEnabled

type: AdminWebService.BooleanType

class AdminWebService.webConnector
addWorksheet

type: AdminWebService.BooleanType

agentApplication

type: AdminWebService.webConnectorAgentAppType

clearTriggerDispositions

type: AdminWebService.BooleanType

constants

type: AdminWebService.keyValuePair

This is a list with an unlimited number of items.

ctiWebServices

type: AdminWebService.webConnectorCTIWebServicesType

description

type: AdminWebService.StringType

executeInBrowser

type: AdminWebService.BooleanType

name

type: AdminWebService.StringType

postConstants

type: AdminWebService.keyValuePair

This is a list with an unlimited number of items.

postMethod

type: AdminWebService.BooleanType

postVariables

type: AdminWebService.keyValuePair

This is a list with an unlimited number of items.

startPageText

type: AdminWebService.StringType

trigger

type: AdminWebService.webConnectorTriggerType

triggerDispositions

type: AdminWebService.StringType

This is a list with an unlimited number of items.

url

type: AdminWebService.StringType

variables

type: AdminWebService.keyValuePair

This is a list with an unlimited number of items.

class AdminWebService.webConnectorAgentAppType

Values:

  • EmbeddedBrowser
  • ExternalBrowser
class AdminWebService.webConnectorCTIWebServicesType

Values:

  • CurrentBrowserWindow
  • NewBrowserWindow
class AdminWebService.webConnectorTriggerType

Values:

  • OnCallAccepted
  • OnCallDisconnected
  • ManuallyStarted
  • ManuallyStartedAllowDuringPreviews
  • OnPreview
  • OnContactSelection
  • OnWarmTransferInitiation
  • OnCallDispositioned
  • OnChatArrival
  • OnChatTransfer
  • OnChatTermination
  • OnChatClose
  • OnEmailArrival
  • OnEmailTransfer
  • OnEmailClose
class AdminWebService.wsObjectType

Values:

  • AgentGroup
  • Campaign
  • CampaignProfile
  • CrmField
  • Disposition
  • List
  • Prompt
  • ReasonCode
  • Skill
  • User
  • UserProfile
  • IvrScript
  • CallVariableGroup
  • CallVariable
  • Connector
class AdminWebService.xFrameOption

Values:

  • DENY
  • SAME_ORIGIN
  • ALLOW_FROM