Menu

Expand
Rate this page:

The Super SIM API

Twilio IoT’s Super SIM API empowers you to manage and deploy massive fleets of IoT devices around the world.

Using this REST API, you can activate and deactivate Super SIMs, control the capabilities of individual Super SIMs or groups of Super SIMs, send machine-to-machine (M2M) messages, and query usage.

The Super SIM API base URL

All URLs in the reference documentation use the following base URL:

https://supersim.twilio.com/v1

The API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. All responses are provided in JSON format.

You don’t need to use the .json file extension in API request URIs.

API resources

The Super SIM API comprises the following resources:

Resource Description
Sim Access individual SIMs.
Fleet Organize and configure groups of Sim resources.
Network Access cellular networks to which Super SIMs can connect.
Network Access Profile (NAP) Control which mobile networks Super SIMs can connect to.
NAP Network sub-resource Manage NAP-listed cellular networks.
UsageRecord Access Super SIM usage data.
SMS Commands Exchange machine-to-machine (M2M) messages via SMS

API resource properties

When you create or update resources, you indicate the data that is being added or changed by specifying the appropriate reasource property. All resource properties are case-sensitive and written in UpperCamelCase. For example, if you want to change a new Sim’s status from new to active and receive an asynchronous notification of the change, you call

curl https://supersim.twilio.com/v1/Sims/{Sim SID} \
  -d 'Status=active' \
  -d 'CallbackUrl={Your notification URI}'
  -u '{Account_Sid}:{Auth_Token}'

This contrasts with responses from the API, in which properties are referenced using lower_snake_case. For example, GET-ting that same Sim’s details will return:

{
  "sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "unique_name": "My SIM",
  "status": "new",
  "fleet_sid": null,
  "iccid": "89883070000123456789",
  "date_created": "2021-04-01T20:00:00Z",
  "date_updated": "2021-04-01T20:00:00Z",
  "url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

The API documentation presents the approapriate parameter formatting for the language or tool that you select in the code column.

If you use one of Twilio’s Helper Libraries or SDKs, properties’ cases may be different from those outlined above for the base API. The API documentation always shows the correct case for a given library.

API authentication

HTTP requests to the REST API are protected with HTTP Basic authentication. To learn more about how Twilio handles authentication, please refer to our security documentation.

You will use your Twilio Account SID as the username and your Auth Token as the password. For example, using the command line tool curl to get a list of your Sim resources, you would use:

curl https://supersim.twilio.com/v1/Sims \
  -u '{Account_Sid}:{Auth_Token}'

You can find your Account Sid and Auth Token in the Console.

To learn more about authentication and interaction with the Twilio REST API, see our documentation for requests to the API and Twilio’s response.

API request errors

Errors are signalled by 4xx and 5xx HTTP response status codes and a JSON response body. The error data is a standard Twilio structure. For example:

{
  "code": 20003, 
  "detail": "Your AccountSid or AuthToken was incorrect.", 
  "message": "Authentication Error - No credentials provided", 
  "more_info": "https://www.twilio.com/docs/errors/20003", 
  "status": 401
}

As you can see, the JSON gives you a human- and machine-readable indication of the nature (detail) and cause (message) of the error, and a reference to a more detailed description of the error in Twilio’s documentation. The value of code is a Twilio error code, and is referenced again in the more_info URL.

You can see a list of all such codes in the error code documentation and as a JSON file.

Asynchronous resources

Certain operations in the Super SIM API — such as changing a Sim’s status — are handled asynchronously. These operations will return an intermediate HTTP response — 202 Accepted — while the requested action completes in the background.

Requests that will be processed asynchronously allow you to specify a callback URL for Twilio to notify when the requested action has completed. A callback is sent to your server as either an HTTP POST or GET, according to your preference. Form parameters or query string parameters sent with the callback request describe the asynchronous outcome. Callback request formats are documented with each of the relevant API resources.

If your initial request completes synchronously, a 200 OK, 201 Created, or 204 No Content response will be returned and you should not expect an asynchronous callback, even if you specified a callback URL.

An event will be posted to your account’s Debugger in the Console with error details if Twilio doesn’t receive a success response from your callback URL.

Help integrating the Super SIM API

Twilio’s Super SIM API is a flexible building block which can take you from activating your first Super SIM to managing a fleet of millions of Super SIMs.

While we hope this page gives a good overview of what you can do with the API, we’re only scratching the surface of what the Super SIM API can do. For help troubleshooting the API, please check out Twilio’s debugging tools.

If you need any help integrating the Super SIM API or want to talk about best practices, please get in touch: just drop a line to support@twilio.com.

We can’t wait to see what you build!

Rate this page:
        
        
        

        Thank you for your feedback!

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

        Sending your feedback...
        🎉 Thank you for your feedback!
        Something went wrong. Please try again.

        Thanks for your feedback!

        Refer us and get $10 in 3 simple steps!

        Step 1

        Get link

        Get a free personal referral link here

        Step 2

        Give $10

        Your user signs up and upgrade using link

        Step 3

        Get $10

        1,250 free SMSes
        OR 1,000 free voice mins
        OR 12,000 chats
        OR more