de.starface.integration.uci.java.v30.messages.requests
Interface UciCallRequests


@UciService(value="ucp.v30.requests.call")
@RpcInterface(value="ucp.v30.requests.call")
@RpcValueTranslation(version=30)
public interface UciCallRequests

This interface defines the call requests provided by the UCI server.


Method Summary
 void callVoicemailBox(String phoneId)
          This request tells the UCI server to call the users voicemailbox.
 void 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 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<String> 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.
 Call getCallState(String callId)
          The getCallState request provides a number of properties about an identified call.
 void getCurrentMessageWaitingState()
          This request tells the UCI server to send current messageWaitingEvents for all mailboxes of the account.
 Image getImageOfHash(String imageHash)
          This request tells the UCI server to return the avatar image of an image hash.
 void grabVoicemailBoxCallerWithPhone(String callId, String phoneId)
          This request tells the UCI server to grab the call from the linked voicemailbox.
 void hangupCall(String callId)
          This request tells the UCI server to hang up the call identified by the given UUID.
 void hold(String callId)
          This request tells the UCI server to hold the call identified by the given UUID.
 void monitor(String callId)
          This request tells the UCI server to monitor the given call identified by the given UUID.
 void 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 placeCallWithNumber(String destinationNumber, String originatingNumber, String callId)
          This request is called to initiate a phone call for the user.
 String 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 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 playDtmf(String callId, String dtmfDigits)
          This request tells the UCI server to send DTMF sounds on that call.
 void 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 switchPhone(String callId)
          This request tells the UCI server to swith the phone of the given call identified by the given UUID.
 void 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 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 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 transferToVoicemailBox(String callId, String mailboxId)
          This request tells the UCI server the call to the voicemailbox.
 

Method Detail

getCallIds

List<String> getCallIds()
                        throws UciException
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.

Returns:
the UUIDs assigned to the existing phone calls
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

getCallState

Call getCallState(String callId)
                  throws UciException
The getCallState request provides a number of properties about an identified call. This includes the state of the call. The parameters callerNumber, callerName, calledNumber and calledName provide information about the parties involved in the call. If a name or number is not known to the UCI server an empty string is committed. It is possible that information about the caller or the called person is available on a later call.

Parameters:
callId - the UUID assigned to the phone call
Returns:
the different properties of the call in a Map. The constants of CallProperties are used as keys in the Map. If the call is not known an empty map is returned.
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).

placeCallWithPhone

String placeCallWithPhone(String destinationNumber,
                          String phoneId,
                          String callId)
                          throws UciException
This request is called to initiate a phone call for the user the same way as when using the STARFACE call manager. The phone number to call and phone to use can be selected using the request parameters. In UCI phone calls are identified using UUIDs (Universally Unique Identifier). The id for the call to be placed can either be given by the client or generated by STARFACE. The server may reject the request to place the call due to another place call request being in progress. If the result of the message is a valid UUID the call request is accepted and the call is in the state CallState.OUTGOING.

Parameters:
destinationNumber - The phone number to dial
phoneId - The id of the telephone used to make the phone call. If not set the primary phone will be used.
callId - The UUID to be assigned to the phone call. If not set STARFACE will create one.
Returns:
an empty string if the place call request was rejected by the server or the UUID assigned to the call otherwise
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).

placeCallWithNumber

String placeCallWithNumber(String destinationNumber,
                           String originatingNumber,
                           String callId)
                           throws UciException
This request is called to initiate a phone call for the user. First a call is made to the originating number and if the call is answered a call to the destination number is established and connected with the originating call. In UCI phone calls are identified using UUIDs (Universally Unique Identifier). The id for the call to be placed can either be given by the client or generated by STARFACE. The server may reject the request to place the call due to another place call request being in progress. If the result of the message is a valid UUID the call request is accepted and the call is in the state CallState.OUTGOING.

Parameters:
destinationNumber - The phone number to dial
originatingNumber - The phone number to dial first that will be used to originate the call. be used.
callId - The UUID to be assigned to the phone call. If not set STARFACE will create one.
Returns:
an empty string if the place call request was rejected by the server or the UUID assigned to the call otherwise
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).

hangupCall

void hangupCall(String callId)
                throws UciException
This request tells the UCI server to hang up the call identified by the given UUID.

Parameters:
callId - the UUID of the call to be hung up
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).

hold

void hold(String callId)
          throws UciException
This request tells the UCI server to hold the call identified by the given UUID.

Parameters:
callId - the UUID of the call to be held
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).

resume

void resume(String callId,
            String phoneId)
            throws UciException
This request tells the UCI server to resume the call identified by the given UUID and the given Phone.

Parameters:
callId - the UUID of the call to be held
phoneId - The id of the telephone used to make the phone call. 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).

conference

void conference(List<String> callIds,
                String phoneId)
                throws UciException
This request tells the UCI server to create a conference with calls identified by the given UUIDs and the given Phone.

Parameters:
callIds - the UUID of the calls to be redirected
phoneId - The id of the telephone used to make the phone call. 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).

forward

void forward(String callId,
             String extension)
             throws UciException
This request tells the UCI server to forward a call identified by the given UUID to the given Extension.

Parameters:
callId - the UUID of the call to be forwarded.
extension - The extension to be dialed.
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).

transfer

void transfer(String callId,
              String callIdParked)
              throws UciException
This request tells the UCI server to transfer a call identified by the given UUID to the given parked UUID.

Parameters:
callId - the UUID of the call to be transfered.
callIdParked - the parked call.
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).

switchPhone

void switchPhone(String callId)
                 throws UciException
This request tells the UCI server to swith the phone of the given call identified by the given UUID.

Parameters:
callId - the UUID of the call to be transfered.
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).

monitor

void monitor(String callId)
             throws UciException
This request tells the UCI server to monitor the given call identified by the given UUID.

Parameters:
callId - the UUID of the call to be transfered.
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).

parkAndOrbit

void parkAndOrbit(String callId,
                  String parkAndOrbitNumber,
                  String phone)
                  throws UciException
This request tells the UCI server to park and give an orbit number to the given call identified by the given UUID. If an call is in the given orbit number you will be connected to the parked member

Parameters:
callId - the UUID of the call to be transfered.
parkAndOrbitNumber - the number of the parkorbit
phone - The id of the telephone used to make the resume of the parked orbit. 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).

callVoicemailBox

void callVoicemailBox(String phoneId)
                      throws UciException
This request tells the UCI server to call the users voicemailbox.

Parameters:
phoneId - The id of the telephone used to make the phone call. 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).

grabVoicemailBoxCallerWithPhone

void grabVoicemailBoxCallerWithPhone(String callId,
                                     String phoneId)
                                     throws UciException
This request tells the UCI server to grab the call from the linked voicemailbox.

Parameters:
callId - the UUID of the call to be grabbed.
phoneId - The id of the telephone used to make the phone call. 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).

transferToVoicemailBox

void transferToVoicemailBox(String callId,
                            String mailboxId)
                            throws UciException
This request tells the UCI server the call to the voicemailbox.

Parameters:
callId - the UUID of the call to be grabbed.
mailboxId - The id of the mailbox used to record the call.
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).

getCurrentMessageWaitingState

void getCurrentMessageWaitingState()
                                   throws UciException
This request tells the UCI server to send current messageWaitingEvents for all mailboxes of the account.

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).

playDtmf

void playDtmf(String callId,
              String dtmfDigits)
              throws UciException
This request tells the UCI server to send DTMF sounds on that call.

Parameters:
callId - the UUID of the call.
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).

getImageOfHash

Image getImageOfHash(String imageHash)
                     throws UciException
This request tells the UCI server to return the avatar image of an image hash.

Parameters:
imageHash - the hash value of the image.
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).

placeConsultationCallWithPhone

String placeConsultationCallWithPhone(String destinationNumber,
                                      String phoneId,
                                      String callId,
                                      String callIdReference)
                                      throws UciException
This request is called to initiate a phone consultation call for the user the same way as when using the STARFACE call manager. The phone number to call and phone to use can be selected using the request parameters. In UCI phone calls are identified using UUIDs (Universally Unique Identifier). The id for the call to be placed can either be given by the client or generated by STARFACE. The server may reject the request to place the call due to another place call request being in progress. If the result of the message is a valid UUID the call request is accepted and the call is in the state CallState.OUTGOING.

Parameters:
destinationNumber - The phone number to dial
phoneId - The id of the telephone used to make the phone call. If not set the primary phone will be used.
callId - The UUID to be assigned to the phone call. If not set STARFACE will create one.
callIdReference - The UUID of the referenced Call.
Returns:
an empty string if the place call request was rejected by the server or the UUID assigned to the call otherwise
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).

transferConsultationCall

void transferConsultationCall(String callId)
                              throws UciException
This request is called to transfer a consultation call for the user the same way as when using the STARFACE call manager. The phone number to call and phone to use can be selected using the request parameters. In UCI phone calls are identified using UUIDs (Universally Unique Identifier). The id for the call to be placed can either be given by the client or generated by STARFACE. The server may reject the request to place the call due to another place call request being in progress.

Parameters:
callId - The UUID to be transfered.
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).

transferToConferenceConsultationCall

void transferToConferenceConsultationCall(String callId)
                                          throws UciException
This request is called to transfer a consultation call to conference for the user the same way as when using the STARFACE call manager. The phone number to call and phone to use can be selected using the request parameters. In UCI phone calls are identified using UUIDs (Universally Unique Identifier). The id for the call to be placed can either be given by the client or generated by STARFACE. The server may reject the request to place the call due to another place call request being in progress.

Parameters:
callId - The UUID to be transfered.
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.