Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Fleet Resource


(information)

Info

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:


_10
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 of a Fleet resource's properties are immutable. If you wish to change a Super SIM's behavior, you may need to create a new Fleet resource and reassign the Sim resource to the new Fleet resource.


Fleet Properties

fleet-properties page anchor
Resource properties
account_sidtype: SID<AC>Not PII

sidtype: SID<HF>Not PII

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


unique_nametype: stringNot PII

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_createdtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.


date_updatedtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.


urltype: string<URI>Not PII

The absolute URL of the Fleet resource.


data_enabledtype: booleanNot PII

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


data_limittype: integerNot PII

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


data_meteringtype: enum<STRING>Not PII

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

Possible values:
payg

sms_commands_enabledtype: booleanNot PII

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


sms_commands_urltype: string<URI>Not PII

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.


sms_commands_methodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE

network_access_profile_sidtype: SID<HA>Not PII

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


ip_commands_urltype: string<URI>Not PII

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.


ip_commands_methodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE

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

If you update your Fleet's data limit, it will take a few moments, typically five minutes or less, for the Super SIMs assigned to that Fleet to respect the new data limit while the cached value expires. If you increase the data limit and have SIMs that are blocked because their data usage exceeded the previous data limit, they will automatically be unblocked when the new data limit takes effect. Similarly, SIMs whose data usage for the current billing period exceeds the new data limit will be blocked, if they were not already, when the new data limit takes effect. It should not take longer than 15minutes for the new data limit to take effect for all of the Super SIMs on your Fleet.

You can use the BillingPeriods subresource and UsageRecords resource to calculate how much of a SIM's data limit has been used. See more details here.


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

Parameters

create-parameters page anchor
Request body parameters
NetworkAccessProfiletype: stringNot PII
Required

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


UniqueNametype: stringNot PII

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.


DataEnabledtype: booleanNot PII

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


DataLimittype: integerNot PII

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


IpCommandsUrltype: string<URI>Not PII

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.


IpCommandsMethodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE

SmsCommandsEnabledtype: booleanNot PII

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


SmsCommandsUrltype: string<URI>Not PII

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.


SmsCommandsMethodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.supersim.v1.fleets
_12
.create({
_12
networkAccessProfile: 'HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_12
})
_12
.then(fleet => console.log(fleet.sid));

Output

_17
{
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"unique_name": "unique_name",
_17
"data_enabled": true,
_17
"data_limit": 500,
_17
"data_metering": "payg",
_17
"date_created": "2019-07-30T20:00:00Z",
_17
"date_updated": "2019-07-30T20:00:00Z",
_17
"sms_commands_enabled": true,
_17
"sms_commands_method": "GET",
_17
"sms_commands_url": "https://google.com",
_17
"ip_commands_method": "GET",
_17
"ip_commands_url": "https://google.com",
_17
"network_access_profile_sid": "HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"url": "https://supersim.twilio.com/v1/Fleets/HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_17
}


GET https://supersim.twilio.com/v1/Fleets/{Sid}

URI parameters
Sidtype: stringNot PII
Path Parameter

The SID of the Fleet resource to fetch.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.fleets('HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(fleet => console.log(fleet.uniqueName));

Output

_17
{
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"unique_name": "unique_name",
_17
"data_enabled": true,
_17
"data_limit": 1000,
_17
"data_metering": "payg",
_17
"date_created": "2019-07-30T20:00:00Z",
_17
"date_updated": "2019-07-30T20:00:00Z",
_17
"sms_commands_enabled": true,
_17
"sms_commands_method": "POST",
_17
"sms_commands_url": null,
_17
"ip_commands_method": "POST",
_17
"ip_commands_url": null,
_17
"network_access_profile_sid": "HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"url": "https://supersim.twilio.com/v1/Fleets/HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_17
}


Read multiple Fleet resources

read-multiple-fleet-resources page anchor
GET https://supersim.twilio.com/v1/Fleets

URI parameters
NetworkAccessProfiletype: stringNot PII
Query Parameter

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


PageSizetype: integerNot PII
Query Parameter

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


Pagetype: integerNot PII
Query Parameter

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


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.fleets
_10
.list({limit: 20})
_10
.then(fleets => fleets.forEach(f => console.log(f.sid)));

Output

_30
{
_30
"meta": {
_30
"first_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_30
"key": "fleets",
_30
"next_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=1",
_30
"page": 0,
_30
"page_size": 50,
_30
"previous_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_30
"url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0"
_30
},
_30
"fleets": [
_30
{
_30
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30
"unique_name": "Pilot Fleet",
_30
"data_enabled": true,
_30
"data_limit": 1000,
_30
"data_metering": "payg",
_30
"date_created": "2019-10-15T20:00:00Z",
_30
"date_updated": "2019-10-15T20:00:00Z",
_30
"sms_commands_enabled": true,
_30
"sms_commands_method": "POST",
_30
"sms_commands_url": null,
_30
"ip_commands_method": "POST",
_30
"ip_commands_url": null,
_30
"network_access_profile_sid": "HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30
"sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_30
"url": "https://supersim.twilio.com/v1/Fleets/HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_30
}
_30
]
_30
}


POST https://supersim.twilio.com/v1/Fleets/{Sid}

URI parameters
Sidtype: stringNot PII
Path Parameter

The SID of the Fleet resource to update.


Request body parameters
UniqueNametype: stringNot PII

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.


NetworkAccessProfiletype: stringNot PII

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


IpCommandsUrltype: string<URI>Not PII

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.


IpCommandsMethodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE

SmsCommandsUrltype: string<URI>Not PII

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.


SmsCommandsMethodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE

DataLimittype: integerNot PII

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

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.supersim.v1.fleets('HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_13
.update({
_13
uniqueName: 'GPS Trackers Fleet 5GB',
_13
dataLimit: 5000
_13
})
_13
.then(fleet => console.log(fleet.uniqueName));

Output

_17
{
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"unique_name": "GPS Trackers Fleet 5GB",
_17
"data_enabled": true,
_17
"data_limit": 5000,
_17
"data_metering": "payg",
_17
"date_created": "2019-10-15T20:00:00Z",
_17
"date_updated": "2019-10-15T20:00:00Z",
_17
"sms_commands_enabled": true,
_17
"sms_commands_method": "POST",
_17
"sms_commands_url": null,
_17
"ip_commands_method": "POST",
_17
"ip_commands_url": null,
_17
"network_access_profile_sid": "HAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"url": "https://supersim.twilio.com/v1/Fleets/HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_17
}


Customers can now delete unused and unwanted Fleets and their associated data. This can be done in Console(link takes you to an external page): visit Internet of Things > Fleets(link takes you to an external page), click on the name of the Fleet you wish to delete, and click the Delete Fleet link at the bottom of the page. You will be asked to confirm your action before the Fleet is deleted. Fleets to which SIMs are currently assigned cannot be deleted.

delete fleet form in console.

Rate this page: