|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.voicemailList")
@RpcInterface(value="ucp.v30.requests.voicemailList")
@RpcValueTranslation(version=30,
automaticFileTransfer=true)
public interface UciVoicemailListRequestsThis interface contains the UCI Communication Voicemail List Requests
| Method Summary | |
|---|---|
void |
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 |
callMailboxWithPhone(String mailboxId,
String phoneId)
Initiate a phone call to the given voicemail box using the given phone |
void |
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 |
callVoicemailWithPhone(String voicemailId,
String phoneId)
Initiate a call with the given phone that plays one of the current users voicemails. |
void |
deleteVoicemailListEntries(List<String> voicemailIds)
Remove multiple voicemail list entries from the list |
void |
deleteVoicemailListEntry(String voicemailId)
Remove a voicemail list entry from the list |
List<Mailbox> |
getMailboxes()
Retrieve a list with all mailboxes of the current user |
File |
getVoicemailFile(String voicemailId)
Downloads and returns the voicemail for the given voicemail id |
String |
getVoicemailFileUrl(String voicemailId)
Creates and returns a temporary URL that can be used to download the voicemail file for the next 15 minutes. |
VoicemailList |
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 |
moveVoicemailListEntries(List<String> voicemailIds,
VoicemailListEntryFolder destinationFolder)
Move mutliple voicemail list entries to another folder |
void |
moveVoicemailListEntry(String voicemailId,
VoicemailListEntryFolder destinationFolder)
Move a voicemail list entry to another folder |
| Method Detail |
|---|
VoicemailList getVoicemailList(Date startBefore,
Date startAfter,
String mailboxRestriction,
VoicemailListEntryFolder folderRestriction,
VoicemailListEntryProperties orderProperty,
OrderDirection orderDirection,
int countOffset,
int countLimit)
throws UciException
List of Map containing the values for the keys defined in
VoicemailListEntryProperties.
startBefore - limit returned results to voicemails started before the given point of timestartAfter - limit returned results to voicemails started after the given point of timemailboxRestriction - restrict returned results to voicemails in the mailbox with the given id. Available
mailboxes for the current user may be retrieved with a call to getMailboxes()
. If an empty String is given no restriction is used.folderRestriction - restrict returned results to voicemails in the given folder defined in
VoicemailListEntryFolder. If null is given no restriction is used.orderProperty - give one of the VoicemailListEntryProperties to order results by the value of
the property. Allowed values are VoicemailListEntryProperties.startTime,
VoicemailListEntryProperties.duration,
VoicemailListEntryProperties.callerNumber and
VoicemailListEntryProperties.calledNumber. When null or an invalid property is
given the default VoicemailListEntryProperties.startTime is used.orderDirection - give one of the OrderDirections to define the ordering. If null is given the
default order direction of the property will be usedcountOffset - the offset of the first returned value in the result list after the ordering has been
appliedcountLimit - the count of items returned in the result list
List containing the result elements
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void deleteVoicemailListEntry(String voicemailId)
throws UciException
voicemailId - the id of the voicemail list entry to remove
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void deleteVoicemailListEntries(List<String> voicemailIds)
throws UciException
voicemailIds - the ids of the voicemail list entries to remove
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void moveVoicemailListEntry(String voicemailId,
VoicemailListEntryFolder destinationFolder)
throws UciException
voicemailId - the id of the voicemail list entry to movedestinationFolder - the name of the folder to move the entry to as defined in
VoicemailListEntryFolder.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void moveVoicemailListEntries(List<String> voicemailIds,
VoicemailListEntryFolder destinationFolder)
throws UciException
voicemailIds - the ids of the voicemail list entries to movedestinationFolder - the name of the folder to move the entry to as defined in
VoicemailListEntryFolder.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
String getVoicemailFileUrl(String voicemailId)
throws UciException
voicemailId - the id of the voicemail list entry to retrieve the file for
String
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
File getVoicemailFile(String voicemailId)
throws UciException
voicemailId - the id of the voicemail list entry to retrieve the file for
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
List<Mailbox> getMailboxes()
throws UciException
List with one Map for each mailbox containing the properties as
defined in MailboxProperties.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if the request with the given parameters is not allowed to the user (
UciIllegalAccessException) or if the request is placed while the UCI client
is not connected (UcpNotConnectedException).
void callMailboxWithNumber(String mailboxId,
String originatingNumber)
throws UciException
mailboxId - the id of the mailbox to connect tooriginatingNumber - the phone number to be called
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void callMailboxWithPhone(String mailboxId,
String phoneId)
throws UciException
mailboxId - the id of the mailbox to connect tophoneId - the id of the phone used to initiate the call with as returned by
UciPhoneRequests.getPhoneIds() If not set the primary phone will be used.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void callVoicemailWithNumber(String voicemailId,
String originatingNumber)
throws UciException
voicemailId - the id of the voicemail to be playedoriginatingNumber - the phone number to be called
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void callVoicemailWithPhone(String voicemailId,
String phoneId)
throws UciException
voicemailId - the id of the voicemail to be playedphoneId - the id of the phone used to initiate the call with as returned by
UciPhoneRequests.getPhoneIds() If not set the primary phone will be used.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||