Skip to content Skip to navigation Skip to topbar

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 nameTypeRequiredDescriptionChild properties

account_sidSID<AC>

Optional

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>

Optional

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

date_updatedstring<date-time-rfc-2822>

Optional

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

friendly_namestring

Optional

PII MTL: 0 days

The string that you assigned to describe the resource.

sidSID<AL>

Optional

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

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

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

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

IpAccessControlListSidSID<AL>required

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

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 createSipAuthCallsIpAccessControlListMapping() {
11  const ipAccessControlListMapping = await client.sip
12    .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .auth.calls.ipAccessControlListMappings.create({
14      ipAccessControlListSid: "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
15    });
16
17  console.log(ipAccessControlListMapping.accountSid);
18}
19
20createSipAuthCallsIpAccessControlListMapping();

Output

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
4  "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
5  "friendly_name": "friendly_name",
6  "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
7}

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

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

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

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

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 fetchSipAuthCallsIpAccessControlListMapping() {
11  const ipAccessControlListMapping = await client.sip
12    .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .auth.calls.ipAccessControlListMappings(
14      "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
15    )
16    .fetch();
17
18  console.log(ipAccessControlListMapping.accountSid);
19}
20
21fetchSipAuthCallsIpAccessControlListMapping();

Output

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
4  "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
5  "friendly_name": "friendly_name",
6  "sid": "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
7}

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

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

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

PageSizeinteger

Optional

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

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

Minimum: 0

PageTokenstring

Optional

The page token. This is provided by the API.

Read multiple SIP IpAccessControlListMapping 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 listSipAuthCallsIpAccessControlListMapping() {
11  const ipAccessControlListMappings = await client.sip
12    .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .auth.calls.ipAccessControlListMappings.list({ limit: 20 });
14
15  ipAccessControlListMappings.forEach((i) => console.log(i.accountSid));
16}
17
18listSipAuthCallsIpAccessControlListMapping();

Output

1{
2  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0",
3  "end": 0,
4  "previous_page_uri": null,
5  "contents": [],
6  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Auth/Calls/IpAccessControlListMappings.json?PageSize=50&Page=0",
7  "page_size": 50,
8  "start": 0,
9  "next_page_uri": null,
10  "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

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

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

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

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 deleteSipAuthCallsIpAccessControlListMapping() {
11  await client.sip
12    .domains("SDXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .auth.calls.ipAccessControlListMappings(
14      "ALXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
15    )
16    .remove();
17}
18
19deleteSipAuthCallsIpAccessControlListMapping();