domesticUsage
and internationalUsage
parameters for RTR customers, when applicable.subscriptionTypeCode
, subscriptionTypeCodeDesc
, stageStateChangeReasonCode
, and stageStateChangeReasonCodeDesc
.ServiceStateStartDate
for State customers.name
parameter in the request body. sname
parameter in the request body. We are deploying enhancements and transition of our cloud infrastructure. In order for us to keep the transition as seamless as possible and for you to take advantage of the enhancements, it is important for you to whitelist these additional IP addresses by October 6, 2020.
The additional white-listing provides a way for callback messages originating from these new IP addresses to reach you through your firewalls.
NOTE: If you do not whitelist these IP addresses, you wil not be able to receive callbacks!
The 6 new IP addresses are:
However, DO NOT remove the old IP addresses yet, which are:
We are in the middle of enhancing and transitioning our cloud infrastructure. In order for us to keep the transition as seamless as possible and for you to take advantage of the enhancements, it is important for you to whitelist these additional IP addresses by August 14, 2020.
The additional white-listing provides a way for callback messages originating from these new IP addresses to reach you through your firewalls.
The 6 new IP addresses are:
However, DO NOT remove the old IP addresses yet, which are:
As of September 1, 2020, the Verizon Media Platform (EdgecastCDN) will no longer support TLS 1.0 and TLS 1.1 protocols. Only TLS 1.2 and TLS 1.3 will be supported.
The way you communicate with our ThingSpace APIs will be impacted and you will not be able to use ThingSpace services unless you upgrade to TLS1.2 or TLS 1.3. Errors that you can expect to receive from our APIs are HTTP status codes in the 2xx class, which indicate the request does not support the HTTP protocol version used.
If this impacts you, please make the appropriate changes to your code to use the supported protocols by September 1, 2020, to avoid disruption of your applications.
Connectivity management APIs now include API functions to monitor Data and SMS reachability and LTE network connection status of 4G devices. These functions are made available through the Service Capability Exposure Function (SCEF) of the Verizon LTE core network. Monitoring of Data/SMS reachability and connection status of 4G devices provides a significant value add for developing efficient enterprise applications with CAT M and NB IOT devices which are designed to conserve battery power by periodically becoming unreachable for potentially long periods of time and reachable for short “active” durations for transfer of meaningful IOT information such as sensor readings, metering data readings, diagnostic information, etc. These APIs allow a calling application to register for getting callback notifications when the relevant events occur, for a period of up to 10 years. They can also be used in a single query-response mode for an application interested in determining the immediate (now) reachability of a device for Data or SMS communications.
The new Retrieve SMS Event History API allows you to get the history of mobile-originated/mobile-terminated SMS messages for a single device that were sent or received via ThingSpace, within a specified time period.
The Monitor Device Reachability API was updated to include a MaxUEAvailabilityTime
parameter in the callback when the device is in a reachable state. The parameter displays a timestamp (UTC) until which a device using a power-saving mechanism is expected to be reachable for SMS Delivery.
The Upload Devices API was updated to make the accountName
an optional parameter in the request body. If you have access to only one account, accountName is not required. If you have access to multiple accounts, then the accountName is required.
The Deactivate Devices API was updated to include a deleteAfterDeactivation
parameter in the request body. Set this parameter to “true” if you want to delete the device from the database after it has been deactivated.
The new SetUsageSegmentationLabels API allows you to associate your own usage segmentation label with a device.
The new RemoveUsageSegmentationLabels API allows you to remove the segmentation label associated with a device.
The new RetrieveBilledUsage API allows you to get billing usage for a customer segment for a specified billing cycle, or the most recent billing cycle if one is not specified.
Verizon has retired its CDMA network (1x/EVDO, 2G/3G) to 4G as of December 31, 2019.
Contact your Verizon account representative for more information.
POST /devices/actions/download_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.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.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.
POST /devices/actions/activate
method has been enhanced to allow for an IP to be set during activation.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.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.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.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.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.POST /devices/actions/list
requests.POST /devices/diagnostics/actions/list
API method returns basic diagnostic information about a specified device, including connectivity, provisioning, and billing status.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.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.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.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.GET /accounts/{accountname}
New request that returns information about the specified account.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./devices/actions/contactInfo
and /devices/actions/goToState
endpoints have been changed to camel case.POST /devices/suspension/status
POST /devices/actions/list/imeiiccidmismatch
POST /devices/actions/delete
PUT /devices/costCenter
ThingSpace Connectivity Management API now supports these additional callbacks:
POST /devices/suspension/status
requestsPUT /devices/actions/plan
requestsAdditionally, 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.
PUT /devices/actions/contactinfo
POST /devices/availability/actions/list
PUT /devices/actions/move
PUT /devices/actions/gotostate
Customer name and address information now includes fields for name suffix, ZIP+4, phone, phone type, and email address.
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.
The paths for three resources have been changed to camel case capitalization for consistency:
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:
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.