Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Fleet Resource

To avoid ambiguity throughout this page, Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) associated with a Sim resource.

A Fleet resource organizes and configures group of Sim resources.

https://supersim.twilio.com/v1/Fleets

A Sim resource must be assigned to a Fleet resource by specifying Fleet on the Sim resource before it can activated.

Some properties on a Fleet resources are immutable. If you wish to change your Super SIM's behavior you may need to create a new Fleet resource and reassign the Sim resources to the new Fleet resource.

Fleets properties

At this stage of the Super SIM beta, SMS Commands from your device are not stored or passed along for further processing. SMS Commands sent from your devices not be forwarded to your CommandsUrl.

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the Fleet resource.

sid
sid<HF> Not PII

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

unique_name

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the Fleet resource.

data_enabled
boolean Not PII

Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity

data_limit
integer Not PII

The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000).

data_metering
enum:data_metering Not PII

The model by which a SIMs usage is metered and billed. Defaults to "payg"

commands_enabled
boolean Not PII

Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands.

commands_url
url Not PII

The URL that will receive a webhook when a SIM in the Fleet originates a machine-to-machine SMS via Commands. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

commands_method
http_method Not PII

A string representing the HTTP method to use when making a request to commands_url. Can be one of POST or GET. Defaults to POST.

network_access_profile_sid
sid<HA> Not PII

The SID of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to

Data Limits

Each Super SIM's usage is measured independently. Data Limits specified on the Fleert resource are on a per SIM basis. For example, if a Fleet resource specifies a Data Limit of 5MB, every Super SIM assigned to that Fleet resource will be allowed to consume 5MB of data.

Create a Fleet resource

post
https://supersim.twilio.com/v1/Fleets
Parameters
Parameters in REST API format
network_access_profile
Required
post sid_like<HA> Not PII

The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to

unique_name
Optional
post string PII MTL: 30 DAYS

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

data_enabled
Optional
post boolean Not PII

Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity

data_limit
Optional
post integer Not PII

The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000).

commands_enabled
Optional
post boolean Not PII

Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands.

commands_url
Optional
post url Not PII

The URL that will receive a webhook when a SIM in the Fleet originates a machine-to-machine SMS via Commands. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

commands_method
Optional
post http_method Not PII

A string representing the HTTP method to use when making a request to commands_url. Can be one of POST or GET. Defaults to POST.

Example 1
        
        
        
        

        Fetch a Fleet resource

        get
        https://supersim.twilio.com/v1/Fleets/{Sid}
        Parameters
        Parameters in REST API format
        sid
        Path
        get sid_like<HF> Not PII

        The SID of the Fleet resource to fetch.

        Example 1
              
              
              
              

              Read multiple Fleet resources

              get
              https://supersim.twilio.com/v1/Fleets
              Parameters
              Parameters in REST API format
              network_access_profile
              Optional
              get sid_like<HA> Not PII

              The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to

              Example 1
                    
                    
                    
                    
                    Rate this page:

                    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 browsing the Twilio tag on Stack Overflow.