de.starface.integration.uci.java.v30.ucp.messages.requests
Interface UcpVoicemailListRequests


@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

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

getVoicemailList

Map<String,Object> getVoicemailList(Date startBefore,
                                    Date startAfter,
                                    String mailboxRestriction,
                                    String folderRestriction,
                                    String orderProperty,
                                    String orderDirection,
                                    int countOffset,
                                    int countLimit)
                                    throws UciException
With this request the UCI client can retrieve a list of voicemails of the current user. The number of entries retrieved can be restricted by several parameters of this procedure call. The results are returned as Map containing the values for the keys defined in VoicemailListProperties.

Parameters:
startBefore - limit returned results to voicemails started before the given point of time
startAfter - limit returned results to voicemails started after the given point of time
mailboxRestriction - 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 used
countOffset - the offset of the first returned value in the result list after the ordering has been applied
countLimit - the count of items returned in the result list
Returns:
a Map containing the results with the properties defined in VoicemailListProperties
Throws:
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).

deleteVoicemailListEntry

void deleteVoicemailListEntry(String voicemailId)
                              throws UciException
This request allows the UCI client to remove a voicemail list entry from the list

Parameters:
voicemailId - the id of the voicemail list entry to remove
Throws:
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).

deleteVoicemailListEntries

void deleteVoicemailListEntries(List<String> voicemailIds)
                                throws UciException
This request allows the UCI client to remove multiple voicemail list entries from the list

Parameters:
voicemailIds - the ids of the voicemail list entries to remove
Throws:
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).

moveVoicemailListEntry

void moveVoicemailListEntry(String voicemailId,
                            String destinationFolder)
                            throws UciException
This request moves a voicemail list entry to another folder

Parameters:
voicemailId - the id of the voicemail list entry to move
destinationFolder - the name of the folder to move the entry to as defined in VoicemailListEntryFolder.
Throws:
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).

moveVoicemailListEntries

void moveVoicemailListEntries(List<String> voicemailIds,
                              String destinationFolder)
                              throws UciException
This request moves multiple voicemail list entries to another folder

Parameters:
voicemailIds - the ids of the voicemail list entries to move
destinationFolder - the name of the folder to move the entry to as defined in VoicemailListEntryFolder.
Throws:
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).

getVoicemailFileUrl

String getVoicemailFileUrl(String voicemailId)
                           throws UciException
This request creates and returns a temporary URL that can be used to download the voicemail file for the next 15 minutes.

Parameters:
voicemailId - the id of the voicemail list entry to retrieve the file for
Returns:
The download URL as String
Throws:
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).

getVoicemailFile

String getVoicemailFile(String voicemailId)
                        throws UciException
Prepares the download of the voicemail for the given voicemail id. After a calling this request the file can be downloaded using the interface UcpVoicemailListRequests.VoicemailFileDownload and the returned fileId.

Parameters:
voicemailId - the id of the voicemail list entry to retrieve the file for
Returns:
the fileId that can be used to download the file from STARFACE
Throws:
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).

getMailboxes

List<Map<String,String>> getMailboxes()
                                      throws UciException
This request allows the UCI client to retrieve a list with all mailboxes of the current user

Returns:
a List with one Map for each mailbox containing the properties as defined in MailboxProperties.
Throws:
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).

callMailboxWithNumber

void callMailboxWithNumber(String mailboxId,
                           String originatingNumber)
                           throws UciException
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

Parameters:
mailboxId - the id of the mailbox to connect to
originatingNumber - the phone number to be called
Throws:
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).

callMailboxWithPhone

void callMailboxWithPhone(String mailboxId,
                          String phoneId)
                          throws UciException
With this request the UCI client can initiate a phone call to the given voicemail box using the given phone

Parameters:
mailboxId - the id of the mailbox to connect to
phoneId - 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.
Throws:
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).

callVoicemailWithNumber

void callVoicemailWithNumber(String voicemailId,
                             String originatingNumber)
                             throws UciException
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.

Parameters:
voicemailId - the id of the voicemail to be played
originatingNumber - the phone number to be called
Throws:
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).

callVoicemailWithPhone

void callVoicemailWithPhone(String voicemailId,
                            String phoneId)
                            throws UciException
With this request the UCI client can initiate a call with the given phone that plays one of the current users voicemails.

Parameters:
voicemailId - the id of the voicemail to be played
phoneId - 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.
Throws:
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).


Copyright © 2012 STARFACE GmbH. All rights reserved.