Skip to contentSkip to navigationSkip to topbar
Page toolsOn this pageProducts used
Looking for more inspiration?Visit the

Use the Programmable Messaging API with Twilio Regions


You can use the Programmable Messaging API in Twilio's Ireland (IE1) region for EU data residency.

For more information on how SMS personal data is processed when using this feature, see the overview of EU Data Residency for SMS.

(new)

Public Beta

Data Residency for SMS in the EU is currently available as a Public Beta product and the information contained in this document is subject to change. This means that some features are not yet implemented and others may be changed before the product is declared as Generally Available. Public Beta products are not covered by the Twilio Support Terms or Twilio Service Level Agreement (SLA). Learn more about beta product support(link takes you to an external page).

This guide explains how to configure your application to use the Programmable Messaging API with the IE1 Region. For a general overview of Twilio Regions, see Understanding Twilio Regions. For information about the Messaging API, see Programmable Messaging API Overview.


Available features

available-features page anchor

With SMS in the IE1 region, you can use the Programmable Messaging API to send and receive SMS messages with EU Data Residency. This includes:

(information)

Info

Access to SMS in IE1 is API only. The Twilio Console does not support managing messaging resources in IE1, except for creating IE1-specific API credentials.

For an in-depth list of available Messaging features in IE1, see Messaging IE1 Feature Availability.


Any Twilio customer can use the Programmable Messaging API in IE1. To get started, follow these steps:

1. Create IE1-specific API credentials

1-create-ie1-specific-api-credentials page anchor

To authenticate requests to the IE1 Region, you must create region-specific API keys. See Manage regional API credentials to get started.

2. Configure your senders for IE1

2-configure-your-senders-for-ie1 page anchor

If you plan on sending with phone numbers, you must use the Phone Number Regional Configuration API to update the phone number's region for messaging. This ensures that inbound messages and webhooks configured on the phone number are processed in IE1.

Alphanumeric sender IDs do not require additional configuration to be used in IE1, since they do not support inbound messaging.

3. Send messages in IE1 through the API or SDK

3-send-messages-in-ie1-through-the-api-or-sdk page anchor

Once your credentials and senders are prepared, you can begin sending messages by targeting the IE1-specific base AP URLs or by configuring your SDK to use the IE1 region. See the API or SDK sections for details and examples.


Using the Programmable Messaging API in IE1

using-the-programmable-messaging-api-in-ie1 page anchor

To make API requests to the IE1 Region, use the following base URLs:

API ResourceAPI URL for Ireland (IE1) Region
Messageshttps://api.dublin.ie1.twilio.com/2010-04-01/Accounts/$ACCOUNT_SID/Messages/
Messaging Serviceshttps://messaging.dublin.ie1.twilio.com/v1/Services
Incoming Phone Numbershttps://api.dublin.ie1.twilio.com/2010-04-01/Accounts/$ACCOUNT_SID/IncomingPhoneNumbers/
(information)

Info

Only the dublin edge location is supported for messaging API requests in IE1.

Configure a phone number for IE1

configure-a-phone-number-for-ie1 page anchor

Using the Phone Number Regional Configuration API, you can update a phone number's configuration to enable it for use in the IE1 Region. This is required for any phone numbers to send messages through IE1.

(information)

Info

This is a US1 based configuration API that requires US1 API credentials.

1
curl -X POST "https://routes.twilio.com/v3/PhoneNumbers/+35XXXXXXXXXX" \
2
--data-urlencode "voiceRegion=ie1" \
3
--data-urlencode "messagingRegion=ie1" \
4
-u US1_API_KEY_SID:US1_API_KEY_SECRET

To send an SMS message through the IE1 Region, make a POST request to the Messages resource using the IE1 base URL.

1
curl -X POST "https://api.dublin.ie1.twilio.com/2010-04-01/Accounts/*ACCOUNT_SID*/Messages.json" \
2
--data-urlencode "Body=Hello from IE1!" \
3
--data-urlencode "From=+35XXXXXXXXXX" \
4
--data-urlencode "To=+35XXXXXXXXXX" \
5
-u {IE1_API_KEY_SID}:{IE1_API_KEY_SECRET}

Messaging Services in IE1

messaging-services-in-ie1 page anchor

Messaging Services must be created in IE1 in order to be used for outbound and inbound messaging in IE1. For a list of Messaging Service features currently supported in IE1, see Messaging IE1 Feature Availability.

To create a Messaging Service in the IE1 Region, make a POST request to the Services resource using the IE1 base URL.

1
curl -X POST "https://messaging.dublin.ie1.twilio.com/v1/Services" \
2
--data-urlencode "FriendlyName=My IE1 Messaging Service" \
3
-u {IE1_API_KEY_SID}:{IE1_API_KEY_SECRET}

To add a Messaging Service sender in IE1, make a POST request to the appropriate subresource under the Messaging Service using the IE1 base URL.

(information)

Info

Only phone number senders that are configured for IE1 through the Phone Number Regional Configuration API can be added to Messaging Services in IE1.

1
curl -X POST "https://messaging.dublin.ie1.twilio.com/v1/Services/{ServiceSid}/PhoneNumbers" \
2
--data-urlencode "PhoneNumber=+35XXXXXXXXXX" \
3
-u {IE1_API_KEY_SID}:{IE1_API_KEY_SECRET}

To send messages with the Messaging Service in IE1, include the Messaging Service SID as the From parameter in your API request:

1
curl -X POST "https://api.dublin.ie1.twilio.com/2010-04-01/Accounts/{AccountSid}/Messages.json" \
2
--data-urlencode "Body=Hello from IE1 Messaging Service!" \
3
--data-urlencode "From={ServiceSid}" \
4
--data-urlencode "To=+35XXXXXXXXXX" \
5
-u {IE1_API_KEY_SID}:{IE1_API_KEY_SECRET}

Configure inbound SMS webhooks

configure-inbound-sms-webhooks page anchor

Inbound webhooks for messages received in IE1 can be configured through the Incoming Phone Numbers resource or through the Messaging Services resource.

Using the Incoming Phone Numbers resource:

1
curl -X POST "https://api.dublin.ie1.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{PhoneNumberSid}.json" \
2
--data-urlencode "SmsUrl=https://www.example.com/sms" \
3
--data-urlencode "SmsMethod=POST" \
4
-u {IE1_API_KEY_SID}:{IE1_API_KEY_SECRET}

Using the Messaging Services resource:

1
curl -X POST "https://messaging.dublin.ie1.twilio.com/v1/Services/{ServiceSid}" \
2
--data-urlencode "InboundRequestUrl=https://www.example.com/sms" \
3
--data-urlencode "InboundMethod=POST" \
4
--data-urlendcode "useInboundWebhookOnNumber=false" \
5
-u {IE1_API_KEY_SID}:{IE1_API_KEY_SECRET}

Using the Twilio SDKs with IE1

using-the-twilio-sdks-with-ie1 page anchor

When using Twilio SDKs, specify the edge and region parameters to target the IE1 Region. For example, using the Node.js SDK:

1
const twilio = require('twilio');
2
3
const ie1ApiKey = 'IE1_API_KEY';
4
const ie1ApiSecret = 'IE1_API_SECRET';
5
6
const client = twilio(ie1ApiKey, ie1ApiSecret, {
7
accountSid: accountSid,
8
edge: 'dublin',
9
region: 'ie1'
10
});