What's new

What’s New in the Connectivity Management API

It’s Time to Plan Your Move from CDMA to 4G

On December 31, 2019, Verizon plans to retire its CDMA network (1x/EVDO, 2G/3G). These are the major dates in that plan that you need to be aware of:

  • June 30, 2018 - We stopped activating new CDMA devices.
  • July 1, 2019 - We stopped allowing the following changes for CDMA devices:
    • Device ID change
    • MDN change
    • Price plan change
    • Suspend and Resume
  • December 31, 2019 - We will shut down the CDMA network.

Now is the time to start moving your solution to our 4G network. There are multiple 4G LTE options to choose from, including Category-1 and Category-M1 choices. These industry-leading, cost-competitive, advanced-technologies enable the development of next generation solutions on the 4G LTE network. Contact your Verizon account representative for more information.

7/11/19 - release 5.15

  • The POST /devices/actions/doanload_enable method has been enhanced to return an eUICC status of EXECUTED_WITHWARNING to identify those instances where a device profile downloaded successfully, but the enable failed. A second callback returning a eUICC status of EXECUTED_SUCCESS will be sent once the device has been enabled.

6/6/19 - release 5.14

  • Use the New POST /devices/actions/upload method to upload devices to the Verizon Device Management Database (DMD). The method returns an asynchronous response containing the list of devices submitted and a line level status for each.

5/28/19 - Cat-M SMS Upgrades

On May 28, 2019, Verizon enhanced the messaging features for Cat-M devices.

If you have deployed Cat-M devices on the Verizon network you are be able to send SMS messages to your distributed assets using any cloud server or device. If you prefer to disable the new feature, reach out to your account representative to discuss the restriction options that are available.

Explore more SMS options in the Quick API reference section.

5/2/19 - release 5.13

  • The POST /devices/actions/activate method has been enhanced to allow for an IP to be set during activation.

4/4/19 - release 5.12

  • The POST /devices/diagnostics/actions/list method has been enhanced to support 5 new device kinds (ICCID, ESN, MSISDN, MEID, IMEI). Prior to this release, the only device kind supported was MDN.
  • The PUT /devices/actions/goToState method has been enhanced to convert state names into their 2-digit state code equivalent and will split zip codes into separate zip and zip4 formats in the primaryPlaceOfUse parameter.

3/7/19 - release 5.11

  • The POST /devices/actions/list method has been enhanced to return all active promo codes associated with a device, when searching for a single device. Prior to this release, it returned a limited set of active promo codes. The promo codes are still returned as an extended attributes object.

2/7/19 - release 5.10

  • The new POST /devices/extendeddiagnostics/actions/list method returns extended diagnostic information about a specified device, including connectivity, provisioning, billing and location status. The /devices/diagnostics/actions/list endpoint is being deprecated.

1/3/19 - release 5.9

  • The POST /devices/diagnostics/actions/list response now includes information about the device firmware version and location, for accounts that are subscribed to those ThingSpace services.
  • The number of possible profile statuses for eUICC devices has been increased to distinguish between newly downloaded profiles and those that have been downloaded and then activated or deactivated. The statuses are in the responses to POST /devices/actions/list requests.

10/3/18 - release 5.6

  • The new POST /devices/diagnostics/actions/list API method returns basic diagnostic information about a specified device, including connectivity, provisioning, and billing status.
  • Customers applying for credit approval from Verizon can now start the device activation process while waiting for the approval. The POST /devices/actions/activate method now returns an “on hold” callback while approval is pending. If credit is not approved within one week, the method returns a “canceled” callback message.
  • We have replaced a generic error message with more specific error messages for several activation-related issues.

6/28/18 - release 5.4

  • You can use POST /devices/actions/list to find devices by matching a string against the first or last part of a device identifier, in addition to the existing option to match a string against any part of a device identifier.
  • You can now set a line’s customer name and address (Primary Place of Use) in the PUT /devices/actions/goToState request. The information can be used to contact the customer, if necessary, and the zip code will be used to determine tax jurisdiction.

5/2/18 - release 5.2

New and Updated Resources

  • POST /devices/actions/list A new filter parameter lets you search for devices by only providing part of a device identifier. For example, you could provide the last four characters of an ICCID instead of the entire ICCID. All devices that contain the provided string in their ICCIDs would be included in the response.
  • GET /accounts/{accountname}/requests/{requestID}/status Returns the processing status of a single-device asynchronous request.

3/7/18 - release 5.00

New and Updated Resources

  • GET /accounts/{accountname} New request that returns information about the specified account.

2/7/18 - release 4.23

New and Updated Resources

  • An account can now register for the PromoChanges callback to receive callback messages when promotional discounts are removed from devices.
  • POST /devices/actions/list now supports pagination of large result sets and ordering devices in responses by deviceId.
  • The names of the /devices/actions/contactInfo and /devices/actions/goToState endpoints have been changed to camel case.

1/4/18 - release 4.22

New and Updated Resources:

  • Get Device Suspension Status: POST /devices/suspension/status
  • Find Mismatched Hardware: POST /devices/actions/list/imeiiccidmismatch
  • Delete Devices: POST /devices/actions/delete
  • Change Primary Place of Use with PUT /devices/costCenter

Callback Changes

ThingSpace Connectivity Management API now supports these additional callbacks:

  • Resume Tracking Notification - advises when suspended devices will auto-resume to active service
  • External Provisioning Changes - advises when service changes are made in an account through a web portal or other non-API interface
  • Device Suspension Status - asynchronous responses to POST /devices/suspension/status requests
  • Service Plan Changes - asynchronous responses to PUT /devices/actions/plan requests

Additionally, all callback messages now include requestId, status, callbackCount, and maxCallbackTreshold values. Activation and deactivation callbacks now include stateName and serviceName objects. The usageResponse object has been removed from all callbacks except those that report device usage.

12/6/17 - release 4.21

New Resources:

  • Change Device Contact Information: PUT /devices/actions/contactinfo
  • Check if Devices can be Activated: POST /devices/availability/actions/list
  • Move Devices to Another Account: PUT /devices/actions/move
  • Set Devices to Customer-Defined Service and State: PUT /devices/actions/gotostate

New Name and Address Fields

Customer name and address information now includes fields for name suffix, ZIP+4, phone, phone type, and email address.

Updated on 2/12/2016

New Resource: /devices/connections/actions/listHistory

The /devices/connections/actions/list resource has been deprecated and replaced by /devices/connections/actions/listHistory. The “listHistory” resource has the same signature as the original resource, but it will return a 202 status code if there is more data, and the response has been changed from a JSON array to key:value pairs and includes a new hasMoreData parameter.

Updated on 1/15/2016

Consistent Camel Case for URL Paths

The paths for three resources have been changed to camel case capitalization for consistency:

  • /devices/costCenter
  • /devices/actions/customFields
  • /sms/{accountname}/startCallbacks

HTTP Status Code 202 and hasMoreData

Status code 202 for responses is now only used to indicate that the request was successful and there is more information to be retrieved. Those resources that can return a 202 response now also have a hasMoreData Boolean value in the response body.

These response structure for these requests was changed from a JSON array to key:value pairs to accomodate the hasMoreData parameter:

  • GET /sms/{accountname}/history
  • GET /groups/{accountname}/name/{gname}
  • GET /leads/{accountname}

HTTP 204 Responses Replaced with 200 and success=true

These requests that used to return an empty response for success (status code 204) have been changed to return status code 200, with a response body parameter of “success”: true.

  • POST /groups
  • PUT /groups/{accountname}/name/{gname}
  • DELETE /groups/{accountname}/name/{gname}
  • PUT /sms/{accountname}/startCallbacks