com.telapi.api.inboundxml.parameters
Class DialParameters

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

public class DialParameters
extends Object

Constructor Summary

DialParameters()

Method Summary

String	getAction()
HttpMethod	getCallbackMethod()
String	getCallbackUrl()
String	getCallerId()
Boolean	getConfirmSound()
String	getDialMusic()
String	getDigitsMatch()
String	getForwardedFrom()
Boolean	getHangupOnStar()
HttpMethod	getHeartbeatMethod()
String	getHeartbeatUrl()
Boolean	getHideCallerId()
HttpMethod	getMethod()
String	getNumber()
Boolean	getStraightToVm()
Long	getTimeLimit()
Long	getTimeout()
void	setAction(String action)
void	setCallbackMethod(HttpMethod callbackMethod)
void	setCallbackUrl(String callbackUrl)
void	setCallerId(String callerId)
void	setConfirmSound(Boolean confirmSound)
void	setDialMusic(String dialMusic)
void	setDigitsMatch(String digitsMatch)
void	setForwardedFrom(String forwardedFrom)
void	setHangupOnStar(Boolean hangupOnStar)
void	setHeartbeatMethod(HttpMethod heartbeatMethod)
void	setHeartbeatUrl(String heartbeatUrl)
void	setHideCallerId(Boolean hideCallerId)
void	setMethod(HttpMethod method)
void	setNumber(String number) The number which is to be dialed.
void	setStraightToVm(Boolean straightToVm)
void	setTimeLimit(Long timeLimit)
void	setTimeout(Long timeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

DialParameters

public DialParameters()

Method Detail

getNumber

public String getNumber()

setNumber

public void setNumber(String number)

The number which is to be dialed. If used, you cannot append elements to the Dial element.

Parameters:

number - The number which is to be dialed.

getAction

public String getAction()

setAction

public void setAction(String action)

Parameters:

action - URL where some parameters specific to Dial will be sent for further processing. The calling party can be redirected here upon the hang up of the B leg caller.

getMethod

public HttpMethod getMethod()

setMethod

public void setMethod(HttpMethod method)

Parameters:

method - Method used to request the action URL. Defaults to POST.

getTimeout

public Long getTimeout()

setTimeout

public void setTimeout(Long timeout)

Parameters:

timeout - The number of seconds calls made with are allowed silence before ending. Defaults to 30.

getHangupOnStar

public Boolean getHangupOnStar()

setHangupOnStar

public void setHangupOnStar(Boolean hangupOnStar)

Parameters:

hangupOnStar - Boolean value specifying if pressing * should end the dial. Defaults to false.

getTimeLimit

public Long getTimeLimit()

setTimeLimit

public void setTimeLimit(Long timeLimit)

Parameters:

timeLimit - The duration in seconds a call made through should occur for before ending. Defaults to 14400.

getCallerId

public String getCallerId()

setCallerId

public void setCallerId(String callerId)

Parameters:

callerId - Number to display as calling. Defaults to the ID of phone being used. Defaults to the caller's caller ID.

getHideCallerId

public Boolean getHideCallerId()

setHideCallerId

public void setHideCallerId(Boolean hideCallerId)

Parameters:

hideCallerId - hideCallerId Boolean value specifying if the caller ID should be hidden or not. Defaults to false.

getDialMusic

public String getDialMusic()

setDialMusic

public void setDialMusic(String dialMusic)

Parameters:

dialMusic - URL containing an audio file that can be played during the dial.

getCallbackUrl

public String getCallbackUrl()

setCallbackUrl

public void setCallbackUrl(String callbackUrl)

Parameters:

callbackUrl - URL requested once the dialed call connects.

getCallbackMethod

public HttpMethod getCallbackMethod()

setCallbackMethod

public void setCallbackMethod(HttpMethod callbackMethod)

Parameters:

callbackMethod - Method used to request the callback URL. Defaults to POST.

getConfirmSound

public Boolean getConfirmSound()

setConfirmSound

public void setConfirmSound(Boolean confirmSound)

Parameters:

confirmSound - Boolean value specifying if a sound should play when dial is successful. Defaults to false.

getDigitsMatch

public String getDigitsMatch()

setDigitsMatch

public void setDigitsMatch(String digitsMatch)

Parameters:

digitsMatch - Specifies digits that TelAPI should listen for and send to the callbackUrl if a caller inputs them. Separate additional digits or digit patterns with a comma. Allowed values are digits, # and *.

getStraightToVm

public Boolean getStraightToVm()

setStraightToVm

public void setStraightToVm(Boolean straightToVm)

Parameters:

straightToVm - Boolean value specifying if call should be redirected to voice mail immediately. Defaults to false.

getHeartbeatUrl

public String getHeartbeatUrl()

setHeartbeatUrl

public void setHeartbeatUrl(String heartbeatUrl)

Parameters:

heartbeatUrl - A URL TelAPI can request every 60 seconds during the call to notify of elapsed time and pass other general information.

getHeartbeatMethod

public HttpMethod getHeartbeatMethod()

setHeartbeatMethod

public void setHeartbeatMethod(HttpMethod heartbeatMethod)

Parameters:

heartbeatMethod - Method used to request the heartbeat URL. Defaults to POST.

getForwardedFrom

public String getForwardedFrom()

setForwardedFrom

public void setForwardedFrom(String forwardedFrom)

Parameters:

forwardedFrom - Specifies the number to list the call as forwarded from.