API Description for Parlay X
Third Party Call
The following sections provide information about the Call API used for application-initiated calls:
Call API
makeACall
Setup a call between two parties.
Table 4-1 makeACall(callingParty, calledParty, charging)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
callingParty
|
EndUserIdentifier
|
URI of the calling party.
|
|
calledParty
|
EndUserIdentifier
|
URI of the called party.
|
|
charging
|
String
|
Optional.
If present, represents the name of an operator-specific charging plan that defines who to charge for the call and how much. If the named charge plan does not exist, InvalidArgumentException is thrown. If no charge plan is specified, charging occurs in accordance with an operator-specific charging policy.
|
|
Returns
|
|
|
String
|
Identifier for the call.
|
|
Possible exceptions
|
|
UnknownEndUserException
|
|
ServiceException
|
|
InvalidArgumentException
|
getCallInformation
Get information on an ongoing call.
Table 4-2 getCallInformation(callIdentifier)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
callIdentifier
|
String
|
ID of the call to get information on.
|
|
Returns
|
|
|
CallInformationType
|
Status of the call.
|
|
Possible exceptions
|
|
UnknownEndUserException
|
|
ServiceException
|
endCall
Terminate an ongoing call.
Table 4-3 endCall(callIdentifier)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
callIdentifier
|
String
|
ID of the call to get information on.
|
|
Returns
|
|
Void
|
|
|
|
Possible exceptions
|
|
CallTerminatedException
|
|
ServiceException
|
|
UnknownEndUserException
|
cancelCallRequest
Cancels a request to start a Call. This method can only be used to cancel Calls that has not started.
Table 4-4 cancelCallRequest(callIdentifier)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
callIdentifier
|
String
|
ID of the call to get information on.
|
|
Returns
|
|
Void
|
|
|
|
Possible exceptions
|
|
CallConnectedException
|
|
ServiceException
|
|
UnknownCallIdentifierException
|
Data Types
Table 4-5 Data types specific for call
|
Data type
|
Description
|
|
CallInformationType
|
Structure where:
|
|
|
[0]
|
Indicates the current status of the call. Datatype is CallStatus.
|
|
|
[1]
|
The time of the beginning of the call.
Datatype is DateTime.
Valid when callStatus <> CallInitial.
|
|
|
[2]
|
Duration of the call expressed in seconds.
Datatype is int.
Valid when callStatus == CallTerminated.
|
|
|
[3]
|
Cause of the termination of the call.
Datatype is CallTerminationCause.
Valid when callStatus == CallTerminated.
|
|
CallStatus
|
Enumeration with the following values:
|
|
|
CallInitial
|
call is being established
|
|
|
CallConnected
|
call is active
|
|
|
CallTerminated
|
call was terminated
|
|
CallTerminationCause
|
Enumeration with the following values:
|
|
|
CallingPartyNoAnswer
|
Calling Party did not answer
|
|
|
CalledPartyNoAnswer
|
Called Party did not answer
|
|
|
CallingPartyBusy
|
Calling Party was busy
|
|
|
CalledPartyBusy
|
Called Party was busy
|
|
|
CallingPartyNotReachable
|
Calling Party was not reachable
|
|
|
CalledPartyNotReachable
|
Called Party was not reachable
|
|
|
CallHangUp
|
The call was terminated by either party hanging up
|
|
|
CallAborted
|
The call was aborted (any other termination cause)
|
Exceptions
Table 4-6 Exceptions specific for call
|
ID
|
Exception
|
Description
|
|
3PC1000W
|
CallConnectedException
|
The call was already active
|
|
3PC1001W
|
CallTerminatedException
|
The call is already terminated
|
|
3PC1002E
|
UnknownCallIdentifierException
|
The callIdentifier supplied does not relate to any known call request or has expired.
|
