Dial — VoiceML verb

Element body

A bare phone number may be used as the body; nouns are the explicit form.

Example

<Response>
  <Dial callerId="+12125550100" timeout="20" record="record-from-answer"
        action="https://app.example.com/after-dial">
    <Number sendDigits="wwww1928">+18005551234</Number>
  </Dial>
</Response>

Attributes

Attribute	Default	Behaviour
`action`	`unset`	URL requested when the dial completes; the returned VoiceML continues the call. Without an action, execution falls through to the next verb.
`method`	`POST`	HTTP method for the action request: POST or GET.
`timeout`	`30`	Seconds the dialled party has to answer.
`timeLimit`	`14400`	Maximum bridged-call duration in seconds.
`callerId`	`anonymous`	Caller ID presented to the dialled party.
`answerOnBridge`	`false`	true keeps the caller in ringing until the dialled party answers, then both legs answer simultaneously. Default: the caller's leg answers immediately and hears ringback while the far end is dialled.
`hangupOnStar`	`false`	true lets the caller press * to end the bridged leg and return to the document at the verb after <Dial> (the action callback fires with DialCallStatus=completed).
`ringTone`	`unset`	Two-letter country code (us, gb, …) selecting the ringback tone the caller hears while the far end rings.
`sequential`	`false`	Accepted for compatibility but a no-op: one far-end leg is dialled per <Dial> (the first child).
`record`	`do-not-record`	Records the bridged call. Values: do-not-record, record-from-answer, record-from-ringing, record-from-answer-dual, record-from-ringing-dual.
`recordingTrack`	`both`	Which side of the bridge is captured: inbound, outbound, or both.
`recordingStatusCallback`	`unset`	URL that receives recording lifecycle events (same shape as <Record>): in-progress, completed, absent.
`recordingStatusCallbackMethod`	`POST`	HTTP method for recording lifecycle callbacks.
`recordingStatusCallbackEvent`	`completed`	Comma-separated list of lifecycle events to deliver.

Nesting

<Dial> accepts these nested elements:

Callbacks

action request (Number / Sip / Client)

Field	Description
`DialCallStatus`	Outcome of the dial: completed, no-answer, busy, or failed.
`DialCallSid`	Unique identifier of the dialled leg.
`DialCallDuration`	Seconds the bridged call lasted.
`RecordingSid / RecordingUrl / RecordingDuration`	Present when the bridge was recorded.

action request (Conference)

Field	Description
`ConferenceSid`	Identifier of the conference room the participant was in.
`DialCallStatus`	completed on a clean leave, failed on a join error.
`DialCallDuration`	Wall-clock seconds the participant was in the room.

Every callback also carries the standard call parameters (CallSid, AccountSid, From, To, CallStatus) and is signed with your account's API key.

Notes

<Sim> (mobile-SIM dialing) is not supported and returns an unsupported-element error.