The Microvisor API

Almost all URLs in the reference documentation use the following base URL:

https://microvisor.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 Microvisor 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 Device's unique name, you call:

1
curl https://microvisor.twilio.com/v1/Devices/{Device SID} \
2
  -d 'UniqueName=My Microvisor IoT Device'
3
  -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 Device's details will return:

1
{
2
  "sid": "UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
4
  "unique_name": "My Microvisor IoT Device",
5
  "logging_enabled": true,
6
  "date_logging_expires": ""2021-10-22T19:00:00Z",
7
  "app_update": null,
8
    "info", null,
9
  "status": "up-to-date",
10
  "date_created": "2021-10-21T19:00:00Z",
11
  "date_updated": "2021-10-21T20:00:00Z",
12
  "url": "https://microvisor.twilio.com/v1/Devices/UVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
13
}

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 Microvisor 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 Device resources, you would use:

1
curl https://microvisor.twilio.com/v1/Devices \
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 (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.

The Microvisor API is a flexible building block which can take you from working with your first Microvisor-empowered IoT device to managing a fleet of millions of such devices.

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 Microvisor API can do.