com.bandwidth.sdk.model

Class Call

java.lang.Object

com.bandwidth.sdk.model.ModelBase

com.bandwidth.sdk.model.ResourceBase

com.bandwidth.sdk.model.Call

public class Call
extends ResourceBase

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.sdk.model.ResourceBase

client, id, properties

Fields inherited from class com.bandwidth.sdk.model.ModelBase

dateFormat

Constructor Summary

Constructors

Constructor and Description
Call(BandwidthClient client, org.json.simple.JSONObject jsonObject)

Method Summary

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(java.lang.String transferTo) Creates builder for transferring call.
static Call	create(BandwidthClient client, java.util.Map<java.lang.String,java.lang.Object> params) Dials a call, from a phone number to a phone number.
static Call	create(java.util.Map<java.lang.String,java.lang.Object> params) Dials a call, from a phone number to a phone number.
static Call	create(java.lang.String to, java.lang.String from) Convenience factory method to make an outbound call
static Call	create(java.lang.String to, java.lang.String from, java.lang.String callbackUrl, java.lang.String tag) Convenience method to dials a call from a phone number to a phone number
void	createGather(java.util.Map<java.lang.String,java.lang.Object> gatherParams, java.util.Map<java.lang.String,java.lang.Object> promptParams)
void	createGather(java.lang.String promptSentence)
static Call	get(BandwidthClient client, java.lang.String callId) Convenience factory method for Call, returns a Call object given an id
static Call	get(java.lang.String callId) Factory method for Call, returns information about an active or completed call.
java.util.Date	getActiveTime()
java.lang.String	getCallbackUrl()
java.lang.Long	getChargeableDuration()
java.lang.String	getDirection()
java.util.Date	getEndTime()
EventBase	getEvent(java.lang.String eventId) Gets information about one call event.
java.lang.String	getEvents()
java.util.List<EventBase>	getEventsList() Gets the events that occurred during the call.
java.lang.String	getFrom()
Gather	getGather(java.lang.String gatherId) Gets the gather DTMF parameters and results.
java.util.List<Recording>	getRecordings() Retrieve all recordings related to the call.
java.util.Date	getStartTime()
java.lang.String	getState()
java.lang.String	getTo()
protected java.lang.String	getUri()
void	hangUp() Hang up a phone call.
boolean	isRecordingEnabled()
static ResourceList<Call>	list() Factory method for Call list, returns a list of Call objects with default page, size
static ResourceList<Call>	list(BandwidthClient client, int page, int size) Factor method for Call list, returns a list of Call objects with page, size preference
static ResourceList<Call>	list(int page, int size) Factor method for Call list, returns a list of Call objects with page, size preference
Call.CallAudioBuilder	newAudioBuilder() Creates new builder for playing an audio file or speaking a sentence in a call.
void	playAudio(java.util.Map<java.lang.String,java.lang.Object> params)
void	playRecording(java.lang.String recordingUrl)
void	recordingOff() Turn call recording OFF.
void	recordingOn() Turn call recording ON.
void	rejectIncoming() Reject an incoming phone call
void	sendDtmf(java.lang.String dtmf) Sends DTMF.
protected void	setUp(org.json.simple.JSONObject jsonObject)
void	speakSentence(java.util.Map<java.lang.String,java.lang.Object> params)
void	speakSentence(java.lang.String sentence)
void	speakSentence(java.lang.String sentence, java.lang.String tag)
void	stopAudioFilePlaying() Stop an audio file playing.
void	stopSentence() Stop an audio sentence.
java.lang.String	toString()

Methods inherited from class com.bandwidth.sdk.model.ResourceBase

getClient, getId, getProperties, setId, toJSONArray, toJSONObject

Methods inherited from class com.bandwidth.sdk.model.ModelBase

getProperty, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, 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(BandwidthClient client,
            org.json.simple.JSONObject jsonObject)

Method Detail

get

public static Call get(java.lang.String callId)
                throws java.lang.Exception

Factory method for Call, returns information about an active or completed call.

Parameters:

callId - call id

Returns:

the call

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

get

public static Call get(BandwidthClient client,
                       java.lang.String callId)
                throws java.lang.Exception

Convenience factory method for Call, returns a Call object given an id

Parameters:

client - the client

callId - the call id

Returns:

the call

Throws:

java.lang.Exception - error.

list

public static ResourceList<Call> list()
                               throws java.io.IOException

Factory method for Call list, returns a list of Call objects with default page, size

Returns:

the list of calls

Throws:

java.io.IOException - unexpected error.

list

public static ResourceList<Call> list(int page,
                                      int size)
                               throws java.io.IOException

Factor method for Call list, returns a list of Call objects with page, size preference

Parameters:

page - the page

size - the page size

Returns:

the list

Throws:

java.io.IOException - unexpected error.

list

public static ResourceList<Call> list(BandwidthClient client,
                                      int page,
                                      int size)
                               throws java.io.IOException

Factor method for Call list, returns a list of Call objects with page, size preference

Parameters:

client - the client

page - the page

size - the page size

Returns:

the list

Throws:

java.io.IOException - unexpected error.

create

public static Call create(java.lang.String to,
                          java.lang.String from)
                   throws java.lang.Exception

Convenience factory method to make an outbound call

Parameters:

to - the to number

from - the from number

Returns:

the call

Throws:

java.lang.Exception - error.

create

public static Call create(java.lang.String to,
                          java.lang.String from,
                          java.lang.String callbackUrl,
                          java.lang.String tag)
                   throws java.lang.Exception

Convenience method to dials a call from a phone number to a phone number

Parameters:

to - the to number

from - the from number

callbackUrl - the callback URL

tag - the call tag

Returns:

the call

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

create

public static Call create(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws java.lang.Exception

Dials a call, from a phone number to a phone number.

Parameters:

params - the call params

Returns:

the call

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

create

public static Call create(BandwidthClient client,
                          java.util.Map<java.lang.String,java.lang.Object> params)
                   throws java.lang.Exception

Dials a call, from a phone number to a phone number.

Parameters:

client - the client

params - the call params

Returns:

the call

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

setUp

protected void setUp(org.json.simple.JSONObject jsonObject)

Specified by:

setUp in class ResourceBase

getUri

protected java.lang.String getUri()

speakSentence

public void speakSentence(java.util.Map<java.lang.String,java.lang.Object> params)
                   throws java.io.IOException,
                          AppPlatformException

Throws:

java.io.IOException

AppPlatformException

speakSentence

public void speakSentence(java.lang.String sentence)
                   throws java.io.IOException,
                          AppPlatformException

Throws:

java.io.IOException

AppPlatformException

speakSentence

public void speakSentence(java.lang.String sentence,
                          java.lang.String tag)
                   throws java.io.IOException,
                          AppPlatformException

Throws:

java.io.IOException

AppPlatformException

playRecording

public void playRecording(java.lang.String recordingUrl)
                   throws java.io.IOException,
                          AppPlatformException

Throws:

java.io.IOException

AppPlatformException

playAudio

public void playAudio(java.util.Map<java.lang.String,java.lang.Object> params)
               throws java.io.IOException,
                      AppPlatformException

Throws:

java.io.IOException

AppPlatformException

createGather

public void createGather(java.lang.String promptSentence)
                  throws java.io.IOException,
                         AppPlatformException

Throws:

java.io.IOException

AppPlatformException

createGather

public void createGather(java.util.Map<java.lang.String,java.lang.Object> gatherParams,
                         java.util.Map<java.lang.String,java.lang.Object> promptParams)
                  throws java.io.IOException,
                         AppPlatformException

Throws:

java.io.IOException

AppPlatformException

getDirection

public java.lang.String getDirection()

getState

public java.lang.String getState()

getFrom

public java.lang.String getFrom()

getTo

public java.lang.String getTo()

getCallbackUrl

public java.lang.String getCallbackUrl()

getEvents

public java.lang.String getEvents()

getStartTime

public java.util.Date getStartTime()

getActiveTime

public java.util.Date getActiveTime()

getEndTime

public java.util.Date getEndTime()

getChargeableDuration

public java.lang.Long getChargeableDuration()

isRecordingEnabled

public boolean isRecordingEnabled()

getRecordings

public java.util.List<Recording> getRecordings()
                                        throws java.lang.Exception

Retrieve all recordings related to the call.

Returns:

recordings the recordings

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

getEventsList

public java.util.List<EventBase> getEventsList()
                                        throws java.lang.Exception

Gets the events that occurred during the call.

Returns:

events the events list

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

getEvent

public EventBase getEvent(java.lang.String eventId)
                   throws java.lang.Exception

Gets information about one call event.

Parameters:

eventId - event id

Returns:

information about event

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

hangUp

public void hangUp()
            throws java.lang.Exception

Hang up a phone call.

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

answerOnIncoming

public void answerOnIncoming()
                      throws java.lang.Exception

Answer an incoming phone call.

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

rejectIncoming

public void rejectIncoming()
                    throws java.lang.Exception

Reject an incoming phone call

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

recordingOn

public void recordingOn()
                 throws java.lang.Exception

Turn call recording ON.

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

recordingOff

public void recordingOff()
                  throws java.lang.Exception

Turn call recording OFF.

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

callTransferBuilder

public Call.CallTransferBuilder callTransferBuilder(java.lang.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 java.io.IOException,
                                 AppPlatformException

Stop an audio file playing.

Throws:

java.io.IOException - unexpected error.

AppPlatformException - unexpected exception.

stopSentence

public void stopSentence()
                  throws java.io.IOException,
                         AppPlatformException

Stop an audio sentence.

Throws:

java.io.IOException - unexpected error.

AppPlatformException - unexpected exception.

sendDtmf

public void sendDtmf(java.lang.String dtmf)
              throws java.io.IOException,
                     AppPlatformException

Sends DTMF.

Parameters:

dtmf - DTMF value

Throws:

java.io.IOException - unexpected error.

AppPlatformException - unexpected exception.

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(java.lang.String gatherId)
                 throws java.lang.Exception

Gets the gather DTMF parameters and results.

Parameters:

gatherId - gather id

Returns:

gather DTMF parameters and results

Throws:

java.io.IOException - unexpected error.

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object