Fleet Resource
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:
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.
The SID of the Account that created the Fleet resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The unique string that we created to identify the Fleet resource.
^HF[0-9a-fA-F]{32}$Min length: 34Max length: 34An 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.
The date and time in GMT when the resource was created specified in ISO 8601 format.
The date and time in GMT when the resource was last updated specified in ISO 8601 format.
Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to true.
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.
0The model by which a SIMs usage is metered and billed. Defaults to payg.
paygDefines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to false.
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.
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.
GETPOSTThe SID of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.
^HA[0-9a-fA-F]{32}$Min length: 34Max length: 34The 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.
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.
GETPOSTEach 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/Fleetsapplication/x-www-form-urlencodedThe SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
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.
Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to true.
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).
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.
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.
GETPOSTDefines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to true.
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.
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.
GETPOST1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createFleet() {11const fleet = await client.supersim.v1.fleets.create({12networkAccessProfile: "NetworkAccessProfile",13});1415console.log(fleet.accountSid);16}1718createFleet();
Output
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"unique_name": "unique_name",4"data_enabled": true,5"data_limit": 500,6"data_metering": "payg",7"date_created": "2019-07-30T20:00:00Z",8"date_updated": "2019-07-30T20:00:00Z",9"sms_commands_enabled": true,10"sms_commands_method": "GET",11"sms_commands_url": "https://google.com",12"ip_commands_method": "GET",13"ip_commands_url": "https://google.com",14"network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",15"sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",16"url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"17}
GET https://supersim.twilio.com/v1/Fleets/{Sid}The SID of the Fleet resource to fetch.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function fetchFleet() {11const fleet = await client.supersim.v1.fleets("Sid").fetch();1213console.log(fleet.accountSid);14}1516fetchFleet();
Output
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"unique_name": "unique_name",4"data_enabled": true,5"data_limit": 1000,6"data_metering": "payg",7"date_created": "2019-07-30T20:00:00Z",8"date_updated": "2019-07-30T20:00:00Z",9"sms_commands_enabled": true,10"sms_commands_method": "POST",11"sms_commands_url": null,12"ip_commands_method": "POST",13"ip_commands_url": null,14"network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",15"sid": "Sid",16"url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"17}
GET https://supersim.twilio.com/v1/FleetsThe SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function listFleet() {11const fleets = await client.supersim.v1.fleets.list({ limit: 20 });1213fleets.forEach((f) => console.log(f.accountSid));14}1516listFleet();
Output
1{2"meta": {3"first_page_url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",4"key": "fleets",5"next_page_url": null,6"page": 0,7"page_size": 50,8"previous_page_url": null,9"url": "https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0"10},11"fleets": [12{13"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",14"unique_name": "Pilot Fleet",15"data_enabled": true,16"data_limit": 1000,17"data_metering": "payg",18"date_created": "2019-10-15T20:00:00Z",19"date_updated": "2019-10-15T20:00:00Z",20"sms_commands_enabled": true,21"sms_commands_method": "POST",22"sms_commands_url": null,23"ip_commands_method": "POST",24"ip_commands_url": null,25"network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",26"sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",27"url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"28}29]30}
POST https://supersim.twilio.com/v1/Fleets/{Sid}The SID of the Fleet resource to update.
application/x-www-form-urlencodedAn 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.
The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
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.
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.
GETPOSTThe 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.
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.
GETPOSTThe 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).
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function updateFleet() {11const fleet = await client.supersim.v1.fleets("Sid").update({12dataLimit: 5000,13uniqueName: "GPS Trackers Fleet 5GB",14});1516console.log(fleet.uniqueName);17}1819updateFleet();
Output
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"unique_name": "GPS Trackers Fleet 5GB",4"data_enabled": true,5"data_limit": 5000,6"data_metering": "payg",7"date_created": "2019-10-15T20:00:00Z",8"date_updated": "2019-10-15T20:00:00Z",9"sms_commands_enabled": true,10"sms_commands_method": "POST",11"sms_commands_url": null,12"ip_commands_method": "POST",13"ip_commands_url": null,14"network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",15"sid": "Sid",16"url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"17}
Customers can now delete unused and unwanted Fleets and their associated data. This can be done in Console: visit Internet of Things > Fleets, 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.
