Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Inbound Processing Region API - SipDomain


In the context of the Inbound Processing Region API, a SipDomain resource represents the routing configuration for a particular Programmable Voice SIP Domain.

By adjusting the value of the voice_region property, you can control which Twilio Region will process and store data related to inbound calls for the SIP Domain.

(warning)

Warning

Changes to this resource may take up to 5 minutes to take effect. When you change the routing to a new Region for a SIP domain then it does not mean that the SIP Domain will be created automatically in the new Region. You will have to manually create the SIP Domain in the new Region with the same configuration.


SipDomain Properties

sipdomain-properties page anchor
Property nameTypePIIDescription
sip_domainstring
Not PII

urlstring<uri>

sidSID<QQ>
Pattern: ^QQ[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>
Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestring

voice_regionstring

date_createdstring<date-time>

date_updatedstring<date-time>

Fetch a SipDomain's current Inbound Processing Region configuration

fetch-a-sipdomains-current-inbound-processing-region-configuration page anchor
GET https://routes.twilio.com/v2/SipDomains/{SipDomain}

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
SipDomainstringrequired

Fetch a SipDomain's current Inbound Processing Region configuration

fetch-a-sipdomains-current-inbound-processing-region-configuration-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function fetchSipDomain() {
_18
const sipDomain = await client.routes.v2
_18
.sipDomains("example.sip.twilio.com")
_18
.fetch();
_18
_18
console.log(sipDomain.voiceRegion);
_18
}
_18
_18
fetchSipDomain();

Output

_10
{
_10
"url": "https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com",
_10
"account_sid": "AC00000000000000000000000000000000",
_10
"sid": "QQ00000000000000000000000000000000",
_10
"sip_domain": "example.sip.twilio.com",
_10
"friendly_name": "string",
_10
"voice_region": "string",
_10
"date_created": "2022-06-02T22:33:47Z",
_10
"date_updated": "2022-06-02T22:33:47Z"
_10
}


Update a SipDomain's Inbound Processing Region configuration

update-a-sipdomains-inbound-processing-region-configuration page anchor
POST https://routes.twilio.com/v2/SipDomains/{SipDomain}

Property nameTypeRequiredPIIDescription
SipDomainstringrequired
Property nameTypeRequiredPIIDescription
VoiceRegionstringOptional

FriendlyNamestringOptional

Update a SipDomain's Inbound Processing Region configuration

update-a-sipdomains-inbound-processing-region-configuration-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function updateSipDomain() {
_18
const sipDomain = await client.routes.v2
_18
.sipDomains("example.sip.twilio.com")
_18
.update({ voiceRegion: "au1" });
_18
_18
console.log(sipDomain.voiceRegion);
_18
}
_18
_18
updateSipDomain();

Output

_10
{
_10
"url": "https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com",
_10
"sip_domain": "example.sip.twilio.com",
_10
"sid": "QQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10
"friendly_name": "friendly_name",
_10
"voice_region": "au1",
_10
"date_created": "2020-08-07T22:29:24Z",
_10
"date_updated": "2020-08-07T22:29:24Z"
_10
}


Rate this page: