Menu

Expand
Rate this page:

Thanks for rating this page!

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

Super SIM API

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

Using this REST API, you can activate and deactivate Super SIMs, control the capabilties of Super SIMs, send machine-to-machine SMS using Commands, and query usage.

Super SIM API Base URL

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

https://supersim.twilio.com/v1

The Twilio Wireless REST 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.

Super SIM 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.

In short, you will use your Twilio Account SID as the username and your Auth Token as the password for HTTP Basic authentication with Twilio.

curl -G 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.

Asynchronous resources

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

Requests that will be processed asynchronously allow you to specify a callback URL for Twilio to notify when the request 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 REST 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 a callback URL was specified.

An event will be posted to your account’s Debugger in the Console with error details if Twilio does not 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 best practices, please get in touch. As this is a private beta, please contact mjackson@twilio.com directly if you need any help, or open a ticket with support@twilio.com and CC mjackson@twilio.com

We can’t wait to see what you build!

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.