TWtwilio
SupersimV1Fleet

Create a Fleet

Changed on

Create a Fleet

post/v1/Fleets

Request

  • Base URL
    https://supersim.twilio.com
  • URL
    https://supersim.twilio.com/v1/Fleets
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

NetworkAccessProfilestring required

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

UniqueNamestring

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.

DataEnabledboolean

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

DataLimitinteger

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).

IpCommandsUrlstring uri

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.

IpCommandsMethod'GET' | 'POST' http-method

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.

SmsCommandsEnabledboolean

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

SmsCommandsUrlstring uri

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.

SmsCommandsMethod'GET' | 'POST' http-method

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.

Response

Created

account_sidstring nullable

The SID of the Account that created the Fleet resource.

sidstring nullable

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

unique_namestring nullable

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_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

urlstring uri nullable

The absolute URL of the Fleet resource.

data_enabledboolean nullable

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

data_limitinteger

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_metering'payg'

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

sms_commands_enabledboolean nullable

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

sms_commands_urlstring uri nullable

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'GET' | 'POST' http-method nullable

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.

network_access_profile_sidstring nullable

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

ip_commands_urlstring uri nullable

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'GET' | 'POST' http-method nullable

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.

Changes

  • v1af3b4d2ec72eRevision changes
    • info

      the response's property default value 0 was added for the status

  • v1d0ddd613f56bRevision changes
    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • info

      removed the DELETE enum value from the response property for the response status

    • info

      removed the DELETE enum value from the response property for the response status

    • info

      removed the HEAD enum value from the response property for the response status

    • info

      removed the HEAD enum value from the response property for the response status

    • info

      removed the PATCH enum value from the response property for the response status

    • info

      removed the PATCH enum value from the response property for the response status

    • info

      removed the PUT enum value from the response property for the response status

    • info

      removed the PUT enum value from the response property for the response status