ThingSpace Connectivity Management API

NOTE: There are new documentation pages that contains updated dynamic code generation & SDK downloads. You can access the new documents here.

life_cycle

The ThingSpace Connectivity Management API allows you to add and activate devices, check their status, monitor their usage, monitor their reachability for Data and SMS communication as well as their connection status, and perform other device connectivity management tasks through a RESTful API. You can use the API to add connectivity management to anything from small apps to enterprise software systems, such as enterprise resource planning (ERP), supply chain management and customer service management. The API provides a secure, standards-compliant REST interface to the web services at the ThingSpace Data Center.

You can also view and manage devices by logging in to the ThingSpace Manage portal available through your Verizon Enterprise Solutions, Verizon My Business, or your ThingSpace IoT Developers Marketplace account.

ThingSpace Connectivity Management API for ThingSpace IoT Developers

After completing the steps in the “Getting Started with ThingSpace APIs” in the Getting Started section, you can use Connectivity Management APIs to do the following:

Start and end Connectivity Management sessions
Activate, deactivate, and delete devices
Retrieve device usage history
Send and retrieve SMS messages
Register callback URLs
Get account information
Get device location and location reports
Schedule firmware upgrades

A complete list of supported Connectivity Management and Device APIs for ThingSpace for IoT Developers follows. Click the HTTP Request link to view reference material for the API, including request body and response examples.

Session Management

Method	HTTP Request	Description
POST	/session/login	Start a Connectivity Management session.
POST	/session/logout	End a Connectivity Management session.
PUT	/session/password/actions/reset	Get a new ConnectivityM Management API password.

Device Service Provisioning and Management

Method	HTTP Request	Description
POST	/devices/actions/activate	Activate service for devices.
POST	/devices/actions/deactivate	Deactivate service for devices.
POST	/devices/actions/delete	Delete deactivated devices.
POST	/devices/actions/list	Get detailed information about devices.
POST	/devices/prl/actions/list	Get current PRL version from devices.
PUT	/devices/actions/{serviceType}/actions/deviceId	Swap devices. Only ChangeIMEI, ChangeICCID, and ChangeIMEIandICCID Change4GOptions are supported.
POST	/devices/extendeddiagnostics/actions/list	Get basic diagnostic information about a specified deviceConnectivity and Service History.
POST	devices/usage/actions/list	Retrieve device usage history.
POST	/devices/usage/actions/list/aggregate	Retrieve aggregate device usage history.
POST	/devices/history/actions/list	Retrieve device provisioning history.
POST	/devices/connections/actions/listHistory	Retrieve device connection history.

Service Plan

Method	HTTP Request	Description
GET	/plans/{accountname}	Get a list of service plans in an account.

SMS

Method	HTTP Request	Description
POST	/sms	Send an SMS message to devices.
GET	/sms/{accountname}/history	Retrieve SMS messages sent by devices.
PUT	/sms/{accountname}/startCallbacks	Start delivery of queued SMS messages.

Callbacks

Method	HTTP Request	Description
POST	/callbacks	Register a callback listener URL.
GET	/callbacks	Get a list of registered callback listener URLs.
DELETE	/callbacks	Delete a callback listener URL.

Accounts and Leads

Method	HTTP Request	Description
GET	/accounts	Get information about an account.
POST	/accounts/{accountname}/sku	Retrieve list of registered device SKUs.
POST	/devices/actions/upload	Upload new device identifiers to the DMD.

Find Device Locations

Method	HTTP Request	Description
POST	/locations	Find the locations of up to 20 devices. (synchronous)
POST	locationreports	Create a report of device locations. (asynchronous)
GET	locationreports/{account}/report/{txid}/index/{startindex}	Retrieve a device location report.
GET	locationreports/{account}/report/{txid}/status	Get the status of a device location report.
DELETE	locationreports/{account}/report/{txid}	Cancel a queued device location report.

What’s new in the Connectivity Management API

ThingSpace Connectivity Management API

ThingSpace Connectivity Management API for ThingSpace IoT Developers

Session Management

Device Service Provisioning and Management

Service Plan

SMS

Callbacks

Accounts and Leads

Find Device Locations

Table of Contents

Getting Started

Working with Verizon Wireless

API Reference