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 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.
Customers may request that Fleet data be deleted. If you wish to do so, please contact our support team. For more information on Twilio’s data retention and deletion policy, please see this support document.
Fleet properties
Resource Properties in REST API format | |
---|---|
account_sid
|
The SID of the Account that created the Fleet resource. |
sid
|
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 |
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 Fleet resource. |
data_enabled
|
Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to |
data_limit
|
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). Defaults to 1GB (1,000). |
data_metering
|
The model by which a SIMs usage is metered and billed. Defaults to |
sms_commands_enabled
|
Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to |
sms_commands_url
|
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_method
|
|
network_access_profile_sid
|
The SID of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to. |
ip_commands_url
|
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_method
|
|
Data limits
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 Super SIM assigned to that Fleet resource will be allowed to consume no more than 5MB of data.
Create a Fleet resource
https://supersim.twilio.com/v1/Fleets
パラメーター
Parameters in REST API format | |
---|---|
network_access_profile
必須
|
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
オプション
|
An application-defined string that uniquely identifies the resource. It can be used in place of the resource's |
data_enabled
オプション
|
Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to |
data_limit
オプション
|
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). Defaults to 1GB (1,000). |
ip_commands_url
オプション
|
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_method
オプション
|
|
sms_commands_enabled
オプション
|
Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to |
sms_commands_url
オプション
|
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_method
オプション
|
|
例 1
Fetch a Fleet resource
https://supersim.twilio.com/v1/Fleets/{Sid}
パラメーター
Parameters in REST API format | |
---|---|
sid
Path
|
The SID of the Fleet resource to fetch. |
例 1
Read multiple Fleet resources
https://supersim.twilio.com/v1/Fleets
パラメーター
Parameters in REST API format | |
---|---|
network_access_profile
オプション
|
The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to. |
例 1
ヘルプが必要ですか?
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.