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


@UciService(value="ucp.v30.requests.callList")
@RpcInterface(value="ucp.v30.requests.callList")
public interface UcpCallListRequests

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


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 void deleteCallListEntries(List<String> callIds)
          Remove multiple call list entries from the list
 void deleteCallListEntry(String callId)
          Remove a call list entry from the list
 Map<String,Object> getCallList(Date startBefore, Date startAfter, String directionRestriction, String resultRestriction, String groupRestriction, String orderProperty, String orderDirection, int countOffset, int countLimit)
          Retrieve a list of phone calls of the current user.
 String placeCallbackCallWithPhone(String callListEntryId, 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 list.
 

Field Detail

SERVICE_NAME

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

See Also:
Constant Field Values
Method Detail

getCallList

Map<String,Object> getCallList(Date startBefore,
                               Date startAfter,
                               String directionRestriction,
                               String resultRestriction,
                               String groupRestriction,
                               String orderProperty,
                               String orderDirection,
                               int countOffset,
                               int countLimit)
                               throws UciException
Retrieve a list of phone calls of the current user. The number of entries retrieved can be restricted by several parameters of this request. The results are returned as Map containing the values for the keys defined in CallListProperties.

Parameters:
startBefore - limit returned results to calls started before the given point of time
startAfter - limit returned results to calls started after the given point of time
directionRestriction - restrict returned results to calls of the given CallListEntryDirection. If an empty String is given no restriction is used.
resultRestriction - restrict returned results to calls of the given CallListEntryResult. If an empty String is given no restriction is used.
groupRestriction - restrict returned results to those conducted by a specified group. Possible choices are the String GroupRestriction.NON_GROUP to return all calls that do not belong to any group, the id of a group to restrict the list to the calls belonging to that group and the empty String to return all calls without restriction.
orderProperty - give the name of one of the CallListEntryProperties to order results by the value of the property. Allowed values are CallListEntryProperties.startTime, CallListEntryProperties.duration, CallListEntryProperties.callerNumber and CallListEntryProperties.calledNumber. When an empty String or invalid property name is given the default CallListEntryProperties.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 CallListProperties
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).

deleteCallListEntry

void deleteCallListEntry(String callId)
                         throws UciException
Remove a call list entry from the list

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

deleteCallListEntries

void deleteCallListEntries(List<String> callIds)
                           throws UciException
Remove multiple call list entries from the list

Parameters:
callIds - the ids of the call 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).

placeCallbackCallWithPhone

String placeCallbackCallWithPhone(String callListEntryId,
                                  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 list. The callListEntryId 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:
callListEntryId - The identification of the call list entry.
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).


Copyright © 2012 STARFACE GmbH. All rights reserved.