NetworkAccessProfile Resource
NetworkAccessProfile resources control which public land mobile networks (PLMNs) your Super SIMs can connect to:
https://supersim.twilio.com/v1/NetworkAccessProfilesA NetworkAccessProfile resource can be referenced in the API by either by its unique Sid or UniqueName:
https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}
https://supersim.twilio.com/v1/NetworkAccessProfiles/{UniqueName}Each NetworkAccessProfile (NAP) resource has a Networks subresource (NAP Networks):
https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}/NetworksEach NAP Network resource represents a cellular network that Super SIMs can connect to — an allowed Network.
The NAP Network resources in the Networks subresource will be a subset of all of the Network resources available from the main Networks resource. You can add or remove NAP Network resources from the NAP Networks subresource at any time to change which cellular networks your Super SIMs can access.
The Super SIM Networks resource is a read-only resource which lists all of the cellular networks to which it is possible for Super SIMs to connect: it is a catalog of available networks for you to choose from. Once you’ve identified a cellular network you want to allow your Super SIMs to connect to, use its sid to add it to a NetworkAccessProfile resource’s Networks subresource. See these examples to learn how to add or remove NAP Network resources.
If your Super SIM has already attached to a network, authentication and authorization information may be cached in that network to allow devices to continue to use that network without re-authenticating. When you disable a network in a NAP, it may not take immediate effect for that Super SIM. The cached information for that Super SIM will need to expire before the Super SIM can no longer use that network. This may take up to a week, but varies by network.
To make use of a NetworkAccessProfile resource, it needs to be referenced by a Fleet resource. All of the Sim resources assigned to that Fleet will then be able to attach to the cellular networks allowed by the NetworkAccessProfile’s Networks subresource. A NetworkAccessProfile can be used by multiple Fleet resources.
Forbidden networks
The Networks subresource serves as an allow list of the cellular networks to which Super SIMs can connect. Network resources not present in the Networks subresource are therefore blocked (i.e., forbidden).
When your device scans for available cellular networks to attempt to attach to, it may find a number of cellular networks. Super SIMs can only attach to a cellular network if the Network resource that represents the cellular network is present in the Networks subresource. If your device explicitly tries to attach to a cellular network that has not been allowed, the network will return the error 5004 / ROAMING_NOT_ALLOWED.
There will be some cellular networks for which there is no Network resource available. As such there is no way to add them to the list of allowed cellular networks in a NetworkAccessProfile resource. No Super SIMs will be able to attach to these cellular networks.
Delete an NAP
New Feature Customers can now delete unused and unwanted NAPs and their associated data. This can be done in Console: visit Internet of Things > Network access profiles, click on the name of the NAP you wish to delete, and click the Delete NAP link at the bottom of the page. You will be asked to confirm your action before the NAP is deleted. NAPs which are currently assigned to Fleets cannot be deleted.
NetworkAccessProfile properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that identifies the Network Access Profile resource. |
unique_name
|
An application-defined string that uniquely identifies the resource. It can be used in place of the resource's |
account_sid
|
The SID of the Account that the Network Access Profile belongs to. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
url
|
The absolute URL of the Network Access Profile resource. |
links
|
|
Create a NetworkAccessProfile resource
https://supersim.twilio.com/v1/NetworkAccessProfiles
Parameters
| Parameters in REST API format | |
|---|---|
unique_name
Optional
|
An application-defined string that uniquely identifies the resource. It can be used in place of the resource's |
networks
Optional
|
List of Network SIDs that this Network Access Profile will allow connections to. |
Example 1
Fetch a NetworkAccessProfile resource
https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Network Access Profile resource to fetch. |
Example 1
Read multiple NetworkAccessProfile resources
https://supersim.twilio.com/v1/NetworkAccessProfiles
Example 1
Update a NetworkAccessProfile resource
https://supersim.twilio.com/v1/NetworkAccessProfiles/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Network Access Profile to update. |
unique_name
Optional
|
The new unique name of the Network Access Profile. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
