|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@RpcInterface(value="ucp.v30.requests.voicemailList") @UciService(value="ucp.v30.requests.voicemailList") public interface UcpVoicemailListRequests
This interface defines the voicemail list requests provided by the UCI server.
| Nested Class Summary | |
|---|---|
static interface |
UcpVoicemailListRequests.VoicemailFileDownload
This interface defines the RPC methods that can be used to download the voicemail files |
| Field Summary | |
|---|---|
static String |
SERVICE_NAME
The UCI service name used for this interface |
| Method Summary | |
|---|---|
void |
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 |
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 |
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 |
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. |
void |
deleteVoicemailListEntries(List<String> voicemailIds)
This request allows the UCI client to remove multiple voicemail list entries from the list |
void |
deleteVoicemailListEntry(String voicemailId)
This request allows the UCI client to remove a voicemail list entry from the list |
List<Map<String,String>> |
getMailboxes()
This request allows the UCI client to retrieve a list with all mailboxes of the current user |
String |
getVoicemailFile(String voicemailId)
Prepares the download of the voicemail for the given voicemail id. |
String |
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> |
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 |
moveVoicemailListEntries(List<String> voicemailIds,
String destinationFolder)
This request moves multiple voicemail list entries to another folder |
void |
moveVoicemailListEntry(String voicemailId,
String destinationFolder)
This request moves a voicemail list entry to another folder |
| Field Detail |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
Map<String,Object> getVoicemailList(Date startBefore,
Date startAfter,
String mailboxRestriction,
String folderRestriction,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
throws UciException
Map containing the values for the keys defined in
VoicemailListProperties.
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 an empty String is given no restriction is used.orderProperty - give the name of 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 an empty String or invalid
property name is given the default VoicemailListEntryProperties.startTime is
used.orderDirection - give the name of one of the OrderDirections to define the ordering. If not set
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
Map containing the results with the properties defined in
VoicemailListProperties
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,
String 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,
String 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).
String getVoicemailFile(String voicemailId)
throws UciException
UcpVoicemailListRequests.VoicemailFileDownload and the
returned fileId.
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<Map<String,String>> 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
UcpPhoneRequests.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
UcpPhoneRequests.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 | |||||||||