Serialized Form


Package de.starface.integration.uci.java.v30.exceptions

Class de.starface.integration.uci.java.v30.exceptions.UciException extends Exception implements Serializable

serialVersionUID: 1L

Class de.starface.integration.uci.java.v30.exceptions.UciIllegalAccessException extends UciException implements Serializable

serialVersionUID: 1L

Class de.starface.integration.uci.java.v30.exceptions.UciIllegalArgumentException extends UciException implements Serializable

serialVersionUID: 1L


Package de.starface.integration.uci.java.v30.types

Class de.starface.integration.uci.java.v30.types.Call extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the call in form of a UUID as String


state

CallState state
The state of the call


timestamp

Date timestamp
The point of time when the call reached the state


calledNumber

String calledNumber
The phone number that has been called


calledName

String calledName
The name of the person being called


callerNumber

String callerNumber
The number of the caller


callerName

String callerName
The name of the person calling


groupId

String groupId
The id of the group if this call was received by a group (the empty string otherwise)


peerNames

List<E> peerNames
Name of the device


channelNames

List<E> channelNames
The channel name


sipCallIds

List<E> sipCallIds
The sip callId


caller

Boolean caller
Is caller


connectedTimestamp

Date connectedTimestamp
The point of time when the call is connected


recorded

Boolean recorded
Is in the current call recording activated


recorder

Boolean recorder
Is in the current call recorded by the user


recordOwner

Boolean recordOwner
Is the user a monitor owner


avatarHash

String avatarHash
AvatarHash of Caller


doorlineCamUrl

String doorlineCamUrl
Doorline Cam of Caller


doorlineDtmfCode

String doorlineDtmfCode
Doorline dtm code


doorlineImageProviderId

Integer doorlineImageProviderId
Doorline image provider id


forwardType

ForwardType forwardType
Forward type


forwarderCallerIdName

String forwarderCallerIdName
Forwarder callerIdName of farwarder


forwarderCallerIdNumber

String forwarderCallerIdNumber
Forwarder callerIdNumber of farwarder


conferenceRoomId

String conferenceRoomId
The conference room identifikation


conferenceAdmin

boolean conferenceAdmin
The current call is an conference admin


referenceOfConsultation

String referenceOfConsultation
The reference of the outher side of consultation


duration

long duration
The time between now and the connected timestamp/timestamp


consultationCall

boolean consultationCall
Is this call a consultationCall


jabberId

String jabberId
The jabber id

Class de.starface.integration.uci.java.v30.types.CallIdChanges extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

oldId

String oldId
The oldId of the call in form of a UUID as String


newId

String newId
The newId of the call in form of a UUID as String

Class de.starface.integration.uci.java.v30.types.CallInfo extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

state

CallInfoState state
The state of the call


duration

int duration
The duration the call is going on in seconds


number

String number
The number of the other call participant


description

String description
A description of the call (usually the CLIP), if known

Class de.starface.integration.uci.java.v30.types.CallList extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

startBefore

Date startBefore
The entries start before this point of time


startAfter

Date startAfter
The entries start after this point of time


directionRestriction

CallListEntryDirection directionRestriction
The entries are restricted to calls of the given CallListEntryDirection. If null is given no restriction is used.


resultRestriction

CallListEntryResult resultRestriction
The entries are restricted to calls of the given CallListEntryResult. If null is given no restriction is used.


groupRestriction

String groupRestriction
The entries are restricted to calls belonging to the group with the given id or to calls that do not belong to any group if GroupRestriction.NON_GROUP is given. If an empty String is given no restriction is used.


orderProperty

CallListEntryProperties orderProperty
The entries are ordered by the given property.


orderDirection

OrderDirection orderDirection
The entries are ordered in the given direction. This may be one of the values in OrderDirection


countOffset

int countOffset
The offset used for the retrieval of this list regarding the given time constraints and restrictions


countLimit

int countLimit
The limit used for the retrieval of this list regarding the given time constraints and restrictions


totalCount

int totalCount
The total count of available entries on the server regarding the given time constraints and restrictions


entries

List<E> entries
The call list entries in this list

Class de.starface.integration.uci.java.v30.types.CallListEntry extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the call list entry ATTENTION: This is not the same id as used in the call functions of UciCallRequests and UciCallEvents


calledNumber

String calledNumber
The number that was called, if known


callerNumber

String callerNumber
The number of the caller, if known


callDescription

String callDescription
A description of the call (usually the CLIP), if known


startTime

Date startTime
The start time of the call. Per default dates will be ordered newest first


duration

int duration
The duration of the call in seconds


direction

CallListEntryDirection direction
The direction of the call


result

CallListEntryResult result
The result of the call


voicemailId

String voicemailId
The id of a voicemail that was recorded for the call if existing (the empty string otherwise)


groupId

String groupId
The name of the group if this call was received by a group (the empty string otherwise)

Class de.starface.integration.uci.java.v30.types.CcbsAccount extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

ccbsAccountState

CcbsAccountState ccbsAccountState
The state of the call

Class de.starface.integration.uci.java.v30.types.CcbsCall extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the call in form of a UUID as String


ccbsCallState

CcbsCallState ccbsCallState
The state of the call


timestamp

Date timestamp
The point of time when the call reached the state


calledNumber

String calledNumber
The phone number that has been called


calledName

String calledName
The name of the person being called


callerNumber

String callerNumber
The number of the caller


callerName

String callerName
The name of the person calling


groupId

String groupId
The id of the group if this call was received by a group (the empty string otherwise)


peerNames

List<E> peerNames
Name of the device


channelNames

List<E> channelNames
The channel name


caller

Boolean caller
Is caller


duration

long duration
The time between now and the timestamp in milliseconds

Class de.starface.integration.uci.java.v30.types.CdrDataInfo extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

Long id

callStepId

Integer callStepId

callLegUUID

String callLegUUID

cdrAccountId

Integer cdrAccountId

callerAccountId

Integer callerAccountId

callerCallerId

String callerCallerId

calledAccountId

Integer calledAccountId

calledCallerId

String calledCallerId

serviceId

Integer serviceId

startTime

Long startTime

ringingTime

Long ringingTime

linkTime

Long linkTime

callResultTime

Long callResultTime

cdrCallResult

String cdrCallResult

callResultCausedBy

Integer callResultCausedBy

lineId

Integer lineId

lineName

String lineName

callbackNumber

String callbackNumber

answeredElsewhere

String answeredElsewhere

incoming

Boolean incoming

answered

Boolean answered

voicemailAvailable

Boolean voicemailAvailable

monitorAvailable

Boolean monitorAvailable

faxAvailable

Boolean faxAvailable

deleted

Boolean deleted

privateCall

Boolean privateCall

Class de.starface.integration.uci.java.v30.types.ConferenceCall extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the call in form of a UUID as String


number

String number
The phone number of the conference participant


name

String name
The name of the conference participant


listening

Boolean listening
Can the participant hear


muted

Boolean muted
Can the participant speak


talking

Boolean talking
Is the participant speaking


wantToSpeak

Integer wantToSpeak
Want the participant speak


admin

Boolean admin
Is the participant admin


state

CallState state
The state of the call


roomId

String roomId
The Room Identifikation Number


enteredTimestamp

Date enteredTimestamp
Entered Room


duration

long duration
The time between now and the enteredTimestamp in milliseconds


jabberId

String jabberId
The jabber id


avatarHash

String avatarHash
The avatar hash

Class de.starface.integration.uci.java.v30.types.ContactInfo extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

firstName

String firstName
The first name of the contact


familyName

String familyName
The family name of the contact


company

String company
The company of the contact


jobTitle

String jobTitle
The job title of the contact


internalPhone

String internalPhone
The internal phone number of the contact


phone

String phone
The office phone number of the contact


mobilePhone

String mobilePhone
The mobile phone number of the contact


homePhone

String homePhone
The private home phone number of the contact


phone2

String phone2
The second phone number of the contact


fax

String fax
The facsimile number of the contact


eMail

String eMail
The email address of the contact


jabberId

String jabberId
The jabber id of the contact


street

String street
The street and house number of the contact


postCode

String postCode
The post code of the contact


city

String city
The city of the contact


country

String country
The country of the contact

Class de.starface.integration.uci.java.v30.types.Fax extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the fax in form of a UUID as String


state

FaxState state
The state of the fax


timestamp

Date timestamp
The point of time when the event occurred


calledNumber

String calledNumber
The number that the fax is being send to


sentPages

int sentPages
The number of pages already sent


totalPages

int totalPages
The number of pages total if known (zero otherwise)

Class de.starface.integration.uci.java.v30.types.FaxList extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

receivedBefore

Date receivedBefore
The entries received before this point of time given


receivedAfter

Date receivedAfter
The entries received after this point of time given


folderRestriction

FaxListEntryFolder folderRestriction
The entries are restricted to those in the given folder with one of the values of FaxListEntryFolder


groupRestriction

String groupRestriction
The entries are restricted to faxes belonging to the group with the given id or to faxes that do not belong to any group if GroupRestriction.NON_GROUP is given. If an empty String is given no restriction is used.


orderProperty

FaxListEntryProperties orderProperty
The entries are ordered by the given property. This may be one of the properties in FaxListEntryProperties


orderDirection

OrderDirection orderDirection
The entries are ordered in the given direction. This may be one of the values in OrderDirection


countOffset

int countOffset
The offset used for the retrieval of this list regarding the given time constraints and restrictions


countLimit

int countLimit
The limit used for the retrieval of this list regarding the given time constraints and restrictions


totalCount

int totalCount
The total count of available entries on the server regarding the given time constraints and restrictions


entries

List<E> entries
The fax list entries in this list

Class de.starface.integration.uci.java.v30.types.FaxListEntry extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the fax list entry ATTENTION: This is not the same id as used in the fax functions of UciFaxRequests and UciFaxEvents


calledNumber

String calledNumber
The number that was called, if known


callerNumber

String callerNumber
The number of the sender, if known


callDescription

String callDescription
A description of the fax call (usually the CLIP), if known


folder

FaxListEntryFolder folder
The folder the fax belongs to holding one of the values defined in FaxListEntryFolder .


receptionTime

Date receptionTime
The time when the fax was received. Dates will be ordered newest first per default.


partial

boolean partial
A flag indicating that the fax was not transmitted completely


groupId

String groupId
The name of the group if this fax was received by a group (the empty string otherwise)

Class de.starface.integration.uci.java.v30.types.FmcPhone extends Object implements Serializable

serialVersionUID: 36387062683863045L

Serialized Fields

fmcId

int fmcId

telephoneId

int telephoneId

number

String number

delay

int delay

active

boolean active

confirm

boolean confirm

schedules

List<E> schedules

Class de.starface.integration.uci.java.v30.types.FmcScheduleEntry extends Object implements Serializable

serialVersionUID: -1372841590623376979L

Serialized Fields

monday

boolean monday

tuesday

boolean tuesday

wednesday

boolean wednesday

thursday

boolean thursday

friday

boolean friday

saturday

boolean saturday

sunday

boolean sunday

timeBegin

String timeBegin

timeEnd

String timeEnd

Class de.starface.integration.uci.java.v30.types.FunctionKey extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the function key


name

String name
The display name of the function key


state

FunctionKeyState state
The state of the function key with one of the constants of FunctionKeyState


type

FunctionKeyType type
The type of the function key with one of the constants of FunctionKeyType


chatId

String chatId
The Xmpp chat id of the corresponding user.


email

String email
The email address of the corresponding account.


phoneNumber

String phoneNumber
The phone number of the corresponding account.


phoneNumber2

String phoneNumber2
The second phone number of the corresponding account.


mobilePhoneNumber

String mobilePhoneNumber
The mobile phone number of the corresponding account.


homePhoneNumber

String homePhoneNumber
The home phone number of the corresponding account.


internalPhoneNumber

String internalPhoneNumber
The internal number of the corresponding account.


fax

String fax
The fax number of the corresponding account.


userState

UserState userState
The user state of the function key if the key is of type FunctionKeyType.BUSY_LAMP_FIELD


imageHash

String imageHash
The hash of the key's image if an image is assigned to the key the image itself can then be requested using UciFunctionKeyRequests.getImageForKey(String)


position

int position
The position of the key in the users function key settings

Class de.starface.integration.uci.java.v30.types.FunctionKeySearchResult extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

searchId

String searchId
The id of this searchResult. It's used to make explicit requests on server for this search.


resultList

Map<K,V> resultList
The map of function key ids and FunctionKey objects matching the search term.


searchTerm

String searchTerm
The id of this searchResult. Its used to make explicit requests on server for this search.

Class de.starface.integration.uci.java.v30.types.GroupSetting extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the group


name

String name
The display name of the group for the current user


loggedOn

boolean loggedOn
A flag indicating if the user is currently logged on to the group or not


logonId

String logonId
The Id that can be used to log on to the group using the telephone


phoneNumbers

List<E> phoneNumbers
The phone numbers allocated to the group

Class de.starface.integration.uci.java.v30.types.Image extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

data

byte[] data
The binary image data


mimeType

String mimeType
The mime type of the image data


hash

String hash
The SHA-1 hash of the image data

Class de.starface.integration.uci.java.v30.types.Mailbox extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the mailbox


name

String name
The display name of the mailbox for the current user

Class de.starface.integration.uci.java.v30.types.MessageWaitingIndicationInfo extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

messageWatingIndication

String messageWatingIndication
Message Wating Active


voiceMailBoxId

String voiceMailBoxId
Boxid


voiceMailBoxName

String voiceMailBoxName
Boxname


newMessagesCount

String newMessagesCount
Message Waiting Count

Class de.starface.integration.uci.java.v30.types.MonitorList extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

startBefore

Date startBefore
The entries start before this point of time


startAfter

Date startAfter
The entries start after this point of time


orderProperty

MonitorListEntryProperties orderProperty
The entries are ordered by the given property. This may be one of the properties in MonitorListEntryProperties


orderDirection

OrderDirection orderDirection
The entries are ordered in the given direction. This may be one of the values in OrderDirection


countOffset

int countOffset
The offset used for the retrieval of this list regarding the given time constraints and restrictions


countLimit

int countLimit
The limit used for the retrieval of this list regarding the given time constraints and restrictions


totalCount

int totalCount
The total count of available entries on the server regarding the given time constraints and restrictions


entries

List<E> entries
The call list entries in this list

Class de.starface.integration.uci.java.v30.types.MonitorListEntry extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the monitor list entry


cdrId

String cdrId
The id of the corresponding CDR entry


callercallerid

String callercallerid
CallerCallerID, if known


calledcallerid

String calledcallerid
CalledCallerID, if known


callbacknumber

String callbacknumber
Callbacknumber, if known


file

String file
The file of the monitor as String.


monitortimestart

Date monitortimestart
The start time of the monitor. Per default dates will be ordered newest first


monitortimeend

Date monitortimeend
The end time of the monitor as Date. Per default dates will be ordered newest first


duration

long duration
The duration of the monitor in milliseconds

Class de.starface.integration.uci.java.v30.types.PhoneNumber extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the phone number


number

String number
The number of the phone number


groupId

String groupId
The id of the group if this phone number belongs to a group (the empty string otherwise)

Class de.starface.integration.uci.java.v30.types.QueueAgentState extends UserState implements Serializable

serialVersionUID: 1L

Serialized Fields

accountId

int accountId
The accountId of the agent


queueAccountId

int queueAccountId
The accountId of the queue


loggedIn

boolean loggedIn
True if the agent is logged in at the queue referenced with queueAccountId.


name

String name
The name of the agent.

Class de.starface.integration.uci.java.v30.types.QueueSetting extends Object implements Serializable

serialVersionUID: -4590501213645332276L

Serialized Fields

id

int id
The ID of this queue for the database


accountId

int accountId
The Account ID of the group behind the queue


size

int size
The size of the queue


maxWaitingTime

int maxWaitingTime
The maximum waiting time until a waiting caller becomes disconnected


name

String name
The Name of the Queue

Class de.starface.integration.uci.java.v30.types.RedirectSetting extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

type

RedirectSettingType type
The type of the redirect setting with one of the values of RedirectSettingType. The type together with the RedirectSetting.calledNumber uniquely identify the redirect setting.


calledNumber

String calledNumber
The incoming number for which the redirect holds. The calledNumber together with the RedirectSetting.type uniquely identify the redirect setting.


calledNumberId

String calledNumberId

groupId

String groupId
The id of a group if the number belongs to a user group


enabled

boolean enabled
A flag indicating if the redirect is enabled/active


destinationType

RedirectSettingDestinationType destinationType
The type of the destination of the redirect setting with one of the values of RedirectSettingDestinationType


destination

String destination
The destination of the redirect. This may either be a phone number if the RedirectSetting.destinationType is RedirectSettingDestinationType.PHONENUMBER or the id of one of the mailboxes given in RedirectSetting.mailboxes if the RedirectSetting.destinationType is RedirectSettingDestinationType.VOICEMAIL


mailboxes

List<E> mailboxes
A List that hold the information about the mailboxes that are valid destinations for the current redirect setting. The List contains one entry for every valid mailbox.


timeout

int timeout
The timeout in seconds that will be used as a trigger for the redirect if the RedirectSetting.type is set to RedirectSettingType.TIMEOUT.


lastDestinationMailbox

String lastDestinationMailbox
The last known selected destination voicemailbox


lastDestinationNumber

String lastDestinationNumber
The last known selected destination phonenumber

Class de.starface.integration.uci.java.v30.types.SoftPhoneConfig extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

sipUserId

String sipUserId

sipPassword

String sipPassword

sipIP

String sipIP

sipPort

int sipPort

Class de.starface.integration.uci.java.v30.types.SoftPhoneRegistrationInfo extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

sipUserId

String sipUserId
The SIP userId

Class de.starface.integration.uci.java.v30.types.SoftPhoneSetting extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

softPhoneId

String softPhoneId

codecs

String codecs

natType

SoftPhoneNatType natType

Class de.starface.integration.uci.java.v30.types.UciQueueCall extends Object implements Serializable

serialVersionUID: -9109094888101805111L

Serialized Fields

callId

String callId
The Id of the Call which is unique but not unchangeable.


callerName

String callerName
The name of the caller if known.


callerNumber

String callerNumber
The number of the caller if known.


queueAccountId

Integer queueAccountId
The accountid of the queue


priority

Integer priority
The priority of the caller


state

QueueCallState state
The state of the call (waiting, ringing, connected, exited)


incommingTime

Date incommingTime
An UTC timestamp that defines when the call entered the queue


connectedTime

Date connectedTime
An UTC timestamp that defines when the call was answered the first time by an agent


agents

List<E> agents
The agents that are currently associated (ringing, connected) with this call.


callerLegUuid

UUID callerLegUuid
The unique id of the caller leg.


position

int position
The position of the caller.

Class de.starface.integration.uci.java.v30.types.UserState extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

doNotDisturbSetting

boolean doNotDisturbSetting
A flag indicating whether the user has DND set to active


redirectAlwaysActive

boolean redirectAlwaysActive
A flag indicating whether the user has any redirect always settings enabled


chatPresence

ChatPresence chatPresence
The current chat presence of the user


chatPresenceMessage

String chatPresenceMessage
The current chat presence message of the user


avatarHash

String avatarHash
The SHA-1 hash of the users avatar image if one is set. The image itself can be queried with UciUserStateRequests.getAvatarImage().


telephonyState

TelephonyState telephonyState
The current telephony state of the user

Class de.starface.integration.uci.java.v30.types.VoicemailList extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

startBefore

Date startBefore
The entries start before this point of time


startAfter

Date startAfter
The entries start after this point of time


mailboxRestriction

String mailboxRestriction
The entries are restricted to voicemails in the mailbox with the given id. If an empty String is given no restriction is used.


folderRestriction

VoicemailListEntryFolder folderRestriction
The entries are restricted to voicemails in the given folder defined in VoicemailListEntryFolder. If an empty String is given no restriction is used.


orderProperty

VoicemailListEntryProperties orderProperty
The entries are ordered by the given property. This may be one of the properties in VoicemailListEntryProperties


orderDirection

OrderDirection orderDirection
The entries are ordered in the given direction. This may be one of the values in OrderDirection


countOffset

int countOffset
The offset used for the retrieval of this list regarding the given time constraints and restrictions


countLimit

int countLimit
The limit used for the retrieval of this list regarding the given time constraints and restrictions


totalCount

int totalCount
The total count of available entries on the server regarding the given time constraints and restrictions


entries

List<E> entries
The call list entries in this list

Class de.starface.integration.uci.java.v30.types.VoicemailListEntry extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id
The id of the voicemail list entry


cdrId

String cdrId
The id of the corresponding CDR entry


mailboxId

String mailboxId
The id of the mailbox of the voicemail


mailboxName

String mailboxName
The display name of the mailbox of the voicemail


folder

VoicemailListEntryFolder folder
The folder the voicemail belongs to holding one of the values defined in VoicemailListEntryFolder.


calledNumber

String calledNumber
The number that was called, if known


callerNumber

String callerNumber
The number of the caller, if known


callDescription

String callDescription
A description of the call (usually the CLIP), if known


startTime

Date startTime
The start time of the call. Per default dates will be ordered newest first


duration

int duration
The duration of the call in seconds


groupId

String groupId
The name of the group if this voicemail was received by a group (the empty string otherwise)


Package de.starface.integration.uci.java.v30.ucp.exceptions

Class de.starface.integration.uci.java.v30.ucp.exceptions.UcpCommunicationException extends UciException implements Serializable

serialVersionUID: 1L

Class de.starface.integration.uci.java.v30.ucp.exceptions.UcpNotConnectedException extends UciException implements Serializable

serialVersionUID: 1L



Copyright © 2012 STARFACE GmbH. All rights reserved.