|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.call") @RpcInterface(value="ucp.v30.requests.call") public interface UcpCallRequests
This interface defines the call requests provided by the UCI server.
| Field Summary | |
|---|---|
static String |
SERVICE_NAME
The UCI service name used for this interface |
| 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. |
Map<String,Object> |
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. |
boolean |
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)
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 |
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. |
| Field Detail |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
List<String> getCallIds()
throws UciException
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).
Map<String,Object> getCallState(String callId)
throws UciException
callId - the UUID assigned to the phone call
Map. The constants of
CallProperties are used as keys in the Map. If the call
is not known an empty map is returned.
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 placeCallWithPhone(String destinationNumber,
String phoneId,
String callId)
throws UciException
CallState.OUTGOING.
destinationNumber - The phone number to dialphoneId - 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.
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 placeCallWithNumber(String destinationNumber,
String originatingNumber,
String callId)
throws UciException
CallState.OUTGOING.
destinationNumber - The phone number to dialoriginatingNumber - 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.
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).
boolean hangupCall(String callId)
throws UciException
callId - the UUID of the call to be hung up
true if the attempt to hang up the call was successful,
false otherwise
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 hold(String callId)
throws UciException
callId - the UUID of the call to be held
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 resume(String callId,
String phoneId)
throws UciException
callId - the UUID of the call to be heldphoneId - The id of the telephone used to make the phone call. 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 conference(List<String> callIds,
String phoneId)
throws UciException
callIds - the UUID of the calls to be redirectedphoneId - The id of the telephone used to make the phone call. 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 forward(String callId,
String extension)
throws UciException
callId - the UUID of the call to be forwarded.extension - The extension to be dialed.
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 transfer(String callId,
String callIdParked)
throws UciException
callId - the UUID of the call to be transfered.callIdParked - the parked call.
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 switchPhone(String callId)
throws UciException
callId - the UUID of the call to be transfered.
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 monitor(String callId)
throws UciException
callId - the UUID of the call to be transfered.
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 parkAndOrbit(String callId,
String parkAndOrbitNumber,
String phone)
throws UciException
callId - the UUID of the call to be transfered.parkAndOrbitNumber - the number of the parkorbitphone - The id of the telephone used to make the resume of the parked orbit. 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 callVoicemailBox(String phoneId)
throws UciException
phoneId - The id of the telephone used to make the phone call. 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 grabVoicemailBoxCallerWithPhone(String callId,
String phoneId)
throws UciException
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.
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 transferToVoicemailBox(String callId,
String mailboxId)
throws UciException
callId - the UUID of the call to be grabbed.mailboxId - The id of the mailbox used to record the call.
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 getCurrentMessageWaitingState()
throws UciException
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 playDtmf(String callId,
String dtmfDigits)
throws UciException
callId - the UUID of the call.
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).
Image getImageOfHash(String imageHash)
throws UciException
imageHash - the hash value of the image.
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 placeConsultationCallWithPhone(String destinationNumber,
String phoneId,
String callId,
String callIdReference)
throws UciException
CallState.OUTGOING.
destinationNumber - The phone number to dialphoneId - 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.
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 transferConsultationCall(String callId)
throws UciException
callId - The UUID to be transfered.
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 transferToConferenceConsultationCall(String callId)
throws UciException
callId - The UUID to be transfered.
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 | |||||||||