Skip to content Skip to navigation Skip to topbar

On this page

NetworkAccessProfile Networks Subresource

Each Network Access Profile resource has a Networks subresource (NAP Networks ) that contains a list of allowed cellular networks to Super SIMs can connect.

https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}/Networks

The NAP Network resources in this subresource are a subset of all of the Network resources available from the Networks resource. You can add or remove NAP Network resources from the NAP Networks subresource at any time to change which cellular networks Super SIMs using the parent Network Access Profile resource can connect to.

The Sid used to add, remove, or identify NAP Network resources is the same as the Sid of the corresponding Network resource. You can filter the NAP Networks subresource the same way you can the Networks resource.

NetworkAccessProfile Network properties

A Network Access Profile Network resource (NAP Network) has the same representation and values as the corresponding available Network resource with the exception of the additional NetworkAccessProfileSid property that identifies the Network Access Profile the subresource belongs to.

Property nameTypeRequiredDescriptionChild properties

sidSID<HW>

Optional

The unique string that identifies the Network resource.

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

network_access_profile_sidSID<HA>

Optional

The unique string that identifies the Network resource's Network Access Profile resource.

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

friendly_namestring

Optional

A human readable identifier of the Network this resource refers to.

iso_countrystring

Optional

The ISO country code of the Network resource.

identifiersarray

Optional

Array of objects identifying the MCC-MNCs that are included in the Network resource.

urlstring<uri>

Optional

The absolute URL of the Network resource.

Create a NetworkAccessProfile Network resource

POST https://supersim.twilio.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks

To allow Super SIMs to connect to a cellular network represented by a Network resource, a NAP Network resource must be created. Use the sid of the Network resource you with to add in your create request to add the NAP Networks subresource.

For example, if you wish to allow Super SIMs to connect to AT&T US.

First, you need to know the sid of the Network resource that represents AT&T US. You could do that by reading through the list of Network resources or if you know the MCC and MNC identifiers, you can read Networks resource by MCC and MNC. You will find that the Sid of the Network resource representing AT&T US is HWd85b0262d6fc4c0b991bf8294596642e.

Now that you know the Sid of the Network resource you wish to add, pass in HWd85b0262d6fc4c0b991bf8294596642e into your create NAP Network resource request.

Path parameters

Property nameTypeRequiredPIIDescription

NetworkAccessProfileSidstringrequired

The unique string that identifies the Network Access Profile resource.

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

NetworkSID<HW>required

The SID of the Network resource to be added to the Network Access Profile resource.

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

Create a NAP Network 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 createNetworkAccessProfileNetwork() {
11  const network = await client.supersim.v1
12    .networkAccessProfiles("NetworkAccessProfileSid")
13    .networks.create({ network: "HWd85b0262d6fc4c0b991bf8294596642e" });
14
15  console.log(network.sid);
16}
17
18createNetworkAccessProfileNetwork();

Output

1{
2  "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "network_access_profile_sid": "NetworkAccessProfileSid",
4  "friendly_name": "AT&T",
5  "iso_country": "us",
6  "identifiers": [
7    {
8      "mcc": "310",
9      "mnc": "410"
10    }
11  ],
12  "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
13}

Fetch a NetworkAccessProfile Network resource

GET https://supersim.twilio.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

NetworkAccessProfileSidstringrequired

The unique string that identifies the Network Access Profile resource.

SidSID<HW>required

The SID of the Network resource to fetch.

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

Fetch a NAP Network 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 fetchNetworkAccessProfileNetwork() {
11  const network = await client.supersim.v1
12    .networkAccessProfiles("NetworkAccessProfileSid")
13    .networks("HWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14    .fetch();
15
16  console.log(network.sid);
17}
18
19fetchNetworkAccessProfileNetwork();

Output

1{
2  "sid": "HWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "network_access_profile_sid": "NetworkAccessProfileSid",
4  "friendly_name": "AT&T",
5  "iso_country": "us",
6  "identifiers": [
7    {
8      "mcc": "310",
9      "mnc": "410"
10    }
11  ],
12  "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
13}

Read multiple NetworkAccessProfile Network resources

GET https://supersim.twilio.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks

Path parameters

Property nameTypeRequiredPIIDescription

NetworkAccessProfileSidstringrequired

The unique string that identifies the Network Access Profile resource.

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 NAP Network 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 listNetworkAccessProfileNetwork() {
11  const networks = await client.supersim.v1
12    .networkAccessProfiles("NetworkAccessProfileSid")
13    .networks.list({ limit: 20 });
14
15  networks.forEach((n) => console.log(n.sid));
16}
17
18listNetworkAccessProfileNetwork();

Output

1{
2  "meta": {
3    "first_page_url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0",
4    "key": "networks",
5    "next_page_url": null,
6    "page": 0,
7    "page_size": 50,
8    "previous_page_url": null,
9    "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0"
10  },
11  "networks": [
12    {
13      "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "friendly_name": "AT&T",
16      "iso_country": "us",
17      "identifiers": [
18        {
19          "mcc": "310",
20          "mnc": "410"
21        }
22      ],
23      "url": "https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
24    }
25  ]
26}

Delete a NetworkAccessProfile Network resource

DELETE https://supersim.twilio.com/v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

NetworkAccessProfileSidSID<HA>required

The unique string that identifies the Network Access Profile resource.

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

SidSID<HW>required

The SID of the Network resource to be removed from the Network Access Profile resource.

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

Delete a NAP Network 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 deleteNetworkAccessProfileNetwork() {
11  await client.supersim.v1
12    .networkAccessProfiles("HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .networks("HWXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
14    .remove();
15}
16
17deleteNetworkAccessProfileNetwork();