TwiML™ Voice: <Sms>

The <Sms> verb supports the following attributes that modify its behavior:

Use one or more of these attributes in a <Sms> verb like so:

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

3

4
const response = new VoiceResponse();
5
response.sms({
6
    from: '+14105551234',
7
    to: '+14105556789'
8
}, 'The king stay the king.');
9

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

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Sms from="+14105551234" to="+14105556789">The king stay the king.</Sms>
4
</Response>

The 'to' attribute takes a valid phone number as a value. Twilio will send an SMS message to this number.

When sending an SMS during an incoming call, 'to' defaults to the caller. When sending an SMS during an outgoing call, 'to' defaults to the called party. The value of 'to' must be a valid phone number. NOTE: sending to short codes is not currently supported.

Phone numbers should be formatted with a '+' and country code e.g., +16175551212 (E.164 format). For 'to' numbers without a '+', Twilio will use the same country code as the 'from' number. Twilio will also attempt to handle locally formatted numbers for that country code (e.g. (415) 555-1212 for US, 07400123456 for GB). If you are sending to a different country than the 'from' number, you must include a '+' and the country code to ensure proper delivery.

The 'from' attribute takes a valid phone number as an argument. This number must be a phone number that you've purchased from or ported to Twilio. When sending an SMS during an incoming call, 'from' defaults to the called party. When sending an SMS during an outgoing call, 'from' defaults to the calling party. This number must be an SMS-enabled phone number assigned to your account. If the phone number isn't SMS-enabled, then the <Sms> verb will not send an SMS message.

The 'action' attribute takes a URL as an argument. After processing the <Sms> verb, Twilio will make a GET or POST request to this URL with the form parameters 'SmsStatus' and 'SmsSid'. Using an 'action' URL, your application can receive synchronous notification that the message was successfully enqueued.

If you provide an 'action' URL, Twilio will use the TwiML received in your response to the 'action' URL request to continue the current call. Any TwiML verbs occurring after an <Sms> which specifies an 'action' attribute are unreachable.

If no 'action' is provided, <Sms> will finish and Twilio will move on to the next TwiML verb in the document. If there is no next verb, Twilio will end the phone call. Note that this is different from the behavior of <Record> and <Gather>. <Sms> does not make a request to the current document's URL by default if no 'action' URL is provided.

Twilio will pass the following parameters in addition to the standard TwiML Voice request parameters with its request to the 'action' URL:

The 'method' attribute takes the value GET or POST. This tells Twilio whether to request the 'action' URL via HTTP GET or POST. This attribute is modeled after the HTML form 'method' attribute. POST is the default value.

The 'statusCallback' attribute takes a URL as an argument. When the SMS message is actually sent, or if sending fails, Twilio will make an asynchronous POST request to this URL with the parameters 'SmsStatus' and 'SmsSid'. Note, 'statusCallback' always uses HTTP POST to request the given URL.

Twilio will pass the following parameters in addition to the standard TwiML Voice request parameters with its request to the 'statusCallback' URL:

The "noun" of a TwiML verb is the stuff nested within the verb that's not a verb itself; it's the stuff the verb acts upon. These are the nouns for <Sms>:

You can't nest any verbs within <Sms> and you can't nest <Sms> in any other verbs.

In this example, Twilio first tells the caller where the store is located, and then sends the caller an SMS with the location as the message.

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

3

4
const response = new VoiceResponse();
5
response.say('Our store is located at 123 Easy St.');
6
response.sms('Store Location: 123 Easy St.');
7

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

1
<?xml version="1.0" encoding="UTF-8"?>
2
<!-- page located at http://example.com/simple_sms.xml -->
3
<Response>
4
    <Say>Our store is located at 123 Easy St.</Say>
5
    <Sms>Store Location: 123 Easy St.</Sms>
6
</Response>

In this use case, we provide 'action' URL and 'method' attributes. Now when the message is queued for delivery, Twilio will make a request to the 'action' URL passing the parameter 'SmsStatus'. If the message is queued and waiting to be sent, 'SmsStatus' will have the value 'sending'. If an invalid attribute was provided, then 'SmsStatus' will be 'invalid'.

Your web application can look at the 'SmsStatus' parameter and decide what to do next.

If an 'action' URL is provided for <Sms>, flow of your application will continue with the TwiML received in response to the 'action' request. All verbs remaining in the document are unreachable and ignored.

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

3

4
const response = new VoiceResponse();
5
response.say('Our store is located at 123 Easy St.');
6
response.sms({
7
    action: '/smsHandler.php',
8
    method: 'POST'
9
}, 'Store Location: 123 Easy St.');
10

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

1
<?xml version="1.0" encoding="UTF-8"?>
2
<!-- page located at http://example.com/sms_status.xml -->
3
<Response>
4
    <Say>Our store is located at 123 Easy St.</Say>
5
    <Sms action="/smsHandler.php" method="POST">
6
        Store Location: 123 Easy St.
7
    </Sms>
8
</Response>

In this example we provide a 'statusCallback' URL. When the message is finished sending (not just enqueued), Twilio will asynchronously request the 'statusCallback' URL with the parameter 'SmsStatus'. If the messages was successfully sent, 'SmsStatus' will be 'sent'. If the message failed to send, 'SmsStatus' will be 'failed'.

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

3

4
const response = new VoiceResponse();
5
response.say('Our store is located at 123 Easy St.');
6
response.sms({
7
    statusCallback: '/smsHandler.php'
8
}, 'Store Location: 123 Easy St.');
9

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

1
<?xml version="1.0" encoding="UTF-8"?>
2
<!-- page located at http://example.com/sms_status_callback.xml -->
3
<Response>
4
    <Say>Our store is located at 123 Easy St.</Say>
5
    <Sms statusCallback="/smsHandler.php">Store Location: 123 Easy St.</Sms>
6
</Response>