The Super SIM API

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.

The Super SIM API comprises the following resources:

When you create or update resources, you indicate the data that is being added or changed by specifying the appropriate resource 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:

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

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

1
{
2
  "sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
4
  "unique_name": "My SIM",
5
  "status": "new",
6
  "fleet_sid": null,
7
  "iccid": "89883070000123456789",
8
  "date_created": "2021-04-01T20:00:00Z",
9
  "date_updated": "2021-04-01T20:00:00Z",
10
  "url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
11
}

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

HTTPS requests made to the Super SIM 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:

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

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

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

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

As you can see, the JSON gives you a human- and machine-readable indication of the nature (the detail key) 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.

Many errors are generic to platform — the one shown above, for example. However, Super SIM-specific error codes are in the range 83000-83999.

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

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.

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.

If you need any help integrating the Super SIM API or want to talk about best practices, please get in touch. You can contact Twilio Support through the Console or Help Center.

We can't wait to see what you build!