Skip to content Skip to navigation Skip to topbar

On this page

SIP IpAddress Resource

IpAddress resources describe the IP addresses that have access to the SIP Domain.

SIP IpAddress properties

Property nameTypeRequiredDescriptionChild properties

sidSID<IP>Optional

Not PII

A 34 character string that uniquely identifies this resource.

Pattern: ^IP[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>Optional

Not PII

The unique id of the Account that is responsible for this resource.

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

friendly_namestringOptional

Not PII

A human readable descriptive text for this resource, up to 255 characters long.

ip_addressstringOptional

Not PII

An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.

cidr_prefix_lengthintegerOptional

Not PII

An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.

Default: 0

ip_access_control_list_sidSID<AL>Optional

Not PII

The unique id of the IpAccessControlList resource that includes this resource.

Pattern: ^AL[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_createdstring<date-time-rfc-2822>Optional

Not PII

The date that this resource was created, given as GMT in RFC 2822 format.

date_updatedstring<date-time-rfc-2822>Optional

Not PII

The date that this resource was last updated, given as GMT in RFC 2822 format.

uristringOptional

Not PII

The URI for this resource, relative to https://api.twilio.com

Create a SIP IpAddress resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json

You can add up to 100 IP addresses to an IpAccessControlList.

ip_address must be a complete IP address; wildcards are not supported.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The unique id of the Account responsible for this resource.

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

IpAccessControlListSidSID<AL>required

Not PII

The IpAccessControlList Sid with which to associate the created IpAddress resource.

Pattern: ^AL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringrequired

Not PII

A human readable descriptive text for this resource, up to 255 characters long.

IpAddressstringrequired

Not PII

An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.

CidrPrefixLengthintegerOptional

Not PII

An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.

Create a SIP IpAddress resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createSipIpAddress() {
11  const ipAddress = await client.sip
12    .ipAccessControlLists("ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .ipAddresses.create({
14      friendlyName: "friendly_name",
15      ipAddress: "ip_address",
16    });
17
18  console.log(ipAddress.sid);
19}
20
21createSipIpAddress();

Output

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "date_created": "Mon, 20 Jul 2015 17:27:10 +0000",
4  "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
5  "friendly_name": "friendly_name",
6  "ip_access_control_list_sid": "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
7  "ip_address": "ip_address",
8  "cidr_prefix_length": 32,
9  "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11}

Fetch a SIP IpAddress resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The unique id of the Account responsible for this resource.

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

IpAccessControlListSidSID<AL>required

Not PII

The IpAccessControlList Sid that identifies the IpAddress resources to fetch.

Pattern: ^AL[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<IP>required

Not PII

A 34 character string that uniquely identifies the IpAddress resource to fetch.

Pattern: ^IP[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a SIP IpAddress resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchSipIpAddress() {
11  const ipAddress = await client.sip
12    .ipAccessControlLists("ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .ipAddresses("IPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14    .fetch();
15
16  console.log(ipAddress.sid);
17}
18
19fetchSipIpAddress();

Output

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "date_created": "Mon, 20 Jul 2015 17:27:10 +0000",
4  "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
5  "friendly_name": "friendly_name",
6  "ip_access_control_list_sid": "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
7  "ip_address": "192.168.1.1",
8  "cidr_prefix_length": 32,
9  "sid": "IPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
10  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11}

Read multiple SIP IpAddress resources

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The unique id of the Account responsible for this resource.

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

IpAccessControlListSidSID<AL>required

Not PII

The IpAccessControlList Sid that identifies the IpAddress resources to read.

Pattern: ^AL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

Read multiple SIP IpAddress resources

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listSipIpAddress() {
11  const ipAddresses = await client.sip
12    .ipAccessControlLists("ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .ipAddresses.list({ limit: 20 });
14
15  ipAddresses.forEach((i) => console.log(i.sid));
16}
17
18listSipIpAddress();

Output

1{
2  "end": 0,
3  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0",
4  "ip_addresses": [
5    {
6      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7      "date_created": "Mon, 20 Jul 2015 17:27:10 +0000",
8      "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
9      "friendly_name": "friendly_name",
10      "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
11      "ip_address": "192.168.1.1",
12      "cidr_prefix_length": 32,
13      "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
15    }
16  ],
17  "next_page_uri": null,
18  "page": 0,
19  "page_size": 50,
20  "previous_page_uri": null,
21  "start": 0,
22  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses.json?PageSize=50&Page=0"
23}

Update a SIP IpAddress resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The unique id of the Account responsible for this resource.

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

IpAccessControlListSidSID<AL>required

Not PII

The IpAccessControlList Sid that identifies the IpAddress resources to update.

Pattern: ^AL[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<IP>required

Not PII

A 34 character string that identifies the IpAddress resource to update.

Pattern: ^IP[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

IpAddressstringOptional

Not PII

An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.

FriendlyNamestringOptional

Not PII

A human readable descriptive text for this resource, up to 255 characters long.

CidrPrefixLengthintegerOptional

Not PII

An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.

Update a SIP IpAddress resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateSipIpAddress() {
11  const ipAddress = await client.sip
12    .ipAccessControlLists("ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .ipAddresses("IPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14    .update({ ipAddress: "ip_address" });
15
16  console.log(ipAddress.sid);
17}
18
19updateSipIpAddress();

Output

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "date_created": "Mon, 20 Jul 2015 17:27:10 +0000",
4  "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
5  "friendly_name": "friendly_name",
6  "ip_access_control_list_sid": "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
7  "ip_address": "ip_address",
8  "cidr_prefix_length": 32,
9  "sid": "IPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
10  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
11}

Delete a SIP IpAddress resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json

An HTTP 204 response with no response body indicates successful deletion.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The unique id of the Account responsible for this resource.

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

IpAccessControlListSidSID<AL>required

Not PII

The IpAccessControlList Sid that identifies the IpAddress resources to delete.

Pattern: ^AL[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<IP>required

Not PII

A 34 character string that uniquely identifies the resource to delete.

Pattern: ^IP[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a SIP IpAddress resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteSipIpAddress() {
11  await client.sip
12    .ipAccessControlLists("ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .ipAddresses("IPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14    .remove();
15}
16
17deleteSipIpAddress();