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
Resource properties
sip_domaintype: string
Not PII

urltype: string<uri>

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

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

friendly_nametype: string

voice_regiontype: string

date_createdtype: string<date-time>

date_updatedtype: string<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}

Parameters

fetch-parameters page anchor
URI parameters
SipDomaintype: string
Path ParameterNot PII

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

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.routes.v2.sipDomains('example.sip.twilio.com')
_10
.fetch()
_10
.then(sip_domain => console.log(sip_domain.voiceRegion));

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}

URI parameters
SipDomaintype: string
Path ParameterNot PII

Request body parameters
VoiceRegiontype: string

FriendlyNametype: string

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

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.routes.v2.sipDomains('example.sip.twilio.com')
_10
.update({voiceRegion: 'au1'})
_10
.then(sip_domain => console.log(sip_domain.voiceRegion));

Output

_10
{
_10
"url": "https://routes.twilio.com/v2/SipDomains/test.sip.twilio.com",
_10
"sip_domain": "example.sip.twilio.com",
_10
"sid": "QQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_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: