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

SIP IpAccessControlListMapping Resource

IpAccessControlListMapping resources contain the list of IpAccessControlList resources associated with this domain. IpAccessControlList resources contain the IpAddress resources that describe the IP addresses with access to the SIP Domain.

When an INVITE is received for a SIP Domain, the source IP address must be in one of the mapped lists to be accepted.

SIP IpAccessControlListMapping properties

Property nameTypePIIDescription
account_sidSID<AC>
Not PII

The SID of the Account that created the IpAccessControlListMapping resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
date_createdstring<date-time-rfc-2822>
Not PII

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updatedstring<date-time-rfc-2822>
Not PII

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

friendly_namestring
PII MTL: 0 days

The string that you assigned to describe the resource.

sidSID<AL>
Not PII

The unique string that that we created to identify the IpAccessControlListMapping resource.

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

Create a SIP IpAccessControlListMapping resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

The SID of the Account that will create the resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

The SID of the SIP domain that will contain the new resource.

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

Request body parameters

Property nameTypeRequiredPIIDescription
IpAccessControlListSidSID<AL>required
Not PII

The SID of the IpAccessControlList resource to map to the SIP domain.

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

Create a SIP IpAccessControlListMapping resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_20
// Download the helper library from https://www.twilio.com/docs/node/install
_20
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20
// Find your Account SID and Auth Token at twilio.com/console
_20
// and set the environment variables. See http://twil.io/secure
_20
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20
const authToken = process.env.TWILIO_AUTH_TOKEN;
_20
const client = twilio(accountSid, authToken);
_20
_20
async function createSipAuthCallsIpAccessControlListMapping() {
_20
const ipAccessControlListMapping = await client.sip
_20
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20
.auth.calls.ipAccessControlListMappings.create({
_20
ipAccessControlListSid: "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20
});
_20
_20
console.log(ipAccessControlListMapping.accountSid);
_20
}
_20
_20
createSipAuthCallsIpAccessControlListMapping();

Output

_10
{
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"friendly_name": "friendly_name",
_10
"sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10
}

Fetch a SIP IpAccessControlListMapping resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

The SID of the Account that created the IpAccessControlListMapping resource to fetch.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

The SID of the SIP domain that contains the resource to fetch.

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34
SidSID<AL>required
Not PII

The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to fetch.

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

Fetch a SIP IpAccessControlListMapping resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_21
// Download the helper library from https://www.twilio.com/docs/node/install
_21
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_21
_21
// Find your Account SID and Auth Token at twilio.com/console
_21
// and set the environment variables. See http://twil.io/secure
_21
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21
const authToken = process.env.TWILIO_AUTH_TOKEN;
_21
const client = twilio(accountSid, authToken);
_21
_21
async function fetchSipAuthCallsIpAccessControlListMapping() {
_21
const ipAccessControlListMapping = await client.sip
_21
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_21
.auth.calls.ipAccessControlListMappings(
_21
"ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_21
)
_21
.fetch();
_21
_21
console.log(ipAccessControlListMapping.accountSid);
_21
}
_21
_21
fetchSipAuthCallsIpAccessControlListMapping();

Output

_10
{
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
_10
"friendly_name": "friendly_name",
_10
"sid": "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}

Read multiple SIP IpAccessControlListMapping resources

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

The SID of the Account that created the IpAccessControlListMapping resources to read.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

The SID of the SIP domain that contains the resources to read.

Pattern: ^SD[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 IpAccessControlListMapping resources

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 listSipAuthCallsIpAccessControlListMapping() {
_18
const ipAccessControlListMappings = await client.sip
_18
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_18
.auth.calls.ipAccessControlListMappings.list({ limit: 20 });
_18
_18
ipAccessControlListMappings.forEach((i) => console.log(i.accountSid));
_18
}
_18
_18
listSipAuthCallsIpAccessControlListMapping();

Output

_11
{
_11
"first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0",
_11
"end": 0,
_11
"previous_page_uri": null,
_11
"contents": [],
_11
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0",
_11
"page_size": 50,
_11
"start": 0,
_11
"next_page_uri": null,
_11
"page": 0
_11
}

Delete a SIP IpAccessControlListMapping resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required
Not PII

The SID of the Account that created the IpAccessControlListMapping resources to delete.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
DomainSidSID<SD>required
Not PII

The SID of the SIP domain that contains the resources to delete.

Pattern: ^SD[0-9a-fA-F]{32}$Min length: 34Max length: 34
SidSID<AL>required
Not PII

The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to delete.

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

Delete a SIP IpAccessControlListMapping resource

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_19
// Download the helper library from https://www.twilio.com/docs/node/install
_19
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19
// Find your Account SID and Auth Token at twilio.com/console
_19
// and set the environment variables. See http://twil.io/secure
_19
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19
const authToken = process.env.TWILIO_AUTH_TOKEN;
_19
const client = twilio(accountSid, authToken);
_19
_19
async function deleteSipAuthCallsIpAccessControlListMapping() {
_19
await client.sip
_19
.domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_19
.auth.calls.ipAccessControlListMappings(
_19
"ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_19
)
_19
.remove();
_19
}
_19
_19
deleteSipAuthCallsIpAccessControlListMapping();

Rate this page: