com.telapi.api.inboundxml.parameters
Class RecordParameters

java.lang.Object
  com.telapi.api.inboundxml.parameters.RecordParameters

public class RecordParameters
extends Object

Constructor Summary

RecordParameters(String action)

Method Summary

String	getAction()
Boolean	getBothLegs()
RecordingFileFormat	getFileFormat()
String	getFinishOnKey()
Long	getMaxLength()
HttpMethod	getMethod()
Boolean	getPlayBeep()
Long	getTimeout()
Boolean	getTranscribe()
String	getTranscribeCallback()
void	setAction(String action)
void	setBothLegs(Boolean bothLegs)
void	setFileFormat(RecordingFileFormat fileFormat)
void	setFinishOnKey(String finishOnKey)
void	setMaxLength(Long maxLength)
void	setMethod(HttpMethod method)
void	setPlayBeep(Boolean playBeep)
void	setTimeout(Long timeout)
void	setTranscribe(Boolean transcribe)
void	setTranscribeCallback(String transcribeCallback)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordParameters

public RecordParameters(String action)

Parameters:

action - URL where some parameters specific to Record will be sent for further processing (required).

Method Detail

getAction

public String getAction()

setAction

public void setAction(String action)

Parameters:

action - URL where some parameters specific to Record will be sent for further processing (required).

getMethod

public HttpMethod getMethod()

setMethod

public void setMethod(HttpMethod method)

Parameters:

method - Specifies the method to use when requesting the action or transcribeCallback URL.

getTimeout

public Long getTimeout()

setTimeout

public void setTimeout(Long timeout)

Parameters:

timeout - The number of seconds Record should wait during silence before ending. Greater than or equal to 0. Defaults to 5.

getFinishOnKey

public String getFinishOnKey()

setFinishOnKey

public void setFinishOnKey(String finishOnKey)

Parameters:

finishOnKey - The key a caller can press to end the Record. Allowed values are 0-9, # or *. Defaults to #.

getMaxLength

public Long getMaxLength()

setMaxLength

public void setMaxLength(Long maxLength)

Parameters:

maxLength - The maximum length in seconds a recording should be. Defaults to 3600.

getTranscribe

public Boolean getTranscribe()

setTranscribe

public void setTranscribe(Boolean transcribe)

Parameters:

transcribe - Boolean value specifying if the recording should be transcribed. Defaults to false.

getTranscribeCallback

public String getTranscribeCallback()

setTranscribeCallback

public void setTranscribeCallback(String transcribeCallback)

Parameters:

transcribeCallback - URL where the recording transcription will be sent. Defaults to the current InboundXML document.

getPlayBeep

public Boolean getPlayBeep()

setPlayBeep

public void setPlayBeep(Boolean playBeep)

Parameters:

playBeep - Boolean value specifying if a beep should be played when the recording begins. Defaults to false.

getBothLegs

public Boolean getBothLegs()

setBothLegs

public void setBothLegs(Boolean bothLegs)

Parameters:

bothLegs - Boolean value specifying if both call legs should be recorded. Defaults to false.

getFileFormat

public RecordingFileFormat getFileFormat()

setFileFormat

public void setFileFormat(RecordingFileFormat fileFormat)

Parameters:

fileFormat - The recording file format. Can be mp3 or wav. Default is mp3.