TwiML™ Voice: <Number>

The <Number> noun supports the following attributes that modify its behavior:

Phone numbers should be formatted in E.164 format with a + and country code, for example: +16175551212. Twilio will also accept unformatted US numbers, e.g., (415) 555-1212 or 415-555-1212.

The sendDigits attribute tells Twilio to play DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Twilio will dial the number, and when the automated system picks up, send the DTMF tones to connect to the extension.

The url attribute allows you to specify a URL that will return a TwiML response to be run on the called party's end, after they answer, but before the parties are connected.

You can use this TwiML to privately <Play> or <Say> information to the called party. You could also provide a chance to decline the phone call using <Gather> and <Hangup>. The url attribute does not support any other TwiML verbs.

If the answerOnBridge attribute is used on <Dial>, the current caller will continue to hear ringing while the TwiML document executes on the other end. TwiML documents executed in this manner are not allowed to contain the <Dial> verb.

The method attribute allows you to specify which HTTP method Twilio should use when requesting the URL in the url attribute. The default is POST.

The byoc attribute allows you to specify which configured customer BYOC Trunk Twilio should use to route the call to the PSTN. The default is none, in which case the call will be routed via the Twilio Super Network.

When dialing out to a number using <Dial>, an outbound call is initiated. The call transitions from the initiated state to the ringing state when the phone starts ringing. It transitions to the answered state when the call is picked up, and finally to the completed state when the call is over.

With statusCallbackEvent, you can subscribe to receive webhooks for the different call progress events for a given call: initiated, ringing, answered, or completed. Non-relative URLs must contain a valid hostname (underscores are not permitted).

The statusCallbackEvent attribute allows you to specify which events Twilio should trigger a webhook on. To specify multiple events separate them with a space: initiated ringing answered completed. If a statusCallback is provided and no status callback events are specified, the completed event will be sent by default.

As opposed to creating an outbound call via the API, outbound calls created using <Dial> are initiated right away and never queued. The following shows a timeline of possible call events that can be returned and the different call statuses that a <Dial> leg may experience:

Expand image

The statusCallback attribute allows you to specify a URL for Twilio to send webhook requests to on each event specified in the statusCallbackEvent attribute.

The statusCallbackMethod attribute allows you to specify which HTTP method Twilio should use when requesting the URL in the statusCallback attribute. The default is POST.

The parameters Twilio passes to your application in its asynchronous request to the StatusCallback URL include all parameters passed in a synchronous request to retrieve TwiML when Twilio receives a call to one of your Twilio numbers. The full list of parameters and descriptions of each are in the TwiML Voice Request documentation.

When the call progress events are fired, the Status Callback request also passes these additional parameters:

Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable or DetectMessageEnd. Use Enable if you would like us to return AnsweredBy as soon as the called party is identified. Use DetectMessageEnd if you would like to leave a message on an answering machine. .

The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy of unknown.

The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine.

The number of milliseconds of silence after speech activity at which point the speech activity is considered complete.

The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned.

The URL that we should call to notify your application whether the call was answered by human, machine, or fax.

The HTTP method we should use when calling the amdStatusCallback URL.

In this case, we want to dial the 1928 extension at 415-123-4567. We use a <Number> noun to describe the phone number and give it the attribute sendDigits. We want to wait before sending the extension, so we add a few leading w characters. Each w tells Twilio to wait half a second instead of playing a digit. This lets you adjust the timing of when the digits begin playing to suit the phone system you are dialing.

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3

4
const response = new VoiceResponse();
5
const dial = response.dial();
6
dial.number({
7
    sendDigits: 'wwww1928'
8
}, '415-123-4567');
9

10
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Dial>
4
        <Number sendDigits="wwww1928">
5
            415-123-4567
6
        </Number>
7
    </Dial>
8
</Response>

In this case, we use several <Number> tags to dial three phone numbers at the same time. The first of these calls to answer will be connected to the current caller, while the rest of the connection attempts are canceled.

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3

4
const response = new VoiceResponse();
5
const dial = response.dial();
6
dial.number('858-987-6543');
7
dial.number('415-123-4567');
8
dial.number('619-765-4321');
9

10
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Dial>
4
        <Number>
5
            858-987-6543
6
        </Number>
7
        <Number>
8
            415-123-4567
9
        </Number>
10
        <Number>
11
            619-765-4321
12
        </Number>
13
    </Dial>
14
</Response>

In this case, we want to receive a webhook for each call progress event when dialing a number using <Dial>.

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3

4
const response = new VoiceResponse();
5
const dial = response.dial();
6
dial.number({
7
    statusCallbackEvent: 'initiated ringing answered completed',
8
    statusCallback: 'https://myapp.com/calls/events',
9
    statusCallbackMethod: 'POST'
10
}, '+12349013030');
11

12
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Dial>
4
        <Number
5
         statusCallbackEvent="initiated ringing answered completed"
6
         statusCallback="https://myapp.com/calls/events"
7
         statusCallbackMethod="POST">
8
            +12349013030
9
        </Number>
10
    </Dial>
11
</Response>

In this case, we want to receive a webhook for each call progress event for each number when dialing multiple numbers using <Dial>.

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3

4
const response = new VoiceResponse();
5
const dial = response.dial();
6
dial.number({
7
    statusCallbackEvent: 'initiated ringing answered completed',
8
    statusCallback: 'https://myapp.com/calls/events',
9
    statusCallbackMethod: 'POST'
10
}, '+14155555555');
11
dial.number({
12
    statusCallbackEvent: 'initiated ringing answered completed',
13
    statusCallback: 'https://example.com/events',
14
    statusCallbackMethod: 'POST'
15
}, '+14153333333');
16

17
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Dial>
4
        <Number
5
         statusCallbackEvent='initiated ringing answered completed'
6
         statusCallback='https://myapp.com/calls/events'
7
         statusCallbackMethod='POST'>
8
            +14155555555
9
        </Number>
10
        <Number
11
         statusCallbackEvent='initiated ringing answered completed'
12
         statusCallback='https://example.com/events'
13
         statusCallbackMethod='POST'>
14
            +14153333333
15
        </Number>
16
    </Dial>
17
</Response>

In this case, we want to connect two parties using <Dial>, but we also want TwiML instructions to be sent to the party we are calling before they are connected to the call. By setting the url attribute, we can specify a URL that will return a TwiML response to be run on the called party's end. This TwiML will run after they answer, but before the parties are connected.

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3
const response = new VoiceResponse();
4
const dial = response.dial();
5
dial.number({
6
    url: 'http://example.com/agent_screen_call'
7
}, '415-123-4567');
8

9
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Dial>
4
        <Number url="http://example.com/agent_screen_call">415-123-4567</Number>
5
    </Dial>
6
</Response>

• You can specify up to ten numbers within a <Dial> verb to dial simultaneously.
• Simultaneous dialing is useful when you have several phones (or several people) that you want to ring when you receive an incoming call. Keep in mind that the first call that connects will cancel all the other attempts. If you dial an office phone system or a cellphone in airplane mode, it may pick up after a single ring, preventing the other phone numbers from ringing long enough for a human ever to answer. So you should take care to use simultaneous dialing only in situations where you know the behavior of the called parties.