Menu

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?

Programmable Wireless: REST API

Twilio's Programmable Wireless REST API enables you to programatically manage global fleets of cellularly connected IoT devices.

Using this REST API, you can:

Base URL

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

https://wireless.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.

Wireless API Authentication

HTTP requests to the REST API are protected with HTTP Basic authentication. To learn more about how Twilio handles authentication, see our security documentation. You use your Twilio Account SID as the username and your 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.

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

Twilio server-side SDKs (Helper Libraries)

You can learn how to use the Twilio server-side SDKs (Helper Libraries) with Programmable Wireless in a variety of popular server-side programming languages on the SDKs section of the Twilio Docs.

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 in the Console with error details if Twilio does not receive a success response from your callback URL.

Resources

The following lists the resources exposed by the Wireless REST API.

Resource Description
Account Usage Record
The Usage Records list resource enables you to query the combined usage for all of the SIMs on your account along multiple dimensions by providing query filters.
Command A Command represents a machine-to-machine SMS message.
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.
RatePlan A Rate Plan describes the capabilities and restrictions that will apply to any number of SIMs associated with the Rate Plan.
SIM A Sim resource represents a physical SIM (Subscriber Identity Module) that is capable of connecting to a wireless network.
SIM Usage Record The SIM Usage Records list resource enables you to query the usage of a SIM along multiple dimensions by providing query filters.
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.