com.bandwidth.library.model

Class Call

java.lang.Object

com.bandwidth.library.model.BaseModelObject

com.bandwidth.library.model.Call

public class Call
extends BaseModelObject

Information about call.

Author:

vpotapenko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Call.CallAudioBuilder
class	Call.CallGatherBuilder
class	Call.CallTransferBuilder

Field Summary

Fields inherited from class com.bandwidth.library.model.BaseModelObject

client, dateFormat, parentUri, properties

Constructor Summary

Constructors

Constructor and Description
Call(BandwidthRestClient client, String parentUri, org.json.simple.JSONObject jsonObject)

Method Summary

Methods

Modifier and Type	Method and Description
void	answerOnIncoming() Answer an incoming phone call.
Call.CallGatherBuilder	callGatherBuilder() Creates a new builder for collecting a series of DTMF digits from a phone call with an optional prompt.
Call.CallTransferBuilder	callTransferBuilder(String transferTo) Creates builder for transferring call.
Date	getActiveTime()
String	getCallbackUrl()
Long	getChargeableDuration()
String	getDirection()
Date	getEndTime()
Event	getEvent(String eventId) Gets information about one call event.
String	getEvents()
List<Event>	getEventsList() Gets the events that occurred during the call.
String	getFrom()
Gather	getGather(String gatherId) Gets the gather DTMF parameters and results.
List<Recording>	getRecordings() Retrieve all recordings related to the call.
Date	getStartTime()
String	getState()
String	getTo()
void	hangUp() Hang up a phone call.
boolean	isRecordingEnabled()
Call.CallAudioBuilder	newAudioBuilder() Creates new builder for playing an audio file or speaking a sentence in a call.
void	recordingOff() Turn call recording OFF.
void	recordingOn() Turn call recording ON.
void	rejectIncoming() Reject an incoming phone call
void	sendDtmf(String dtmf) Sends DTMF.
void	stopAudioFilePlaying() Stop an audio file playing.
void	stopSentence() Stop an audio sentence.
String	toString()

Methods inherited from class com.bandwidth.library.model.BaseModelObject

getId, getProperty, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getUri, putProperty, toMap, updateProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Call

public Call(BandwidthRestClient client,
    String parentUri,
    org.json.simple.JSONObject jsonObject)

Method Detail

getDirection

public String getDirection()

getState

public String getState()

getFrom

public String getFrom()

getTo

public String getTo()

getCallbackUrl

public String getCallbackUrl()

getEvents

public String getEvents()

getStartTime

public Date getStartTime()

getActiveTime

public Date getActiveTime()

getEndTime

public Date getEndTime()

getChargeableDuration

public Long getChargeableDuration()

isRecordingEnabled

public boolean isRecordingEnabled()

getRecordings

public List<Recording> getRecordings()
                              throws IOException

Retrieve all recordings related to the call.

Returns:

recordings

Throws:

IOException

getEventsList

public List<Event> getEventsList()
                          throws IOException

Gets the events that occurred during the call.

Returns:

events

Throws:

IOException

getEvent

public Event getEvent(String eventId)
               throws IOException

Gets information about one call event.

Parameters:

eventId - event id

Returns:

information about event

Throws:

IOException

hangUp

public void hangUp()
            throws IOException

Hang up a phone call.

Throws:

IOException

answerOnIncoming

public void answerOnIncoming()
                      throws IOException

Answer an incoming phone call.

Throws:

IOException

rejectIncoming

public void rejectIncoming()
                    throws IOException

Reject an incoming phone call

Throws:

IOException

recordingOn

public void recordingOn()
                 throws IOException

Turn call recording ON.

Throws:

IOException

recordingOff

public void recordingOff()
                  throws IOException

Turn call recording OFF.

Throws:

IOException

callTransferBuilder

public Call.CallTransferBuilder callTransferBuilder(String transferTo)

Creates builder for transferring call.
Example:
call.callTransferBuilder("{number}").sentence("hello").create();

Parameters:

transferTo - number for transferring

Returns:

new builder

newAudioBuilder

public Call.CallAudioBuilder newAudioBuilder()

Creates new builder for playing an audio file or speaking a sentence in a call.
Example:
call.newAudioBuilder().sentence("Hello").create();

Returns:

new builder

stopAudioFilePlaying

public void stopAudioFilePlaying()
                          throws IOException

Stop an audio file playing.

Throws:

IOException

stopSentence

public void stopSentence()
                  throws IOException

Stop an audio sentence.

Throws:

IOException

sendDtmf

public void sendDtmf(String dtmf)
              throws IOException

Sends DTMF.

Parameters:

dtmf - DTMF value

Throws:

IOException

callGatherBuilder

public Call.CallGatherBuilder callGatherBuilder()

Creates a new builder for collecting a series of DTMF digits from a phone call with an optional prompt. This request returns immediately. When gather finishes, an event with the results will be posted to the callback URL.
Example:
call.callGatherBuilder().maxDigits(5).promptFileUrl("url_to_file").create();

Returns:

new builder

getGather

public Gather getGather(String gatherId)
                 throws IOException

Gets the gather DTMF parameters and results.

Parameters:

gatherId - gather id

Returns:

gather DTMF parameters and results

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object