Supervisor Web Service

Web Service: WsSupervisorService

Methods

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

SupervisorWebService.acceptChatInvite([chatId, accepted])

Parameters:

• chatId – SupervisorWebService.StringType (optional)
• accepted – SupervisorWebService.BooleanType (optional)

Return type:

SupervisorWebService.acceptChatInviteResponse

SupervisorWebService.closeChatSession([chatId])

Parameters:chatId – SupervisorWebService.StringType (optional) Return type:SupervisorWebService.closeChatSessionResponse

SupervisorWebService.closeSession(parameters)

Parameters:parameters – SupervisorWebService.closeSession Return type:SupervisorWebService.closeSessionResponse

SupervisorWebService.createChatSession(parameters)

Parameters:parameters – SupervisorWebService.createChatSession Return type:SupervisorWebService.createChatSessionResponse

SupervisorWebService.forceStopCampaign([campaignName])

Parameters:campaignName – SupervisorWebService.StringType (optional) Return type:SupervisorWebService.forceStopCampaignResponse

SupervisorWebService.getApiVersions(parameters)

Parameters:parameters – SupervisorWebService.getApiVersions Return type:SupervisorWebService.getApiVersionsResponse

SupervisorWebService.getCallCountersState(parameters)

Parameters:parameters – SupervisorWebService.getCallCountersState Return type:SupervisorWebService.getCallCountersStateResponse

SupervisorWebService.getColumnNames([statisticType])

Parameters:statisticType – SupervisorWebService.statisticType (optional) Return type:SupervisorWebService.getColumnNamesResponse

SupervisorWebService.getDispositionsNames(parameters)

Parameters:parameters – SupervisorWebService.getDispositionsNames Return type:SupervisorWebService.getDispositionsNamesResponse

SupervisorWebService.getLoggedInUsers(parameters)

Parameters:parameters – SupervisorWebService.getLoggedInUsers Return type:SupervisorWebService.getLoggedInUsersResponse

SupervisorWebService.getMonitoringSupervisors([agentName])

Parameters:agentName – SupervisorWebService.StringType (optional) Return type:SupervisorWebService.getMonitoringSupervisorsResponse

SupervisorWebService.getMyGroupIds(parameters)

Parameters:parameters – SupervisorWebService.getMyGroupIds Return type:SupervisorWebService.getMyGroupIdsResponse

SupervisorWebService.getMyPermissions(parameters)

Parameters:parameters – SupervisorWebService.getMyPermissions Return type:SupervisorWebService.getMyPermissionsResponse

SupervisorWebService.getMySkillsIds(parameters)

Parameters:parameters – SupervisorWebService.getMySkillsIds Return type:SupervisorWebService.getMySkillsIdsResponse

SupervisorWebService.getSessionParameters(parameters)

Parameters:parameters – SupervisorWebService.getSessionParameters Return type:SupervisorWebService.getSessionParametersResponse

SupervisorWebService.getStatistics([statisticType, columnNames])

Parameters:

• statisticType – SupervisorWebService.statisticType (optional)
• columnNames – SupervisorWebService.row (optional)

Return type:

SupervisorWebService.getStatisticsResponse

SupervisorWebService.getStatisticsUpdate([statisticType, previousTimestamp, longPollingTimeout])

Parameters:

• statisticType – SupervisorWebService.statisticType (optional)
• previousTimestamp – SupervisorWebService.LongType (optional)
• longPollingTimeout – SupervisorWebService.LongType (optional)

Return type:

SupervisorWebService.getStatisticsUpdateResponse

SupervisorWebService.getUserLimits(parameters)

Parameters:parameters – SupervisorWebService.getUserLimits Return type:SupervisorWebService.getUserLimitsResponse

SupervisorWebService.loginStation([stationName, forceLogoutSession, appType, idleTimeOut])

Parameters:

• stationName – SupervisorWebService.StringType (optional)
• forceLogoutSession – SupervisorWebService.BooleanType (optional)
• appType – SupervisorWebService.StringType (optional)
• idleTimeOut – SupervisorWebService.IntType (optional)

Return type:

SupervisorWebService.loginStationResponse

SupervisorWebService.receiveMessages([previousTimestamp, longPollingTimeout])

Parameters:

• previousTimestamp – SupervisorWebService.LongType (optional)
• longPollingTimeout – SupervisorWebService.LongType (optional)

Return type:

SupervisorWebService.receiveMessagesResponse

SupervisorWebService.reconnectStation(parameters)

Parameters:parameters – SupervisorWebService.reconnectStation Return type:SupervisorWebService.reconnectStationResponse

SupervisorWebService.removeUserFromChat([chatId, user])

Parameters:

• chatId – SupervisorWebService.StringType (optional)
• user – SupervisorWebService.wsRoledId (optional)

Return type:

SupervisorWebService.removeUserFromChatResponse

SupervisorWebService.resetCampaign([campaignName])

Parameters:campaignName – SupervisorWebService.StringType (optional) Return type:SupervisorWebService.resetCampaignResponse

SupervisorWebService.resetCampaignDispositions([campaignName, dispositions, after, before])

Parameters:

• campaignName – SupervisorWebService.StringType (optional)
• dispositions – SupervisorWebService.StringType (optional)
• after – SupervisorWebService.DateTimeType (optional)
• before – SupervisorWebService.DateTimeType (optional)

Return type:

SupervisorWebService.resetCampaignDispositionsResponse

SupervisorWebService.sendBroadcastMessages([type, specId, text])

Parameters:

• type – SupervisorWebService.broadcastType (optional)
• specId – SupervisorWebService.LongType (optional)
• text – SupervisorWebService.StringType (optional)

Return type:

SupervisorWebService.sendBroadcastMessagesResponse

SupervisorWebService.sendChatInvite([chatId, user])

Parameters:

• chatId – SupervisorWebService.StringType (optional)
• user – SupervisorWebService.wsRoledId (optional)

Return type:

SupervisorWebService.sendChatInviteResponse

SupervisorWebService.sendInfoMessage([user, text])

Parameters:

• user – SupervisorWebService.wsRoledId (optional)
• text – SupervisorWebService.StringType (optional)

Return type:

SupervisorWebService.sendInfoMessageResponse

SupervisorWebService.sendMsgToChat([chatId, text])

Parameters:

• chatId – SupervisorWebService.StringType (optional)
• text – SupervisorWebService.StringType (optional)

Return type:

SupervisorWebService.sendMsgToChatResponse

SupervisorWebService.setSessionParameters([viewSettings])

Parameters:viewSettings – SupervisorWebService.viewSettings (optional) Return type:SupervisorWebService.setSessionParametersResponse

SupervisorWebService.startCampaign([campaignName])

Parameters:campaignName – SupervisorWebService.StringType (optional) Return type:SupervisorWebService.startCampaignResponse

SupervisorWebService.startMonitoring([agentName, monitoringMode])

Parameters:

• agentName – SupervisorWebService.StringType (optional)
• monitoringMode – SupervisorWebService.monitoringMode (optional)

Return type:

SupervisorWebService.startMonitoringResponse

SupervisorWebService.stopCampaign([campaignName])

Parameters:campaignName – SupervisorWebService.StringType (optional) Return type:SupervisorWebService.stopCampaignResponse

SupervisorWebService.stopMonitoring([agentName])

Parameters:agentName – SupervisorWebService.StringType (optional) Return type:SupervisorWebService.stopMonitoringResponse

Types

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

class SupervisorWebService.AccessDisallowedFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.AgentMonitorFault

agentName

type: SupervisorWebService.StringType

message

type: SupervisorWebService.StringType

monitorError

type: SupervisorWebService.StringType

class SupervisorWebService.AgentNotFoundFault

agentName

type: SupervisorWebService.StringType

message

type: SupervisorWebService.StringType

class SupervisorWebService.CampaignNotFoundFault

campaignName

type: SupervisorWebService.StringType

message

type: SupervisorWebService.StringType

class SupervisorWebService.CampaignStateUpdateFault

campaignName

type: SupervisorWebService.StringType

details

type: SupervisorWebService.StringType

message

type: SupervisorWebService.StringType

class SupervisorWebService.ChatFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.ConcurrentModificationFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.ConfigurationChangedFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.DispositionNotFoundFault

dispositionName

type: SupervisorWebService.StringType

message

type: SupervisorWebService.StringType

class SupervisorWebService.IncorrectArgumentFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.InvalidAccountFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.MissedArgumentFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.OperationsLimitExceededFault

limit

type: SupervisorWebService.LongType

message

type: SupervisorWebService.StringType

operationType

type: SupervisorWebService.StringType

class SupervisorWebService.ReconnectStationFault

message

type: SupervisorWebService.StringType

problem

type: SupervisorWebService.connectStationProblem

stationName

type: SupervisorWebService.StringType

class SupervisorWebService.ServerFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.ServiceUnavailableFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.SessionClosedFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.SessionNotInitializedFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.StationNotFoundFault

message

type: SupervisorWebService.StringType

stationName

type: SupervisorWebService.StringType

class SupervisorWebService.StationNotLoggedInFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.StatisticsNotRequestedFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.UnknownColumnFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.UnknownTimestampFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.UserAlreadyLoggedInFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.UserLimitReachedFault

message

type: SupervisorWebService.StringType

class SupervisorWebService.WrongCampaignStateFault

actualState

type: SupervisorWebService.campaignState

campaignName

type: SupervisorWebService.StringType

desiredState

type: SupervisorWebService.campaignState

message

type: SupervisorWebService.StringType

class SupervisorWebService.WrongCampaignTypeFault

actualType

type: SupervisorWebService.campaignType

campaignName

type: SupervisorWebService.StringType

desiredTypes

type: SupervisorWebService.campaignType

This is a list with an unlimited number of items.

message

type: SupervisorWebService.StringType

class SupervisorWebService.acceptChatInvite

chatId

type: SupervisorWebService.StringType

accepted

type: SupervisorWebService.BooleanType

class SupervisorWebService.acceptChatInviteResponse

class SupervisorWebService.apiOperationType

Values:

• Query
• Modify
• Upload
• SingleUpload
• ReportRequest
• RetrieveReport
• AsynchronousUpload
• QueryStatistics
• QueryChangedStatistics
• Web2CampaignUpload
• VIVRCreateSession

class SupervisorWebService.broadcastType

Values:

• ALL
• MY_SKILLS
• SPEC_SKILL
• MY_AGENT_GROUPS
• SPEC_AGENT_GROUP

class SupervisorWebService.callCounterState

limit

type: SupervisorWebService.LongType

operationType

type: SupervisorWebService.apiOperationType

value

type: SupervisorWebService.LongType

class SupervisorWebService.campaignState

Values:

• NOT_RUNNING
• STARTING
• RUNNING
• STOPPING
• RESETTING

class SupervisorWebService.campaignType

Values:

• OUTBOUND
• AUTODIAL
• INBOUND

class SupervisorWebService.closeChatSession

chatId

type: SupervisorWebService.StringType

class SupervisorWebService.closeChatSessionResponse

class SupervisorWebService.closeSession

class SupervisorWebService.closeSessionResponse

class SupervisorWebService.codec

Values:

• G711U
• G711A
• G729
• G723
• GSM
• G726
• ILBC

class SupervisorWebService.codecParameters

codecs

type: SupervisorWebService.codec

This is a list with an unlimited number of items.

cryptoSuites

type: SupervisorWebService.cryptoSuite

This is a list with an unlimited number of items.

disableNAT

type: SupervisorWebService.BooleanType

noSilenceSuppression

type: SupervisorWebService.BooleanType

ptime

type: SupervisorWebService.IntType

rfc2833pType

type: SupervisorWebService.IntType

useSRTP

type: SupervisorWebService.BooleanType

class SupervisorWebService.connectStationProblem

Values:

• HARDWARE_TIMEOUT
• OPERATOR_INTERCEPT
• DIAL_ERROR
• RESOURCE_UNAVAILABLE
• BUSY
• NO_ANSWER
• NO_DIALTONE
• HANGUP
• UNKNOWN_ERROR

class SupervisorWebService.connectStationResult

Values:

• CONNECT
• CONNECT_VOICE
• CONNECT_ANSWR_MACHN
• CONNECT_DIGITAL_PHONE
• CONNECT_FAX
• CONNECT_RINGBACK

class SupervisorWebService.createChatSession

class SupervisorWebService.createChatSessionResponse

return

type: SupervisorWebService.StringType

class SupervisorWebService.cryptoSuite

Values:

• AES_CM_128_HMAC_SHA1_80
• AES_CM_128_HMAC_SHA1_32
• F8_128_HMAC_SHA1_80

class SupervisorWebService.forceStopCampaign

campaignName

type: SupervisorWebService.StringType

class SupervisorWebService.forceStopCampaignResponse

class SupervisorWebService.getApiVersions

class SupervisorWebService.getApiVersionsResponse

return

type: SupervisorWebService.versions

class SupervisorWebService.getCallCountersState

class SupervisorWebService.getCallCountersStateResponse

return

type: SupervisorWebService.limitTimeoutState

This is a list with an unlimited number of items.

class SupervisorWebService.getColumnNames

statisticType

type: SupervisorWebService.statisticType

class SupervisorWebService.getColumnNamesResponse

return

type: SupervisorWebService.row

class SupervisorWebService.getDispositionsNames

class SupervisorWebService.getDispositionsNamesResponse

return

type: SupervisorWebService.StringType

This is a list with an unlimited number of items.

class SupervisorWebService.getLoggedInUsers

class SupervisorWebService.getLoggedInUsersResponse

return

type: SupervisorWebService.wsUserRoledId

This is a list with an unlimited number of items.

class SupervisorWebService.getMonitoringSupervisors

agentName

type: SupervisorWebService.StringType

class SupervisorWebService.getMonitoringSupervisorsResponse

return

type: SupervisorWebService.monitoringSupervisor

This is a list with an unlimited number of items.

class SupervisorWebService.getMyGroupIds

class SupervisorWebService.getMyGroupIdsResponse

return

type: SupervisorWebService.wsAgentGroup

This is a list with an unlimited number of items.

class SupervisorWebService.getMyPermissions

class SupervisorWebService.getMyPermissionsResponse

return

type: SupervisorWebService.supervisorPermission

This is a list with an unlimited number of items.

class SupervisorWebService.getMySkillsIds

class SupervisorWebService.getMySkillsIdsResponse

return

type: SupervisorWebService.wsSkill

This is a list with an unlimited number of items.

class SupervisorWebService.getSessionParameters

class SupervisorWebService.getSessionParametersResponse

return

type: SupervisorWebService.viewSettings

class SupervisorWebService.getStatistics

statisticType

type: SupervisorWebService.statisticType

columnNames

type: SupervisorWebService.row

class SupervisorWebService.getStatisticsResponse

return

type: SupervisorWebService.statistics

class SupervisorWebService.getStatisticsUpdate

statisticType

type: SupervisorWebService.statisticType

previousTimestamp

type: SupervisorWebService.LongType

longPollingTimeout

type: SupervisorWebService.LongType

class SupervisorWebService.getStatisticsUpdateResponse

return

type: SupervisorWebService.statisticsUpdate

class SupervisorWebService.getUserLimits

class SupervisorWebService.getUserLimitsResponse

return

type: SupervisorWebService.wsUserLimits

class SupervisorWebService.itemUpdate

columnName

type: SupervisorWebService.StringType

columnValue

type: SupervisorWebService.StringType

objectName

type: SupervisorWebService.StringType

class SupervisorWebService.limitTimeoutState

callCounterStates

type: SupervisorWebService.callCounterState

This is a list with an unlimited number of items.

timeout

type: SupervisorWebService.LongType

class SupervisorWebService.loginStation

stationName

type: SupervisorWebService.StringType

forceLogoutSession

type: SupervisorWebService.BooleanType

appType

type: SupervisorWebService.StringType

idleTimeOut

type: SupervisorWebService.IntType

class SupervisorWebService.loginStationResponse

return

type: SupervisorWebService.stationParameters

class SupervisorWebService.monitoringMode

Values:

• Silence
• BargeIn
• Whispering

class SupervisorWebService.monitoringSupervisor

mode

type: SupervisorWebService.monitoringMode

supervisorName

type: SupervisorWebService.StringType

class SupervisorWebService.receiveMessages

previousTimestamp

type: SupervisorWebService.LongType

longPollingTimeout

type: SupervisorWebService.LongType

class SupervisorWebService.receiveMessagesResponse

return

type: SupervisorWebService.wsChatMessages

class SupervisorWebService.reconnectStation

class SupervisorWebService.reconnectStationResponse

return

type: SupervisorWebService.connectStationResult

class SupervisorWebService.removeUserFromChat

chatId

type: SupervisorWebService.StringType

user

type: SupervisorWebService.wsRoledId

class SupervisorWebService.removeUserFromChatResponse

class SupervisorWebService.resetCampaign

campaignName

type: SupervisorWebService.StringType

class SupervisorWebService.resetCampaignDispositions

campaignName

type: SupervisorWebService.StringType

dispositions

type: SupervisorWebService.StringType

This is a list with an unlimited number of items.

after

type: SupervisorWebService.DateTimeType

before

type: SupervisorWebService.DateTimeType

class SupervisorWebService.resetCampaignDispositionsResponse

class SupervisorWebService.resetCampaignResponse

class SupervisorWebService.rollingPeriod

Values:

• Minutes5
• Minutes10
• Minutes15
• Minutes30
• Hour1
• Hours2
• Hours3
• Today

class SupervisorWebService.row

values

type: SupervisorWebService.StringType

class SupervisorWebService.sendBroadcastMessages

type

type: SupervisorWebService.broadcastType

specId

type: SupervisorWebService.LongType

text

type: SupervisorWebService.StringType

class SupervisorWebService.sendBroadcastMessagesResponse

class SupervisorWebService.sendChatInvite

chatId

type: SupervisorWebService.StringType

user

type: SupervisorWebService.wsRoledId

class SupervisorWebService.sendChatInviteResponse

class SupervisorWebService.sendInfoMessage

user

type: SupervisorWebService.wsRoledId

text

type: SupervisorWebService.StringType

class SupervisorWebService.sendInfoMessageResponse

class SupervisorWebService.sendMsgToChat

chatId

type: SupervisorWebService.StringType

text

type: SupervisorWebService.StringType

class SupervisorWebService.sendMsgToChatResponse

class SupervisorWebService.setSessionParameters

viewSettings

type: SupervisorWebService.viewSettings

class SupervisorWebService.setSessionParametersResponse

class SupervisorWebService.startCampaign

campaignName

type: SupervisorWebService.StringType

class SupervisorWebService.startCampaignResponse

class SupervisorWebService.startMonitoring

agentName

type: SupervisorWebService.StringType

monitoringMode

type: SupervisorWebService.monitoringMode

class SupervisorWebService.startMonitoringResponse

class SupervisorWebService.stationParameters

backupProxy

type: SupervisorWebService.StringType

codecParameters

type: SupervisorWebService.codecParameters

name

type: SupervisorWebService.StringType

password

type: SupervisorWebService.StringType

proxy

type: SupervisorWebService.StringType

class SupervisorWebService.statisticType

Values:

• AgentState
• AgentStatistics
• ACDStatus
• CampaignState
• OutboundCampaignManager
• OutboundCampaignStatistics
• InboundCampaignStatistics
• AutodialCampaignStatistics

class SupervisorWebService.statistics

columns

type: SupervisorWebService.row

rows

type: SupervisorWebService.row

This is a list with an unlimited number of items.

timestamp

type: SupervisorWebService.LongType

type

type: SupervisorWebService.statisticType

class SupervisorWebService.statisticsRange

Values:

• RollingHour
• CurrentDay
• CurrentWeek
• CurrentMonth
• Lifetime
• CurrentShift

class SupervisorWebService.statisticsUpdate

addedObjects

type: SupervisorWebService.row

dataUpdate

type: SupervisorWebService.itemUpdate

This is a list with an unlimited number of items.

deletedObjects

type: SupervisorWebService.row

lastTimestamp

type: SupervisorWebService.LongType

previousTimestamp

type: SupervisorWebService.LongType

type

type: SupervisorWebService.statisticType

class SupervisorWebService.stopCampaign

campaignName

type: SupervisorWebService.StringType

class SupervisorWebService.stopCampaignResponse

class SupervisorWebService.stopMonitoring

agentName

type: SupervisorWebService.StringType

class SupervisorWebService.stopMonitoringResponse

class SupervisorWebService.supervisorPermission

type

type: SupervisorWebService.supervisorPermissionType

value

type: SupervisorWebService.BooleanType

class SupervisorWebService.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 SupervisorWebService.userRole

Values:

• Agent
• DomainSupervisor
• DomainAdmin

class SupervisorWebService.versions

maxVersion

type: SupervisorWebService.StringType

minVersion

type: SupervisorWebService.StringType

class SupervisorWebService.viewSettings

appType

type: SupervisorWebService.StringType

forceLogoutSession

type: SupervisorWebService.BooleanType

idleTimeOut

type: SupervisorWebService.IntType

rollingPeriod

type: SupervisorWebService.rollingPeriod

shiftStart

type: SupervisorWebService.IntType

statisticsRange

type: SupervisorWebService.statisticsRange

timeZone

type: SupervisorWebService.IntType

class SupervisorWebService.wsAgentGroup

id

type: SupervisorWebService.LongType

name

type: SupervisorWebService.StringType

class SupervisorWebService.wsChatMessage

chatId

type: SupervisorWebService.StringType

from

type: SupervisorWebService.wsRoledId

participants

type: SupervisorWebService.wsRoledId

This is a list with an unlimited number of items.

text

type: SupervisorWebService.StringType

timestamp

type: SupervisorWebService.LongType

type

type: SupervisorWebService.wsChatMessageType

class SupervisorWebService.wsChatMessageType

Values:

• BROADCAST
• INFO
• REQUEST
• INVITE
• INVITE_CANCELLED
• ACK
• NACK
• TIMEOUT
• KICK
• BROADCAST_TO_SKILL
• BROADCAST_TO_AGENT_GROUP
• CHAT
• ARRIVED
• LEAVE
• END
• KILLED
• PARTICIPANT_REQ
• PARTICIPANT_RESP
• HELP_REQUEST
• UNKNOWN

class SupervisorWebService.wsChatMessages

messages

type: SupervisorWebService.wsChatMessage

This is a list with an unlimited number of items.

timestamp

type: SupervisorWebService.LongType

class SupervisorWebService.wsRoledId

role

type: SupervisorWebService.userRole

userId

type: SupervisorWebService.LongType

class SupervisorWebService.wsSkill

id

type: SupervisorWebService.LongType

name

type: SupervisorWebService.StringType

class SupervisorWebService.wsUserLimits

mobileLimit

type: SupervisorWebService.IntType

mobileLoggedin

type: SupervisorWebService.IntType

supervisorLimit

type: SupervisorWebService.IntType

supervisorsLoggedin

type: SupervisorWebService.IntType

class SupervisorWebService.wsUserRoledId

name

type: SupervisorWebService.StringType

roledId

type: SupervisorWebService.wsRoledId