Wireless REST API

The Programmable Wireless REST API enables you to manage the connectivity of real-world wireless devices using a Twilio SIM.

API Base URL

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

https://wireless.twilio.com/v1

All requests to the Wireless REST API are served over HTTPS. Unencrypted HTTP is not supported.

All responses are provided in json format. There is no need to use the .json file extension in API request URIs.

Authentication

HTTP requests to the REST API are protected with HTTP Basic authentication like other REST APIs provided by Twilio. 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 Twilio Auth Token as the password for HTTP Basic authentication.

curl -G https://wireless.twilio.com/v1/Sims \
    -u '{Account Sid}:{Auth Token}'

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

Twilio Helper Libraries

Using the Twilio server-side SDKs ('helper libraries') with Programmable Wireless is described on the Helper Libraries page.

Asynchronous Resources

Certain operations in the Wireless REST API – such as changing the status of a SIM – can take considerable time to complete (anywhere from a few seconds to a minute or more). 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 depending on 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 with error details if Twilio does not receive a success response from your callback URL.

Resources

The resources exposed by the Wireless REST API are:

Resource Description
Sims A Sim instance represents a physical SIM (Subscriber Identity Module) that is capable of connecting to a wireless network.
Commands A Command represents a machine-to-machine SMS message.
Rate Plans A Rate Plan describes the capabilities and restrictions that will apply to any number of SIMs associated with the Rate Plan.
SIM Usage Records The SIM Usage Records list resource enables you to query the usage of a SIM along multiple dimensions by providing query filters.
SIM Data Sessions The SIM Data Sessions list resource returns Data Session information for a SIM over no more than a 30 day period, presented as an aggregated list.

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.