Package com.twilio.twiml.voice

Class Dial.Builder

java.lang.Object

com.twilio.twiml.TwiML.Builder<Dial.Builder>

com.twilio.twiml.voice.Dial.Builder

Enclosing class:

Dial

public static class Dial.Builder
extends TwiML.Builder<Dial.Builder>

Create a new <Dial> element

Constructor Summary

Constructors

Constructor	Description
Builder()	Create a <Dial> with child elements
Builder(String number)	Create a <Dial> with number

Method Summary

Modifier and Type	Method	Description
Dial.Builder	action(String action)	Action URL
Dial.Builder	action(URI action)	Action URL
Dial.Builder	answerOnBridge(Boolean answerOnBridge)	Preserve the ringing behavior of the inbound call until the Dialed call picks up
Dial	build()	Create and return resulting <Dial> element
Dial.Builder	callerId(String callerId)	Caller ID to display
Dial.Builder	client(Client client)	Add a child <Client> element
Dial.Builder	conference(Conference conference)	Add a child <Conference> element
static Dial.Builder	fromXml(String xml)	Create and return a <Dial.Builder> from an XML string
Dial.Builder	hangupOnStar(Boolean hangupOnStar)	Hangup call on star press
Dial.Builder	method(HttpMethod method)	Action URL method
Dial.Builder	number(Number number)	Add a child <Number> element
Dial.Builder	number(String number)	Phone number to dial
Dial.Builder	queue(Queue queue)	Add a child <Queue> element
Dial.Builder	record(Dial.Record record)	Record the call
Dial.Builder	recordingStatusCallback(String recordingStatusCallback)	Recording status callback URL
Dial.Builder	recordingStatusCallback(URI recordingStatusCallback)	Recording status callback URL
Dial.Builder	recordingStatusCallbackEvents(Dial.RecordingEvent recordingStatusCallbackEvent)	Recording status callback events
Dial.Builder	recordingStatusCallbackEvents(List<Dial.RecordingEvent> recordingStatusCallbackEvent)	Recording status callback events
Dial.Builder	recordingStatusCallbackMethod(HttpMethod recordingStatusCallbackMethod)	Recording status callback URL method
Dial.Builder	recordingTrack(Dial.RecordingTrack recordingTrack)	To indicate which audio track should be recorded
Dial.Builder	referMethod(HttpMethod referMethod)	The HTTP method to use for the refer Webhook
Dial.Builder	referUrl(String referUrl)	Webhook that will receive future SIP REFER requests
Dial.Builder	referUrl(URI referUrl)	Webhook that will receive future SIP REFER requests
Dial.Builder	ringTone(Dial.RingTone ringTone)	Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial
Dial.Builder	sequential(Boolean sequential)	Used to determine if child TwiML nouns should be dialed in order, one after the other (sequential) or dial all at once (parallel).
Dial.Builder	sim(Sim sim)	Add a child <Sim> element
Dial.Builder	sip(Sip sip)	Add a child <Sip> element
Dial.Builder	timeLimit(Integer timeLimit)	Max time length
Dial.Builder	timeout(Integer timeout)	Time to wait for answer
Dial.Builder	trim(Dial.Trim trim)	Trim the recording

Methods inherited from class com.twilio.twiml.TwiML.Builder

addChild, addText, option

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String number)

Create a <Dial> with number

Builder

public Builder()

Create a <Dial> with child elements

Method Detail

fromXml

public static Dial.Builder fromXml(String xml)
                            throws TwiMLException

Create and return a <Dial.Builder> from an XML string

Throws:

TwiMLException

action

public Dial.Builder action(URI action)

Action URL

action

public Dial.Builder action(String action)

Action URL

method

public Dial.Builder method(HttpMethod method)

Action URL method

timeout

public Dial.Builder timeout(Integer timeout)

Time to wait for answer

hangupOnStar

public Dial.Builder hangupOnStar(Boolean hangupOnStar)

Hangup call on star press

timeLimit

public Dial.Builder timeLimit(Integer timeLimit)

Max time length

callerId

public Dial.Builder callerId(String callerId)

Caller ID to display

record

public Dial.Builder record(Dial.Record record)

Record the call

trim

public Dial.Builder trim(Dial.Trim trim)

Trim the recording

recordingStatusCallback

public Dial.Builder recordingStatusCallback(URI recordingStatusCallback)

Recording status callback URL

recordingStatusCallback

public Dial.Builder recordingStatusCallback(String recordingStatusCallback)

Recording status callback URL

recordingStatusCallbackMethod

public Dial.Builder recordingStatusCallbackMethod(HttpMethod recordingStatusCallbackMethod)

Recording status callback URL method

recordingStatusCallbackEvents

public Dial.Builder recordingStatusCallbackEvents(List<Dial.RecordingEvent> recordingStatusCallbackEvent)

Recording status callback events

recordingStatusCallbackEvents

public Dial.Builder recordingStatusCallbackEvents(Dial.RecordingEvent recordingStatusCallbackEvent)

Recording status callback events

answerOnBridge

public Dial.Builder answerOnBridge(Boolean answerOnBridge)

Preserve the ringing behavior of the inbound call until the Dialed call picks up

ringTone

public Dial.Builder ringTone(Dial.RingTone ringTone)

Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial

recordingTrack

public Dial.Builder recordingTrack(Dial.RecordingTrack recordingTrack)

To indicate which audio track should be recorded

sequential

public Dial.Builder sequential(Boolean sequential)

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

referUrl

public Dial.Builder referUrl(URI referUrl)

Webhook that will receive future SIP REFER requests

referUrl

public Dial.Builder referUrl(String referUrl)

Webhook that will receive future SIP REFER requests

referMethod

public Dial.Builder referMethod(HttpMethod referMethod)

The HTTP method to use for the refer Webhook

number

public Dial.Builder number(String number)

Phone number to dial

client

public Dial.Builder client(Client client)

Add a child <Client> element

conference

public Dial.Builder conference(Conference conference)

Add a child <Conference> element

number

public Dial.Builder number(Number number)

Add a child <Number> element

queue

public Dial.Builder queue(Queue queue)

Add a child <Queue> element

sim

public Dial.Builder sim(Sim sim)

Add a child <Sim> element

sip

public Dial.Builder sip(Sip sip)

Add a child <Sip> element

build

public Dial build()

Create and return resulting <Dial> element