ThingSpace Connectivity Management API
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 aggregated 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. |
Firmware Upgrades
| Method | HTTP Request | Description |
|---|---|---|
| GET | /firmware/{account} | Get a list of available firmware for your devices. |
| POST | /upgrades | Schedule a firmware upgrade for a list of devices. |
| GET | /reports/{account}/status/{status} | View a list of upgrades with a specified status. |
| GET | /upgrades/{account}/upgrade/{upgradeId} | Get information about a specified upgrade. |
| PUT | /upgrades/{account}/upgrade/{upgradeId} | Add or remove devices from an upgrade. |
| DELETE | /upgrades/{account}/upgrade/{upgradeId} | Cancel a scheduled upgrade. |
Table of Contents
What’s new in the Connectivity Management API
Getting Started
Introduction to the Connectivity Management API
Getting Credentials to use the API
Working with Verizon Wireless
About Device IDs
About Device States
About Device Reachability
Working with eUICC Devices
Service Provisioning Rules
About Callback Services
ThingSpace Data Retention Policy
Data Types and Units of Measure
API Reference
Session Management
Start a Connectivity Management Session
End a Connectivity Management Session
Service Provisioning
Activate Service for Devices
Suspend Device Service
Restore Device Service
Deactivate Devices
Set Device to a Custom State
Get Request Status
Check Order Status
eUICC Devices
Download Device Profile
Enable Device Profile
Disable Device Profile
Delete Device Profile
EID Device Swap
Device Management
Add Devices
Check Device Availability
Delete Devices
Find Mismatched Hardware
Retrieve Device Information
Change Device Identifier
Change Device Cost Center Code
Change Device Custom Fields
Change Device Contact Info
Change Device Service Plan
Move Devices
Get Device Diagnostics Information
Retrieve Device Suspension Status
Retrieve Device PRL Information
Upload Devices
Device History
Retrieve Device Usage History
Retrieve Aggregated Device Usage History
Retrieve Device Connection History
Retrieve Device Provisioning History
Device Reachability Monitoring - Diagnostics
Monitor Device Reachability
Stop Device Reachability Monitoring
Retrieve Active Reachability Monitoring
Retrieve Reachability Status
Device Groups
Create a Device Group
Update a Device Group
Get a List of Device Groups
Get Device Group Information
Delete a Device Group
SMS Messaging
Send SMS Messages to Devices
Retrieve SMS Messages sent by Devices
Retrieve SMS Event History
Start Delivery of Queued SMS Messages
Callback Management
Register a Callback Listener
List Callback Listeners
Deregister a Callback Listener
Account Management
Retrieve Account Information
Retrieve Service Plans
Retrieve Account Lead Information
Get a List of Custom Services and States
Reset Your Connectivity Management Password
Retrieve list of registered device SKUs
Upload new device identifiers to the DMD
Segment Management
Set Usage Segmentation Labels
Remove Usage Segmentation Labels
Retrieve Billed Usage
Retrieve Billed Usage List