Package com.twilio.twiml.voice
Class Dial
- java.lang.Object
-
- com.twilio.twiml.TwiML
-
- com.twilio.twiml.voice.Dial
-
public class Dial extends TwiML
TwiML wrapper for<Dial>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Dial.Builder
Create a new<Dial>
elementstatic class
Dial.Record
static class
Dial.RecordingEvent
static class
Dial.RecordingTrack
static class
Dial.RingTone
static class
Dial.Trim
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description URI
getAction()
Action URLString
getCallerId()
Caller ID to displayHttpMethod
getMethod()
Action URL methodString
getNumber()
Phone number to dialDial.Record
getRecord()
Record the callURI
getRecordingStatusCallback()
Recording status callback URLList<Dial.RecordingEvent>
getRecordingStatusCallbackEvents()
Recording status callback eventsHttpMethod
getRecordingStatusCallbackMethod()
Recording status callback URL methodDial.RecordingTrack
getRecordingTrack()
To indicate which audio track should be recordedHttpMethod
getReferMethod()
The HTTP method to use for the refer WebhookURI
getReferUrl()
Webhook that will receive future SIP REFER requestsDial.RingTone
getRingTone()
Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the DialInteger
getTimeLimit()
Max time lengthInteger
getTimeout()
Time to wait for answerDial.Trim
getTrim()
Trim the recordingBoolean
isAnswerOnBridge()
Preserve the ringing behavior of the inbound call until the Dialed call picks upBoolean
isHangupOnStar()
Hangup call on star pressBoolean
isSequential()
Used to determine if child TwiML nouns should be dialed in order, one after the other (sequential) or dial all at once (parallel).-
Methods inherited from class com.twilio.twiml.TwiML
equals, getChildren, getOptions, getTagName, hashCode, toUrl, toXml
-
-
-
-
Method Detail
-
getAction
public URI getAction()
Action URL- Returns:
- Action URL
-
getMethod
public HttpMethod getMethod()
Action URL method- Returns:
- Action URL method
-
getTimeout
public Integer getTimeout()
Time to wait for answer- Returns:
- Time to wait for answer
-
isHangupOnStar
public Boolean isHangupOnStar()
Hangup call on star press- Returns:
- Hangup call on star press
-
getTimeLimit
public Integer getTimeLimit()
Max time length- Returns:
- Max time length
-
getCallerId
public String getCallerId()
Caller ID to display- Returns:
- Caller ID to display
-
getRecord
public Dial.Record getRecord()
Record the call- Returns:
- Record the call
-
getTrim
public Dial.Trim getTrim()
Trim the recording- Returns:
- Trim the recording
-
getRecordingStatusCallback
public URI getRecordingStatusCallback()
Recording status callback URL- Returns:
- Recording status callback URL
-
getRecordingStatusCallbackMethod
public HttpMethod getRecordingStatusCallbackMethod()
Recording status callback URL method- Returns:
- Recording status callback URL method
-
getRecordingStatusCallbackEvents
public List<Dial.RecordingEvent> getRecordingStatusCallbackEvents()
Recording status callback events- Returns:
- Recording status callback events
-
isAnswerOnBridge
public Boolean isAnswerOnBridge()
Preserve the ringing behavior of the inbound call until the Dialed call picks up- Returns:
- Preserve the ringing behavior of the inbound call until the Dialed call picks up
-
getRingTone
public Dial.RingTone getRingTone()
Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial- Returns:
- Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial
-
getRecordingTrack
public Dial.RecordingTrack getRecordingTrack()
To indicate which audio track should be recorded- Returns:
- To indicate which audio track should be recorded
-
isSequential
public Boolean isSequential()
Used to determine if child TwiML nouns should be dialed in order, one after the other (sequential) or dial all at once (parallel). Default is false, parallel- Returns:
- Used to determine if child TwiML nouns should be dialed in order, one after the other (sequential) or dial all at once (parallel). Default is false, parallel
-
getReferUrl
public URI getReferUrl()
Webhook that will receive future SIP REFER requests- Returns:
- Webhook that will receive future SIP REFER requests
-
getReferMethod
public HttpMethod getReferMethod()
The HTTP method to use for the refer Webhook- Returns:
- The HTTP method to use for the refer Webhook
-
getNumber
public String getNumber()
Phone number to dial- Returns:
- Phone number to dial
-
-