Standard APIsConnectivity Management
Quick API Reference
Connectivity Management Quick APIs Reference
This API reference is organized by functional area, which generally equates to resource type.
Device Management
| Method | HTTP Request | Description |
|---|---|---|
| POST | /m2m/v1/devices/actions/activate | If the devices do not already exist in the account, this API resource adds them before activation. |
| POST | /m2m/v1/devices/actions/add | Use this API if you want to manage some device settings before you are ready to activate service for the devices. |
| POST | /m2m/v1/devices/history/actions/list | Shows the provisioning history of a specified device. |
| PUT | /m2m/v1/devices/actions/contactinfo | Sends a CarrierService callback message for each device in the request when the contact information has been changed, or if there was a problem and the change could not be completed. |
| PUT | /m2m/v1/devices/actions/customFields | Sends a CarrierService callback message for each device in the request when the custom fields have been changed, or if there was a problem and the change could not |
| POST | /m2m/v1/devices/actions/deactivate | Deactivating service for a device may result in an early termination fee (ETF) being charged to the account, depending on the terms of the contract with Verizon. If your contract allows ETF waivers and if you want to use one for a particular deactivation, set the etfWaiver value to True. |
| POST | /m2m/v1/devices/actions/delete | Use this API to remove unneeded devices from an account. |
| POST | /m2m/v1/devices/actions/list | Returns information about a single device or information about all devices that match the given parameters. Returned information includes device provisioning state, service plan, MDN, MIN, and IP address. |
| POST | /m2m/v1/devices/actions/list/imeiiccidmismatch | Returns a list of all 4G devices with an ICCID (SIM) that was not activated with the expected IMEI (hardware) during a specified time frame. |
| PUT | /m2m/v1/devices/actions/move | Move active devices from one billing account to another within a customer profile. |
| PUT | /m2m/v1/devices/actions/gotostate | Changes the provisioning state of one or more devices to a specified customer-defined service and state. |
| PUT | /m2m/v1/devices/actions/plan | Changes the service plan for one or more devices. |
| POST | /m2m/v1/devices/actions/suspend | Suspends service for one or more devices. |
| POST | /m2m/v1/devices/actions/restore | Restores service to one or more suspended devices. |
| POST | /m2m/v1/devices/availability/actions/list | Checks whether specified devices are registered by the manufacturer with the Verizon network and are available to be activated. |
| POST | /m2m/v1/devices/connections/actions/listHistory | Each response includes a maximum of 500 records. To obtain more records, you can call the API multiple times, adjusting the earliest value each time to start where the previous request finished. |
| PUT | /m2m/v1/devices/costCenter | Changes or removes the CostCenterCode value or customer name and address (Primary Place of Use) for one or more devices. |
| POST | /m2m/v1/devices/extendeddiagnostics/actions/list | Returns extended diagnostic information about a specified device, including connectivity, provisioning, billing and location status. |
| POST | /session/password/actions/reset | Returns a new, randomly generated password for the current username. |
| POST | /m2m/v1/devices/prl/actions/list | 4G and GSM devices do not have a PRL. |
| POST | /m2m/v1/devices/suspension/status | Returns DeviceSuspensionStatus callback messages containing the current device state and information on how many days a device has been suspended and can continue to be suspended. |
| POST | /m2m/v1/devices/usage/actions/list | Returns the network data usage history of a device during a specified time period |
| POST | /m2m/v1/devices/usage/actions/list/aggregate | The information is returned in a callback response, so you must register a URL for DeviceUsage callback messages using the POST /callbacks API. |
| PUT | /m2m/v1/devices/{serviceType}/actions/deviceId | Changes the identifier of a 3G or 4G device to match hardware changes made for a line of service. Use this request to transfer the line of service and the MDN to new hardware, or to change the MDN. |
eUICC and Devices
| Method | HTTP Request | Description |
|---|---|---|
| Working with eUICC Devices | Reference and guidelines for working with embedded Universal Integrated Circuit Card (eUICC) devices. | |
| POST | /m2m/v1/devices/profile/actions/profile_resume | Re-enabling or Resuming an eUICC profile after it was suspended. The API Reference page is here. |
| POST | /m2m/v1//devices/profile/actions/profile_suspend | Suspend the use of an eUICC profile. The API Reference page is Here. |
Accounts
| Method | HTTP Request | Description |
|---|---|---|
| GET | /m2m/v1/accounts/{aname} | Returns information about a specified account. |
| GET | /m2m/v1/accounts/{aname}/statesandservices | Returns a list and details of all custom services and states defined for a specified account. |
| GET | /m2m/v1/leads/{aname} | When HTTP status is 202, a URL will be returned in the Location header of the form /leads/{aname}?next={token}. This URL can be used to request the next set of leads. |
Device Groups
| Method | HTTP Request | Description |
|---|---|---|
| POST | /m2m/v1/groups | Create a new device group and optionally add devices to the group. Device groups can make it easier to manage similar devices and to get reports on their usage. |
| GET | /m2m/v1/groups/{aname} | Returns a list of all device groups in a specified account. |
| GET | /m2m/v1/groups/{aname}/name/{gname} | When HTTP status is 202, a URL will be returned in the Location header of the form /groups/{aname}/name/{gname}/?next={token}. This URL can be used to request the next set of groups. |
| PUT | /m2m/v1/groups/{aname}/name/{gname} | Make changes to a device group, including changing the name and description, and adding or removing devices. |
| DELETE | /m2m/v1/groups/{aname}/name/{gname} | Deletes a device group from the account. Devices in the group are moved to the default device group and are not deleted from the account. |
SMS
| Method | HTTP Request | Description |
|---|---|---|
| POST | /m2m/v1/sms | The messages are queued on the ThingSpace Platform and sent as soon as possible, but they may be delayed due to traffic and routing considerations. |
| GET | /m2m/v1/sms/{aname}/history | When HTTP status is 202, a URL will be returned in the Location header of the form /sms/{aname}/history?next={token}. This URL can be used to request the next set of messages. |
| PUT | /m2m/v1/sms/{aname}/startCallbacks | Tells the ThingSpace Platform to start sending mobile-originated SMS messages through the EnhancedConnectivityService callback service. SMS messages from devices are queued until they are retrieved by your application, either by callback or synchronously with GET /sms/{accountName}/history. |
Connectivity Callbacks
| Method | HTTP Request | Description |
|---|---|---|
| GET | /m2m/v1/callbacks/{aname} | Returns the name and endpoint URL of the callback listening services registered for a given account. |
| POST | /m2m/v1/callbacks/{aname} | You are responsible for creating and running a listening process on your server at that URL. |
| DELETE | /m2m/v1/callbacks/{aname}/name/{sname} | Stops ThingSpace from sending callback messages for the specified account and service. |
Account Requests
| Method | HTTP Request | Description |
|---|---|---|
| GET | /m2m/v1/accounts/{aname}/requests/{requestId}/status | Returns the current status of an asynchronous request that was made for a single device. |
Service Plans
| Method | HTTP Request | Description |
|---|---|---|
| GET | /m2m/v1/plans/{aname} | Returns a list of all data service plans that are associated with a specified billing account. When you send a request to /devices/actions/activate to activate a line of service you must specify the code for one of the service plans associated with your account. |
Device Diagnostics
| Method | HTTP Request | Description |
|---|---|---|
| POST | https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/api-endpoints/connectivity-callbacks/register-callback/api-reference | These device reachability API’s require a callback to be registered using the DiagnosticService service |
| POST | /m2m/v1/diagnostics/basic/devicereachability/status | Requests for status of device based on the request type. |
| POST | /m2m/v1/diagnostics/basic/devicereachability/monitors | Retrieve all the active monitors. |