com.bt.sdk.capabilities.session.thirdpartycall
Class SessionThirdPartyCallManager

java.lang.Object
  extended by com.bt.sdk.capabilities.session.thirdpartycall.SessionThirdPartyCallManager

public class SessionThirdPartyCallManager
extends java.lang.Object


Constructor Summary
SessionThirdPartyCallManager()
           
 
Method Summary
 void endCall(java.lang.String callId)
          Terminates a call.
 com.bt.sdk.capabilities.session.thirdpartycall.CallInformation getCallInformation(java.lang.String callId)
          Returns status information about the requested call.
 ThirdPartyCall makeCall(java.lang.String callingParty, java.lang.String calledParty)
          Causes a call to be setup between two parties.
 ThirdPartyCall makeCall(java.lang.String callingParty, java.lang.String calledParty, int announcementType)
          Causes a call to be setup between two parties.
 ThirdPartyCall makeCall(java.lang.String callingParty, java.lang.String calledParty, int dialTimeoutSec, int announcementType)
          Causes a call to be setup between two parties.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SessionThirdPartyCallManager

public SessionThirdPartyCallManager()
Method Detail

endCall

public void endCall(java.lang.String callId)
Terminates a call. If the call is active then both parties will be hung up. If the call is in the process of being set-up then any connected party will be hung up and no further action taken.

Parameters:
callId - The call identifier.

getCallInformation

public com.bt.sdk.capabilities.session.thirdpartycall.CallInformation getCallInformation(java.lang.String callId)
Returns status information about the requested call.

Parameters:
callId - The call identifier.
Returns:
CallInformation A databag with accessors for the call statistics such as duration, start time, call status, and termination cause.

makeCall

public ThirdPartyCall makeCall(java.lang.String callingParty,
                               java.lang.String calledParty,
                               int dialTimeoutSec,
                               int announcementType)
Causes a call to be setup between two parties. The calling party will be rung first. Once the calling party has answered then the called party will be rung. Once the called party has answered a call is setup between the two parties.

Parameters:
callingParty - The string URI of the calling party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
calledParty - The string URI of the called party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
dialTimeoutSec - Time (in seconds) to wait for caller or callee to answer. The default is 0 for no timeout.
announcementType - Value indicating the type of announcement played on joining a conference. See the sdk portal for information on these values.
Returns:
ThirdPartyCall An object containing information about a placed ThirdPartyCall.

makeCall

public ThirdPartyCall makeCall(java.lang.String callingParty,
                               java.lang.String calledParty,
                               int announcementType)
Causes a call to be setup between two parties. The calling party will be rung first. Once the calling party has answered then the called party will be rung. Once the called party has answered a call is setup between the two parties.

Parameters:
callingParty - The string URI of the calling party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
calledParty - The string URI of the called party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
announcementType - Value indicating the type of announcement played on joining a conference. See the sdk portal for information on these values.
Returns:
ThirdPartyCall An object containing information about a placed ThirdPartyCall.

makeCall

public ThirdPartyCall makeCall(java.lang.String callingParty,
                               java.lang.String calledParty)
Causes a call to be setup between two parties. The calling party will be rung first. Once the calling party has answered then the called party will be rung. Once the called party has answered a call is setup between the two parties.

Parameters:
callingParty - The string URI of the calling party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
calledParty - The string URI of the called party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
Returns:
ThirdPartyCall An object containing information about a placed ThirdPartyCall.