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

Network Resource

A Network resource represents a cellular network to which Super SIMs can connect.

You can obtain a list of all available mobile operator networks, provided as an array of Network resources, from this endpoint:

https://supersim.twilio.com/v1/Networks
(information)

Info

To allow Super SIMs to connect to the cellular network that a Network resource represents, the Network resource must be included in a Network Access Profile resource's Networks subresource.

Network Properties

network-properties page anchor
Property nameTypeRequiredDescriptionChild properties
sidSID<HW>

Optional

Not PII

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

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

Optional

Not PII

A human readable identifier of this resource.

urlstring<uri>

Optional

Not PII

The absolute URL of the Network resource.

iso_countrystring

Optional

Not PII

The ISO country code(link takes you to an external page) of the Network resource.

identifiersarray

Optional

Not PII

Array of objects identifying the MCC-MNCs(link takes you to an external page) that are included in the Network resource.

The identifiers property

the-identifiers-property page anchor

A Network resource's identifiers property is an array of objects that contain identifiers for all of the public land mobile networks (PLMNs) that are represented by a Network resource.

mccThe Mobile Country Code (MCC) is the unique ID that identifies the mobile operator network's home country.
mncThe Mobile Network Code (MNC) is the unique ID that identifies the mobile operator network.
(information)

Info

There have been many mergers, spin-offs, and rebrandings of mobile network operators around the world. A PLMN may therefore have many identifiers, i.e., multiple MCC and MNC pairings. A PLMN's trading name may no longer match the 'friendly name' which is used to identify it in a human-readable way to other PLMNs and which is recorded in a Network resource's friendly_name property.

If there is a specific mobile network operator you are looking for which may have a different name to the Network resource's friendly_name property, check if its MCC and MNC IDs are included among a Network resource's identifiers.

Fetch a Network resource

fetch-a-network-resource page anchor
GET https://supersim.twilio.com/v1/Networks/{Sid}

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
SidSID<HW>required
Not PII

The SID of the Network resource to fetch.

Pattern: ^HW[0-9a-fA-F]{32}$Min length: 34Max length: 34
Fetch a Network resourceLink to code sample: Fetch a Network resource
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function fetchNetwork() {

11
  const network = await client.supersim.v1

12
    .networks("HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .fetch();

14


15
  console.log(network.sid);

16
}

17


18
fetchNetwork();

Output

1
{

2
  "friendly_name": "AT&T",

3
  "iso_country": "US",

4
  "identifiers": [

5
    {

6
      "mcc": "310",

7
      "mnc": "410"

8
    }

9
  ],

10
  "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

11
  "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

12
}

Read multiple Network resources

read-multiple-network-resources page anchor
GET https://supersim.twilio.com/v1/Networks

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
IsoCountrystring

Optional

Not PII

The ISO country code(link takes you to an external page) of the Network resources to read.

Mccstring

Optional

Not PII

The 'mobile country code' of a country. Network resources with this mcc in their identifiers will be read.

Mncstring

Optional

Not PII

The 'mobile network code' of a mobile operator network. Network resources with this mnc in their identifiers will be read.

PageSizeinteger

Optional

Not PII

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

Minimum: 1Maximum: 1000
Pageinteger

Optional

Not PII

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

Minimum: 0
PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Read Network resourcesLink to code sample: Read Network resources
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function listNetwork() {

11
  const networks = await client.supersim.v1.networks.list({ limit: 20 });

12


13
  networks.forEach((n) => console.log(n.sid));

14
}

15


16
listNetwork();

Output

1
{

2
  "meta": {

3
    "first_page_url": "https://supersim.twilio.com/v1/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/Networks?PageSize=50&Page=0"

10
  },

11
  "networks": [

12
    {

13
      "friendly_name": "AT&T",

14
      "iso_country": "US",

15
      "identifiers": [

16
        {

17
          "mcc": "310",

18
          "mnc": "410"

19
        }

20
      ],

21
      "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

22
      "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

23
    }

24
  ]

25
}
Read Network resources in a countryLink to code sample: Read Network resources in a country
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function listNetwork() {

11
  const networks = await client.supersim.v1.networks.list({

12
    isoCountry: "US",

13
    limit: 20,

14
  });

15


16
  networks.forEach((n) => console.log(n.isoCountry));

17
}

18


19
listNetwork();

Output

1
{

2
  "meta": {

3
    "first_page_url": "https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&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/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0"

10
  },

11
  "networks": [

12
    {

13
      "friendly_name": "AT&T",

14
      "iso_country": "US",

15
      "identifiers": [

16
        {

17
          "mcc": "310",

18
          "mnc": "410"

19
        }

20
      ],

21
      "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

22
      "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

23
    }

24
  ]

25
}

You can use the a cellular network's MCC-MNC to search for a specific network. For example, one of AT&T US' MCC-MNCs is 310-410. You can use the mcc and mnc parameters to search for the Network resource which represents AT&T US.

Read Network resource by MCC-MNCLink to code sample: Read Network resource by MCC-MNC
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function listNetwork() {

11
  const networks = await client.supersim.v1.networks.list({

12
    mcc: "310",

13
    mnc: "410",

14
    limit: 20,

15
  });

16


17
  networks.forEach((n) => console.log(n.identifiers));

18
}

19


20
listNetwork();

Output

1
{

2
  "meta": {

3
    "first_page_url": "https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&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/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0"

10
  },

11
  "networks": [

12
    {

13
      "friendly_name": "AT&T",

14
      "iso_country": "US",

15
      "identifiers": [

16
        {

17
          "mcc": "310",

18
          "mnc": "410"

19
        }

20
      ],

21
      "sid": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

22
      "url": "https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

23
    }

24
  ]

25
}

Need some help?

Terms of service
Privacy Policy

Copyright © 2024 Twilio Inc.