|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use UciException | |
|---|---|
| de.starface.integration.uci.java.v30.exceptions | This package contains exceptions thrown by UCI |
| de.starface.integration.uci.java.v30.messages.requests | This package contains the requests that the UCI client implementation can send to STARFACE. |
| de.starface.integration.uci.java.v30.ucp.exceptions | This package contains exceptions thrown by UCI when there is a communication problem on the UCP layer |
| de.starface.integration.uci.java.v30.ucp.messages.requests | This package contains the UCP server interfaces that define the UCI requests provided by the server. |
| Uses of UciException in de.starface.integration.uci.java.v30.exceptions |
|---|
| Subclasses of UciException in de.starface.integration.uci.java.v30.exceptions | |
|---|---|
class |
UciIllegalAccessException
This exception indicates that the data to be accessed or function to be used is not allowed to be accessed by the issuing a UCI request. |
class |
UciIllegalArgumentException
This exception indicates that that an argument given in a UCI request was invalid. |
| Uses of UciException in de.starface.integration.uci.java.v30.messages.requests |
|---|
| Methods in de.starface.integration.uci.java.v30.messages.requests that throw UciException | |
|---|---|
void |
UciConferenceCallRequests.allCanSpeakInRoom(String roomId)
This request tells the UCI server to enable speaking on all participants. |
void |
UciConferenceCallRequests.allHearInRoom(String roomId)
This request tells the UCI server to set all conference participants to hear. |
void |
UciVoicemailListRequests.callMailboxWithNumber(String mailboxId,
String originatingNumber)
Initiate a phone call to the given phone number that when answered is connected to one of the current users voicemail boxes |
void |
UciVoicemailListRequests.callMailboxWithPhone(String mailboxId,
String phoneId)
Initiate a phone call to the given voicemail box using the given phone |
void |
UciConferenceCallRequests.callNumberToConference(String roomId,
String number)
This request tells the UCI server to call that the phone number into the conference. |
void |
UciCallRequests.callVoicemailBox(String phoneId)
This request tells the UCI server to call the users voicemailbox. |
void |
UciVoicemailListRequests.callVoicemailWithNumber(String voicemailId,
String originatingNumber)
Initiate a phone call to the given phone number that when answered plays one of the current users voicemails. |
void |
UciVoicemailListRequests.callVoicemailWithPhone(String voicemailId,
String phoneId)
Initiate a call with the given phone that plays one of the current users voicemails. |
boolean |
UciCcbsCallRequests.ccbs(String callId)
This request tells the UCI server to start or quit ccbs to the given call identified by the given UUID. |
void |
UciCallRequests.conference(List<String> callIds,
String phoneId)
This request tells the UCI server to create a conference with calls identified by the given UUIDs and the given Phone. |
void |
UciCallListRequests.deleteCallListEntries(List<String> callIds)
Remove multiple call list entries from the list |
void |
UciCallListRequests.deleteCallListEntry(String callId)
Remove a call list entry from the list |
void |
UciFaxListRequests.deleteFaxListEntries(List<String> faxIds)
Remove multiple fax list entries from the list |
void |
UciFaxListRequests.deleteFaxListEntry(String faxId)
Remove a fax list entry from the list |
void |
UciFmcPhoneRequests.deleteFmcPhone(FmcPhone phone)
Deleting an FMC phone. |
void |
UciMonitorListRequests.deleteMonitorListEntries(List<String> monitorIds)
Remove multiple monitor list entries from the list |
void |
UciMonitorListRequests.deleteMonitorListEntry(String monitorId)
Remove a monitor list entry from the list |
void |
UciVoicemailListRequests.deleteVoicemailListEntries(List<String> voicemailIds)
Remove multiple voicemail list entries from the list |
void |
UciVoicemailListRequests.deleteVoicemailListEntry(String voicemailId)
Remove a voicemail list entry from the list |
void |
UciCallRequests.forward(String callId,
String extension)
This request tells the UCI server to forward a call identified by the given UUID to the given Extension. |
List<CcbsCall> |
UciCcbsCallRequests.getAllCcbsCalls()
This request tells the UCI server to get all current ccbs calls. |
List<ConferenceCall> |
UciConferenceCallRequests.getAllConferenceCallsInRoom(String roomId)
This request tells the UCI server to get all conference call ids. |
List<String> |
UciConferenceCallRequests.getAllConferences()
This request tells the UCI server to get all conference ids. |
FunctionKeySearchResult |
UciFunctionKeyRequests.getAllFunctionKeys()
This request allows the UCI client to retrieve all function keys. |
List<PhoneNumber> |
UciPhoneRequests.getAvailableDisplayNumbers()
This request allows the UCI client to obtain a list of phone number that are available to be set as display number for the user. |
Image |
UciUserStateRequests.getAvatarImage()
This request can be used by the UCI client to retrieve the user's avatar image. |
List<String> |
UciCallRequests.getCallIds()
The UCI client may call getCallIds to have the server send a response with a list of call ids of the call being held by the user. |
List<CallInfo> |
UciFunctionKeyRequests.getCallInfoForKey(String functionKeyId)
This request allows the UCI client to query information about the calls currently being held or received by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD
shows the status of. |
CallList |
UciCallListRequests.getCallList(Date startBefore,
Date startAfter,
CallListEntryDirection directionRestriction,
CallListEntryResult resultRestriction,
String groupRestriction,
CallListEntryProperties orderProperty,
OrderDirection orderDirection,
int countOffset,
int countLimit)
Retrieve a list of phone calls of the current user. |
Call |
UciCallRequests.getCallState(String callId)
The getCallState request provides a number of properties about an identified call. |
boolean |
UciPhoneRequests.getCallWaitingIndication()
This request allows the UCI client to check if the call waiting indication is used for simultaneous phone calls. |
CcbsAccountState |
UciCcbsCallRequests.getCcbsAccountState()
This request tells the UCI server to get the CcbsAccountState. |
ContactInfo |
UciFunctionKeyRequests.getContactInfoForKey(String functionKeyId)
This request allows the UCI client to query the contact information of the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of. |
void |
UciCallRequests.getCurrentMessageWaitingState()
This request tells the UCI server to send current messageWaitingEvents for all mailboxes of the account. |
String |
UciPhoneRequests.getDisplayNumberId()
This request allows the UCI client to retrieve the phone number that is signaled to the other party during a call on an outgoing line. |
File |
UciFaxListRequests.getFaxFile(String faxId)
Downloads and returns the fax file for the given fax id. |
String |
UciFaxListRequests.getFaxFileUrl(String faxId)
Creates and returns a temporary URL that can be used to download the fax file for the next 15 minutes. |
List<String> |
UciFaxRequests.getFaxIds()
The UCI client may call getFaxIds to have the server send a response with a list of fax ids of the faxes being sent by the user. |
FaxList |
UciFaxListRequests.getFaxList(Date receivedBefore,
Date receivedAfter,
FaxListEntryFolder folderRestriction,
String groupRestriction,
FaxListEntryProperties orderProperty,
OrderDirection orderDirection,
int countOffset,
int countLimit)
Retrieve a list of received and sent faxes of the current user. |
Fax |
UciFaxRequests.getFaxState(String faxId)
The getFaxState message is used to query STARFACE for the state of an identified fax request. |
List<FmcPhone> |
UciFmcPhoneRequests.getFmcPhones()
Getting all FMC phones of this user. |
List<FunctionKey> |
UciFunctionKeyRequests.getFunctionKeys()
This request allows the UCI client to retrieve the function keys of the current user. |
List<GroupSetting> |
UciGroupRequests.getGroupSettings()
This request allows the UCI client to query the group settings of the groups the current user is a member of. |
Image |
UciFunctionKeyRequests.getImageForKey(String functionKeyId)
This request allows the UCI client to query the image of the key. |
Image |
UciCallRequests.getImageOfHash(String imageHash)
This request tells the UCI server to return the avatar image of an image hash. |
List<Mailbox> |
UciVoicemailListRequests.getMailboxes()
Retrieve a list with all mailboxes of the current user |
File |
UciMonitorListRequests.getMonitorFile(String monitorId)
Downloads and returns the monitor for the given monitor id |
String |
UciMonitorListRequests.getMonitorFileUrl(String monitorId)
Creates and returns a temporary URL that can be used to download the monitor file for the next 15 minutes. |
MonitorList |
UciMonitorListRequests.getMonitorList(Date startAfter,
Date startBefore,
MonitorListEntryProperties orderProperty,
OrderDirection orderDirection,
int countOffset,
int countLimit)
Retrieve a list of monitors of the current user. |
List<String> |
UciSystemRequests.getPermissions(String parent)
|
List<String> |
UciPhoneRequests.getPhoneIds()
The UCI client may call getPhoneIds to have the server send a response with a list of telephone ids of the phones assigned to the user. |
String |
UciPhoneRequests.getPrimaryPhoneId()
This request allows the UCI client to retrieve the id of the primary phone of the user. |
List<QueueAgentState> |
UciQueueRequests.getQueueAgents(int queueAccountId)
Returns a List of QueueAgents with their current states as defined in QueueAgentState
of the given queue, if the user is an agent of it. |
List<UciQueueCall> |
UciQueueRequests.getQueueCalls()
Returns the waiting, ringin, and ongoing calls of the given queue as defined in UciQueueCall |
QueueSetting |
UciQueueRequests.getQueueSetting(int queueAccountId)
Returns the settings of a queue as defined in QueueSetting |
List<QueueSetting> |
UciQueueRequests.getQueueSettings()
This request allows the UCI client to query the settings of all queues the user is an agent of. |
List<RedirectSetting> |
UciRedirectRequests.getRedirectSettings(RedirectSettingType typeRestriction,
String groupRestriction,
RedirectSettingProperties orderProperty,
OrderDirection orderDirection)
Retrieve the redirect settings for the current user. |
List<RedirectSetting> |
UciFunctionKeyRequests.getRedirectSettingsForKey(String functionKeyId)
This request allows the UCI client to query which redirect always settings have been activated by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows
the status of. |
String |
UciUserStateRequests.getUserName()
This request can be used by the UCI client to get the name of the current user. |
UserState |
UciUserStateRequests.getUserState()
This request can be used by the UCI client to obtain the current user's state with information about his DND, telefony, chat and avatar state. |
File |
UciVoicemailListRequests.getVoicemailFile(String voicemailId)
Downloads and returns the voicemail for the given voicemail id |
String |
UciVoicemailListRequests.getVoicemailFileUrl(String voicemailId)
Creates and returns a temporary URL that can be used to download the voicemail file for the next 15 minutes. |
VoicemailList |
UciVoicemailListRequests.getVoicemailList(Date startBefore,
Date startAfter,
String mailboxRestriction,
VoicemailListEntryFolder folderRestriction,
VoicemailListEntryProperties orderProperty,
OrderDirection orderDirection,
int countOffset,
int countLimit)
Retrieve a list of voicemails of the current user. |
void |
UciCallRequests.grabVoicemailBoxCallerWithPhone(String callId,
String phoneId)
This request tells the UCI server to grab the call from the linked voicemailbox. |
void |
UciConferenceCallRequests.hangupCall(String callId)
This request tells the UCI server to hang up the call identified by the given UUID. |
void |
UciCallRequests.hangupCall(String callId)
This request tells the UCI server to hang up the call identified by the given UUID. |
void |
UciCallRequests.hold(String callId)
This request tells the UCI server to hold the call identified by the given UUID. |
boolean |
UciPhoneRequests.isSipPhoneInUse(SoftPhoneSetting softPhoneSetting)
This request allows the UCI client to check wether a SipPhone with the softPhoneId of the given SoftPhoneSetting is currently registered for the user. |
void |
UciConferenceCallRequests.joinToConference(String roomId,
String phone)
This request tells the UCI server to join a conference. |
void |
UciConferenceCallRequests.leaveConference(String roomId)
This request tells the UCI server to leave the conference. |
void |
UciConferenceCallRequests.listenToConference(String uuidConferenceCall,
boolean listen)
This request tells the UCI server that the confernce call can hear or not hear the outher participants. |
void |
UciCallRequests.monitor(String callId)
This request tells the UCI server to monitor the given call identified by the given UUID. |
void |
UciFaxListRequests.moveFaxListEntries(List<String> faxIds,
FaxListEntryFolder destinationFolder)
Move multiple fax list entries to another folder |
void |
UciFaxListRequests.moveFaxListEntry(String faxId,
FaxListEntryFolder destinationFolder)
Move a fax list entry to another folder |
void |
UciVoicemailListRequests.moveVoicemailListEntries(List<String> voicemailIds,
VoicemailListEntryFolder destinationFolder)
Move mutliple voicemail list entries to another folder |
void |
UciVoicemailListRequests.moveVoicemailListEntry(String voicemailId,
VoicemailListEntryFolder destinationFolder)
Move a voicemail list entry to another folder |
void |
UciConferenceCallRequests.muteToConference(String uuidConferenceCall,
boolean mute)
This request tells the UCI server to mute or unmute the call. |
void |
UciConferenceCallRequests.onlyOneCanSpeakInRoom(String uuidConferenceCall)
This request tells the UCI server to enable speaking for one participant. |
void |
UciCallRequests.parkAndOrbit(String callId,
String parkAndOrbitNumber,
String phone)
This request tells the UCI server to park and give an orbit number to the given call identified by the given UUID. |
String |
UciCallListRequests.placeCallbackCallWithPhone(String callListEntryId,
String phoneId,
String callId)
This request is called to initiate a phone call for the user the same way as when using the STARFACE call list. |
String |
UciCallRequests.placeCallWithNumber(String destinationNumber,
String originatingNumber,
String callId)
This request is called to initiate a phone call for the user. |
String |
UciCallRequests.placeCallWithPhone(String destinationNumber,
String phoneId,
String callId)
This request is called to initiate a phone call for the user the same way as when using the STARFACE call manager. |
String |
UciCallRequests.placeConsultationCallWithPhone(String destinationNumber,
String phoneId,
String callId,
String callIdReference)
This request is called to initiate a phone consultation call for the user the same way as when using the STARFACE call manager. |
void |
UciCallRequests.playDtmf(String callId,
String dtmfDigits)
This request tells the UCI server to send DTMF sounds on that call. |
void |
UciFunctionKeyRequests.pressKey(String functionKeyId,
Object... parameters)
This request allows the UCI client to virtually press a function key of the current user. |
void |
UciConferenceCallRequests.quitConference(String roomId)
This request tells the UCI server to quit the conference. |
SoftPhoneConfig |
UciPhoneRequests.registerSipPhone(SoftPhoneSetting softPhoneSetting)
This request allows the UCI client to get SIP credentials for a SoftPhone. |
void |
UciCcbsCallRequests.removeAvailableCcbs(String callId)
This request tells the UCI server to remove an available ccbs call by the given UUID. |
void |
UciCallRequests.resume(String callId,
String phoneId)
This request tells the UCI server to resume the call identified by the given UUID and the given Phone. |
void |
UciFmcPhoneRequests.saveFmcPhone(FmcPhone phone)
Saving a new FMC phone or updating one. |
FunctionKeySearchResult |
UciFunctionKeyRequests.searchFunctionKeys(String searchTerm,
String searchId)
This request allows the UCI client to retrieve the function keys containing the given term in name or phone number. |
FunctionKeySearchResult |
UciFunctionKeyRequests.searchFunctionKeysByEmail(String emailAddress,
String searchId)
This request allows the UCI client to retrieve the function keys by email address. |
FunctionKeySearchResult |
UciFunctionKeyRequests.searchFunctionKeysByJabberId(String jabberId,
String searchId)
This request allows the UCI client to retrieve the function keys by jabber id. |
String |
UciFaxRequests.sendFax(String faxNumber,
String faxId,
File textFile,
File pdfFile)
This procedure is called to initiate a fax sending process. |
void |
UciFaxRequests.sendFaxAsync(String faxNumber,
String faxId,
File textFile,
File pdfFile)
This procedure is called to initiate a fax sending process. |
void |
UciUserStateRequests.setAvatarImage(Image image)
This request can be used by the UCI client to set a new avatar image for the user. |
void |
UciUserStateRequests.setAvatarImageFile(File file)
This request can be used by the UCI client to set a new avatar image for the user. |
void |
UciPhoneRequests.setCallWaitingIndication(boolean callWaitingIndication)
This request allows the UCI client to configure the usage of call waiting indication for simultaneous phone calls. |
void |
UciUserStateRequests.setChatPresenceMessage(String message)
This request can be used by the UCI client to set the chat presence message of the user. |
void |
UciPhoneRequests.setDisplayNumberId(String phoneNumberId)
This request allows the UCI client to set the phone number that is signaled to the other party during a call on an outgoing line. |
void |
UciUserStateRequests.setDoNotDisturbSetting(boolean active)
This request can be used by the UCI client to set the user do not disturb setting. |
void |
UciGroupRequests.setGroupSetting(GroupSetting groupSetting)
This request saves the given group setting. |
void |
UciGroupRequests.setGroupSettings(List<GroupSetting> groupSettings)
This request saves the given group settings. |
void |
UciPhoneRequests.setPrimaryPhoneId(String phoneId)
This request allows the UCI client to set the primary phone of the user. |
void |
UciRedirectRequests.setRedirectSetting(RedirectSetting redirectSetting)
Save the given redirect setting. |
void |
UciRedirectRequests.setRedirectSettings(List<RedirectSetting> redirectSettings)
Save the given redirect settings. |
void |
UciConferenceCallRequests.startManagedConferenceById(String conferenceId,
String phoneId)
This request tells the UCI server to start the conference with the given id. |
void |
UciCallRequests.switchPhone(String callId)
This request tells the UCI server to swith the phone of the given call identified by the given UUID. |
void |
UciFunctionKeyRequests.terminateSearchRequest(String searchId)
To unsubscribe a search Request. |
void |
UciCallRequests.transfer(String callId,
String callIdParked)
This request tells the UCI server to transfer a call identified by the given UUID to the given parked UUID. |
void |
UciCallRequests.transferConsultationCall(String callId)
This request is called to transfer a consultation call for the user the same way as when using the STARFACE call manager. |
void |
UciConferenceCallRequests.transferToConference(String roomId,
String uuidToTransfer)
This request tells the UCI server to transfer a call to a conference. |
void |
UciCallRequests.transferToConferenceConsultationCall(String callId)
This request is called to transfer a consultation call to conference for the user the same way as when using the STARFACE call manager. |
void |
UciCallRequests.transferToVoicemailBox(String callId,
String mailboxId)
This request tells the UCI server the call to the voicemailbox. |
void |
UciConferenceCallRequests.wantToTalkToConference(String uuidConferenceCall)
This request tells the UCI server that the confernce call wants to talk. |
| Uses of UciException in de.starface.integration.uci.java.v30.ucp.exceptions |
|---|
| Subclasses of UciException in de.starface.integration.uci.java.v30.ucp.exceptions | |
|---|---|
class |
UcpCommunicationException
This message is thrown during an UCP procedure call if a communication error occurred. |
class |
UcpNotConnectedException
This message is thrown during an UCP procedure call if the call is only permitted for an active connection and no such connection has been established. |
| Uses of UciException in de.starface.integration.uci.java.v30.ucp.messages.requests |
|---|
| Methods in de.starface.integration.uci.java.v30.ucp.messages.requests that throw UciException | |
|---|---|
void |
UcpConferenceCallRequests.allCanSpeakInRoom(String roomId)
This request tells the UCI server to enable speaking on all participants. |
void |
UcpConferenceCallRequests.allHearInRoom(String roomId)
This request tells the UCI server to set all conference participants to hear. |
void |
UcpVoicemailListRequests.callMailboxWithNumber(String mailboxId,
String originatingNumber)
With this request the UCI client can initiate a phone call to the given phone number that when answered is connected to one of the current users voicemail box |
void |
UcpVoicemailListRequests.callMailboxWithPhone(String mailboxId,
String phoneId)
With this request the UCI client can initiate a phone call to the given voicemail box using the given phone |
void |
UcpConferenceCallRequests.callNumberToConference(String roomId,
String number)
This request tells the UCI server to call that the phone number into the conference. |
void |
UcpCallRequests.callVoicemailBox(String phoneId)
This request tells the UCI server to call the users voicemailbox. |
void |
UcpVoicemailListRequests.callVoicemailWithNumber(String voicemailId,
String originatingNumber)
With this request the UCI client can initiate a phone call to the given phone number that when answered plays one of the current users voicemails. |
void |
UcpVoicemailListRequests.callVoicemailWithPhone(String voicemailId,
String phoneId)
With this request the UCI client can initiate a call with the given phone that plays one of the current users voicemails. |
boolean |
UcpCcbsCallRequests.ccbs(String callId)
This request tells the UCI server to start or quit ccbs to the given call identified by the given UUID. |
void |
UcpCallRequests.conference(List<String> callIds,
String phoneId)
This request tells the UCI server to create a conference with calls identified by the given UUIDs and the given Phone. |
void |
UcpFmcPhoneRequests.deleateFmcPhone(FmcPhone phone)
Deleting an FMC phone. |
void |
UcpCallListRequests.deleteCallListEntries(List<String> callIds)
Remove multiple call list entries from the list |
void |
UcpCallListRequests.deleteCallListEntry(String callId)
Remove a call list entry from the list |
void |
UcpFaxListRequests.deleteFaxListEntries(List<String> faxIds)
Remove multiple fax list entries from the list |
void |
UcpFaxListRequests.deleteFaxListEntry(String faxId)
Remove a fax list entry from the list |
void |
UcpMonitorListRequests.deleteMonitorListEntries(List<String> monitorIds)
This request allows the UCI client to remove multiple monitor list entries from the list |
void |
UcpMonitorListRequests.deleteMonitorListEntry(String monitorId)
This request allows the UCI client to remove a monitor list entry from the list |
void |
UcpVoicemailListRequests.deleteVoicemailListEntries(List<String> voicemailIds)
This request allows the UCI client to remove multiple voicemail list entries from the list |
void |
UcpVoicemailListRequests.deleteVoicemailListEntry(String voicemailId)
This request allows the UCI client to remove a voicemail list entry from the list |
void |
UcpCallRequests.forward(String callId,
String extension)
This request tells the UCI server to forward a call identified by the given UUID to the given Extension. |
List<CcbsCall> |
UcpCcbsCallRequests.getAllCcbsCalls()
This request tells the UCI server to get all current ccbs calls. |
List<ConferenceCall> |
UcpConferenceCallRequests.getAllConferenceCallsInRoom(String roomId)
This request tells the UCI server to get all conference call ids. |
List<String> |
UcpConferenceCallRequests.getAllConferences()
This request tells the UCI server to get all conference ids. |
Map<String,Object> |
UcpFunctionKeyRequests.getALLFunctionKeys()
This request allows the UCI client to retrieve all function keys. |
List<Map<String,Object>> |
UcpPhoneRequests.getAvailableDisplayNumbers()
This request allows the UCI client to obtain a list of phone number that are available to be set as display number for the user. |
Map<String,Object> |
UcpUserStateRequests.getAvatarImage()
This request can be used by the UCI client to retrieve the user's avatar image. |
List<String> |
UcpCallRequests.getCallIds()
The UCI client may call getCallIds to have the server send a response with a list of call ids of the call being held by the user. |
List<Map<String,Object>> |
UcpFunctionKeyRequests.getCallInfoForKey(String functionKeyId)
This request allows the UCI client to query information about the calls currently being held or received by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD
shows the status of. |
Map<String,Object> |
UcpCallListRequests.getCallList(Date startBefore,
Date startAfter,
String directionRestriction,
String resultRestriction,
String groupRestriction,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
Retrieve a list of phone calls of the current user. |
List<Map<String,Object>> |
UCPQueueRequests.getCallsForQueue(int queueAccountId)
Returns a List of ongoing queue calls as defined in UciQueueCallPropertiesUse this for initialization only. |
Map<String,Object> |
UcpCallRequests.getCallState(String callId)
The getCallState request provides a number of properties about an identified call. |
boolean |
UcpPhoneRequests.getCallWaitingIndication()
This request allows the UCI client to check if the call waiting indication is used for simultaneous phone calls. |
CcbsAccountState |
UcpCcbsCallRequests.getCcbsAccountState()
This request tells the UCI server to get the CcbsAccountState. |
Map<String,Object> |
UcpFunctionKeyRequests.getContactInfoForKey(String functionKeyId)
This request allows the UCI client to query the contact information of the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of. |
void |
UcpCallRequests.getCurrentMessageWaitingState()
This request tells the UCI server to send current messageWaitingEvents for all mailboxes of the account. |
String |
UcpPhoneRequests.getDisplayNumberId()
This request allows the UCI client to retrieve the phone number that is signaled to the other party during a call on an outgoing line. |
String |
UcpFaxListRequests.getFaxFile(String faxId)
Prepares the download of the fax file for the given fax id. |
String |
UcpFaxListRequests.getFaxFileUrl(String faxId)
Creates and returns a temporary URL that can be used to download the fax file for the next 15 minutes. |
List<String> |
UcpFaxRequests.getFaxIds()
The UCI client may call getFaxIds to have the server send a response with a list of fax ids of the faxes currently being sent by the user. |
Map<String,Object> |
UcpFaxListRequests.getFaxList(Date receivedBefore,
Date receivedAfter,
String folderRestriction,
String groupRestriction,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
Retrieve a list of received and sent faxes of the current user. |
Map<String,Object> |
UcpFaxRequests.getFaxState(String faxId)
The getFaxState request is used to query the UCI server for the state of an identified fax request. |
Map<String,Object> |
UcpFmcPhoneRequests.getFmcPhones()
Getting all FMC phones of this user. |
List<Map<String,Object>> |
UcpFunctionKeyRequests.getFunctionKeys()
This request allows the UCI client to retrieve the function keys of the current user. |
List<Map<String,Object>> |
UcpGroupRequests.getGroupSettings()
This request allows the UCI client to query the group settings of the groups the current user is a member of. |
Map<String,Object> |
UcpFunctionKeyRequests.getImageForKey(String functionKeyId)
This request allows the UCI client to query the image of the key. |
Image |
UcpCallRequests.getImageOfHash(String imageHash)
This request tells the UCI server to return the avatar image of an image hash. |
List<Map<String,String>> |
UcpVoicemailListRequests.getMailboxes()
This request allows the UCI client to retrieve a list with all mailboxes of the current user |
String |
UcpMonitorListRequests.getMonitorFile(String monitorId)
Prepares the download of the monitor for the given monitor id. |
String |
UcpMonitorListRequests.getMonitorFileUrl(String monitorId)
This request creates and returns a temporary URL that can be used to download the monitor file for the next 15 minutes. |
Map<String,Object> |
UcpMonitorListRequests.getMonitorList(Date startAfter,
Date startBefore,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
With this request the UCI client can retrieve a list of monitors of the current user. |
List<String> |
UcpSystemRequests.getPermissions(String parent)
|
List<String> |
UcpPhoneRequests.getPhoneIds()
The UCI client may call getPhoneIds to have the server send a response with a list of telephone ids of the phones assigned to the user. |
String |
UcpPhoneRequests.getPrimaryPhoneId()
This request allows the UCI client to retrieve the id of the primary phone of the user. |
List<String> |
UcpServiceRequests.getProvidedEvents()
This request can be used to query the server for the service names of all supported events. |
List<String> |
UcpServiceRequests.getProvidedRequests()
This request can be used to query the server for the service names of all supported requests. |
List<Map<String,Object>> |
UCPQueueRequests.getQueueAgents(int queueAccountId)
Returns a List of QueueAgents as defined in QueueAgentStateProperties for the given
queue |
Map<String,Object> |
UCPQueueRequests.getQueueSetting(int queueAccountId)
Returns the Settings of a queue as defined in QueueSettingProperties |
List<Map<String,Object>> |
UCPQueueRequests.getQueueSettings()
This request allows the UCI client to query the queues. |
List<Map<String,Object>> |
UcpRedirectRequests.getRedirectSettings(String typeRestriction,
String groupRestriction,
String orderProperty,
String orderDirection)
This request allows the UCI client to retrieve the redirect settings for the current user. |
List<Map<String,Object>> |
UcpFunctionKeyRequests.getRedirectSettingsForKey(String functionKeyId)
This request allows the UCI client to query which redirect always settings have been activated by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows
the status of. |
String |
UcpUserStateRequests.getUserName()
This request can be used by the UCI client to get the name of the current user. |
Map<String,Object> |
UcpUserStateRequests.getUserState()
This request can be used by the UCI client to obtain the current user's state with information about his DND, telefony, chat and avatar state. |
String |
UcpVoicemailListRequests.getVoicemailFile(String voicemailId)
Prepares the download of the voicemail for the given voicemail id. |
String |
UcpVoicemailListRequests.getVoicemailFileUrl(String voicemailId)
This request creates and returns a temporary URL that can be used to download the voicemail file for the next 15 minutes. |
Map<String,Object> |
UcpVoicemailListRequests.getVoicemailList(Date startBefore,
Date startAfter,
String mailboxRestriction,
String folderRestriction,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
With this request the UCI client can retrieve a list of voicemails of the current user. |
void |
UcpCallRequests.grabVoicemailBoxCallerWithPhone(String callId,
String phoneId)
This request tells the UCI server to grab the call from the linked voicemailbox. |
void |
UcpConferenceCallRequests.hangupCall(String callId)
This request tells the UCI server to hang up the call identified by the given UUID. |
boolean |
UcpCallRequests.hangupCall(String callId)
This request tells the UCI server to hang up the call identified by the given UUID. |
void |
UcpCallRequests.hold(String callId)
This request tells the UCI server to hold the call identified by the given UUID. |
void |
UcpConferenceCallRequests.joinToConference(String roomId,
String phone)
This request tells the UCI server to join a conference. |
void |
UcpConferenceCallRequests.leaveConference(String roomId)
This request tells the UCI server to leave the conference. |
void |
UcpConferenceCallRequests.listenToConference(String uuidConferenceCall,
boolean listen)
This request tells the UCI server that the confernce call can hear or not hear the outher participants. |
void |
UcpCallRequests.monitor(String callId)
This request tells the UCI server to monitor the given call identified by the given UUID. |
void |
UcpFaxListRequests.moveFaxListEntries(List<String> faxIds,
String destinationFolder)
Move multiple fax list entries to another folder |
void |
UcpFaxListRequests.moveFaxListEntry(String faxId,
String destinationFolder)
Move a fax list entry to another folder |
void |
UcpVoicemailListRequests.moveVoicemailListEntries(List<String> voicemailIds,
String destinationFolder)
This request moves multiple voicemail list entries to another folder |
void |
UcpVoicemailListRequests.moveVoicemailListEntry(String voicemailId,
String destinationFolder)
This request moves a voicemail list entry to another folder |
void |
UcpConferenceCallRequests.muteToConference(String uuidConferenceCall,
boolean mute)
This request tells the UCI server to mute or unmute the call. |
void |
UcpConferenceCallRequests.onlyOneCanSpeakInRoom(String uuidConferenceCall)
This request tells the UCI server to enable speaking for one participant. |
void |
UcpCallRequests.parkAndOrbit(String callId,
String parkAndOrbitNumber,
String phone)
This request tells the UCI server to park and give an orbit number to the given call identified by the given UUID. |
String |
UcpCallListRequests.placeCallbackCallWithPhone(String callListEntryId,
String phoneId,
String callId)
This request is called to initiate a phone call for the user the same way as when using the STARFACE call list. |
String |
UcpCallRequests.placeCallWithNumber(String destinationNumber,
String originatingNumber,
String callId)
Deprecated. WARNING: Initiating a call this way results in a phone call that does not provide all of the UCI 3.0 Call Events denoted by the UCI 3.0 documentation. Some events may be missing or out of order. |
String |
UcpCallRequests.placeCallWithPhone(String destinationNumber,
String phoneId,
String callId)
This request is called to initiate a phone call for the user the same way as when using the STARFACE call manager. |
String |
UcpCallRequests.placeConsultationCallWithPhone(String destinationNumber,
String phoneId,
String callId,
String callIdReference)
This request is called to initiate a phone consultation call for the user the same way as when using the STARFACE call manager. |
void |
UcpCallRequests.playDtmf(String callId,
String dtmfDigits)
This request tells the UCI server to send DTMF sounds on that call. |
void |
UcpFunctionKeyRequests.pressKey(String functionKeyId,
List<Object> parameters)
This request allows the UCI client to virtually press a function key of the current user. |
boolean |
UcpServiceRequests.providesEvents(String serviceName)
This request can be used by the client to detect if events it wants to use are actually provided by the server. |
boolean |
UcpServiceRequests.providesRequests(String serviceName)
This request can be used by the client to detect if another requests it wants to use are actually provided by the server. |
void |
UcpConferenceCallRequests.quitConference(String roomId)
This request tells the UCI server to quit the conference. |
Map<String,Object> |
UcpPhoneRequests.registerSipPhone(Map<String,Object> setting)
This request allows the UCI client to get SIP credentials for a SoftPhone. |
void |
UcpCcbsCallRequests.removeAvailableCcbs(String callId)
This request tells the UCI server to remove an available ccbs call by the given UUID. |
void |
UcpCallRequests.resume(String callId,
String phoneId)
This request tells the UCI server to resume the call identified by the given UUID and the given Phone. |
void |
UcpFmcPhoneRequests.saveFmcPhone(FmcPhone phone)
Saving a new FMC phone or updating one. |
Map<String,Object> |
UcpFunctionKeyRequests.searchFunctionKeys(String searchTerm,
String searchId)
This request allows the UCI client to retrieve the function keys containing the given term in name or phone number. |
Map<String,Object> |
UcpFunctionKeyRequests.searchFunctionKeysByEmail(String emailAddress,
String searchId)
This request allows the UCI client to retrieve the function keys by email address. |
Map<String,Object> |
UcpFunctionKeyRequests.searchFunctionKeysByJabberId(String jabberId,
String searchId)
This request allows the UCI client to retrieve the function keys by jabber id. |
String |
UcpFaxRequests.sendFax(String faxNumber,
String faxId,
String textFileId,
String pdfFileId)
This request initiates the fax sending process. |
void |
UcpUserStateRequests.setAvatarImage(Map<String,Object> image)
This request can be used by the UCI client to set a new avatar image for the user. |
void |
UcpUserStateRequests.setAvatarImageFile(String fileId)
This request can be used by the UCI client to set a new avatar image for the user. |
void |
UcpPhoneRequests.setCallWaitingIndication(boolean callWaitingIndication)
This request allows the UCI client to configure the usage of call waiting indication for simultaneous phone calls. |
void |
UcpUserStateRequests.setChatPresenceMessage(String message)
This request can be used by the UCI client to set the chat presence message of the user. |
void |
UcpPhoneRequests.setDisplayNumberId(String phoneNumberId)
This request allows the UCI client to set the phone number that is signaled to the other party during a call on an outgoing line. |
void |
UcpUserStateRequests.setDoNotDisturbSetting(boolean active)
This request can be used by the UCI client to set the user do not disturb setting. |
void |
UcpGroupRequests.setGroupSetting(Map<String,Object> groupSetting)
This request saves the given group setting. |
void |
UcpGroupRequests.setGroupSettings(List<Map<String,Object>> groupSettings)
This request saves the given group settings. |
void |
UcpPhoneRequests.setPrimaryPhoneId(String phoneId)
This request allows the UCI client to set the primary phone of the user. |
void |
UcpRedirectRequests.setRedirectSetting(Map<String,Object> redirectSetting)
This request saves the given redirect setting. |
void |
UcpRedirectRequests.setRedirectSettings(List<Map<String,Object>> redirectSettings)
This request saves the given redirect settings. |
void |
UcpConferenceCallRequests.startManagedConferenceById(String conferenceId,
String phoneId)
This request tells the UCI server to start the conference with the given id. |
boolean |
UcpServiceRequests.subscribeEvents(String serviceName)
The client logged in at the server may subscribe to events provided by the server. |
void |
UcpCallRequests.switchPhone(String callId)
This request tells the UCI server to swith the phone of the given call identified by the given UUID. |
void |
UcpFunctionKeyRequests.terminateSearchRequest(String searchId)
To unsubscribe a search Request. |
void |
UcpCallRequests.transfer(String callId,
String callIdParked)
This request tells the UCI server to transfer a call identified by the given UUID to the given parked UUID. |
void |
UcpCallRequests.transferConsultationCall(String callId)
This request is called to transfer a consultation call for the user the same way as when using the STARFACE call manager. |
void |
UcpConferenceCallRequests.transferToConference(String roomId,
String uuidToTransfer)
This request tells the UCI server to transfer a call to a conference. |
void |
UcpCallRequests.transferToConferenceConsultationCall(String callId)
This request is called to transfer a consultation call to conference for the user the same way as when using the STARFACE call manager. |
void |
UcpCallRequests.transferToVoicemailBox(String callId,
String mailboxId)
This request tells the UCI server the call to the voicemailbox. |
void |
UcpServiceRequests.unsubscribeEvents(String serviceName)
The client logged in may also unsubscribe any events it has previously subscribed to. |
void |
UcpConferenceCallRequests.wantToTalkToConference(String uuidConferenceCall)
This request tells the UCI server that the confernce call wants to talk. |
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||