POST /devices/extendeddiagnostics/actions/listReturns extended diagnostic information about a specified device, including connectivity, provisioning, billing and location status.
See also:
Get Device Information
POST https://thingspace.verizon.com/api/m2m/v1/devices/extendeddiagnostics/actions/listNone.
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization required |
string | HTTP Authorization bearer token. |
| VZ-M2M-Token required |
string | A valid session token returned by POST /session/login. |
| Content-Type required |
string | Must be application/json. |
Specify the account name and device ID in the body of the request.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName required |
string | The Verizon billing account that the device belongs to. An account name is usually numeric, and must include any leading zeros. |
| deviceList required |
deviceId object | The device for which you want diagnostic information, specified by the device’s MDN. |
| deviceList.kind required for deviceList |
string | The type of the device identifier. This could be one of the following:
|
| deviceList.id required for deviceList |
string | The numeric or alpha-numeric value of the Kind listed above. |
{
"accountName": "0000123456-00001",
"deviceList": [
{
"id": "10-digit MDN",
"kind": "mdn"
}
]
}
Status 200
The response includes various types of information about the device, grouped into categories. Each category object contains the category name and a list of Extended Attribute objects as key-value pairs.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| EID ICCID IMEI IMSI MDN MIN MSISDN |
The value of the specified device identifier type. |
Various information about the device.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| AccountName | The account that the device belongs to. |
| BundleSku | The name of the service bundle that the device is enrolled in. |
| DeviceMake | The device manufacturer. |
| DeviceModel | The device model name. |
| DeviceSku | The SKU of the device model. |
| DiagnosticsEligibility | Whether this device is eligible for LWM2M diagnostics streaming. |
| DiagnosticsSKUName | Diagnostics Stock Keeping Unit (SKU) name available for this line |
| FeatureCodes | List of numeric codes of features applied to the device. |
| FeatureNames | List of names of the features applied to the device. |
| FeatureTypes | IP address pool type and other features. |
| GroupName | The device group that the device belongs to. |
| MCC | Mobile Country Code, showing which country a device is registered in. |
| ModemGeneration | This will show either 4G or 5G, based on what is certified in Verizon’s Device Management Database (DMD). |
| ModemType | An extended definition of modem generation, per the Verizon Device Management Database (DMD). |
| MNC | Mobile Network Code, showing which network a device is connected to. |
| RatePlanName | The service plan that the device is assigned to. |
| RatePlanDescription | The description of the service plan. |
| ServicePlanType | Based on the type of IP assignment. For example: Public Dynamic IP, Public Static IP, Private IP, etc. |
The current service state of the device, and dates of recent service changes.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| CreatedAt | The date and time that the device was added to the system. |
| LastActivationBy | The user who last activated the device. |
| LastActivationDate | The date and time that the device was last activated. |
| LastDateSuspended | The most recent date that a service suspension was started. |
| ResumeDate | The date that the device will auto-resume based on the suspend reason code, the account contract, and the number of days that it has already been suspended in the last 12 months. |
| DeviceState | The current service state of the device, which will be one of these values:
|
The device’s current connection and roaming status.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| Connected | True if the device is connected; false if it is not. |
| IPAddress | The IP address of the device. |
| NetworkIdentity | The device’s current base station ID. |
| RoamingStatus | True if the device is currently roaming. |
| RoamingCountry | The name of a country if RoamingStatus = true, or empty if false. |
| LastConnectionDate | The most recent date and time that the device connected to the network. |
| LastDisconnectDate | The most recent date and time that the device disconnected from the network. |
Information related to the device’s billing cycle.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| BillingCycleStartDate | .The date and time that the device’s current billing cycle starts. |
| BillingCycleEndDate | The date and time that the device’s current billing cycle ends. |
| DefaultRatePlan | Future development |
Data and SMS usage.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| CurrentRatedUsageRecordDate | Timestamp of when the record of usage started. |
| CurrentBillCycleDataRatedUsage | Data usage in the units defined by the price plan. |
| CurrentBillCycleRatedSMSUsage | The number of SMS messages sent and received. |
| CurrentUnRatedUsageRecordDate | Timestamp of when the most recent unrated usage record was made. |
| CurrentBillCycleDataUnRatedUsage | Total of unrated usage for the current billing cycle. |
| PromoDataUsage | Data usage during a promotional period, if applicable. |
| PromoDataUsagePercent | Percentage of the promotional allowance of data usage consumed. |
| AaaPromoDataUsage | Data usage during a promotional period for "Triple A" rated data. |
| RtrPromoDataUsage | Real Time Rating data used during a promotional period. |
| InternationalRoamingUsage | Data used while the device was outside of the domestic United States. |
| CurrentBillCycleDataUsage | The sum of all data, in bytes, that the device sent or received since the beginning of the current bill cycle. |
| CurrentBillCycleSMSUsage | The sum of all SMS usage since the beginning of the current bill cycle. This number includes all SMS messages sent by the device and all acknowledged messages sent to the device. |
Device location information (subscription required).
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| LocationSkuName | The name of the service bundle for the Device Location Service. |
| LastLocationUpdate | The last time the device was located. |
| Latitude | The last reported latitude of the device, in decimal degrees. |
| Longitude | The last reported longitude of the device, in decimal degrees. |
| LastLocationAttemptDate | Timestamp of the most recent attempt to locate the device. |
| LastLocationStatus | Results of the last location attempt. |
Device firmware information (subscription required).
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| FotaCurrentFirmwareVersion | The firmware version that is currently on the device. |
| FotaCampaignDateOccurred | The date and time of the last firmware update. |
| FotaSku | The name of the service bundle for the Software Management (FOTA) Service. |
| FotaMake | Manufacturer of communications module (modem) inside host device. |
| FotaModel | Model name of communications module (modem) inside host device. |
| FotaProtocol | Modem firmware protocol. This will be:
|
Contact and Address information provided during the activation, plan change, or contact info change. Known in Verizon as the device's primary place of use. Note: this is not necessarily the Location of the device. Use the Device Location service to audit the location and compare it to the Primary Place of Use.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| CustomerFirstName | The customer’s first name. Valid values are any string of up to 20 alphanumeric characters, space, dash, exclamation point, and pound sign. |
| CustomerLastName | The customer’s last name. Valid values are any string of up to 25 alphanumeric characters, space, dash, exclamation point, and pound sign. |
| CustomerAddressLine1 | The street address for the line’s primary place of use. This must be a physical address; it cannot be a P.O. box. |
| CustomerAddressCity | The city for the line’s primary place of use. |
| CustomerAddressState | The two-letter abbreviation of the state for the line’s primary place of use. To see examples of the two-letter codes (i.e. TX for Texas), please see the Wikipedia page on ISO-3166-2:US. |
| CustomerAddressZipCode | The 5-digit ZIP code for the device's primary place of use. |
| CustomerCountry | “USA” for the country of the device's primary place of use. |
| CustomerPpuLatitude | The Geo-coded Latitude for the Primary Place of Use Address in decimal degrees (-90 to 90 degrees). |
| CustomerPpuLongitude | The Geo-coded Longitude for the Primary Place of Use Address in decimal degrees (-180 to 180 degrees). |
Information about the device's SIM Secure profile.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| Future development |
Real Time Rating information.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| RTRUnRatedDataUsage | The amount of unrated data used for Real Time Rating. |
| RTRUnRatedDataUsageDate | The Timestamp of when this usage occurred. |
Private Mobile Edge Compute information.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| IsPmec | This flag indicates if the account is PMEC (true) or not PMEC (false). |
Connection quality information for devices.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| CellID | Cell ID observed at the time of streaming. |
| CellIDUpdatedDate | The date and time of the Cell ID update. |
| CellIDStreamStatus | The status of the diagnostic observation. Valid values include:
|
| CellIDIntervalInSeconds | Specified Cell ID streaming interval for diagnostic observation. |
| CellIDDurationInSeconds | Specified Cell ID streaming duration for diagnostic observation. |
| LinkQuality | Cellular link quality, in db. |
| LinkQualityUpdatedDate | The date and time of the LinkQuality measurement. |
| LinkQualityStreamStatus | The status of the diagnostic observation. Valid values include:
|
| LinkQualityIntervalInSeconds | Specified Link Quality streaming interval for diagnostic observation. |
| LinkQualityDurationInSeconds | Specified Link Quality streaming duration for diagnostic observation. |
| RadioSignalStrength | Cellular signal strength, in dbm. |
| RadioSignalStrengthUpdatedDate | The date and time of the RadioSignalStrength measurement. |
| RadioSignalStrengthStreamStatus | The status of the diagnostic observation. Valid values include:
|
| RadioSignalStrengthIntervalInSeconds | Specified Radio Signal Strength streaming interval for diagnostic observation. |
| RadioSignalStrengthDurationInSeconds | Specified Radio Signal Strength streaming duration for diagnostic observation. |
| ModemCurrentHardwareVersion | Modem Current Hardware Version. |
| ModemCurrentFirmwareVersion | Modem Current Firmware Version. |
| ModemCurrentSoftwareVersion | Modem Current Software Version. |
| AvailablePowerSources | Available power sources of the device. More than one of this field may be returned depending on the device:
|
| BatteryLevelandStatus | Contains the current battery level as a percentage (with a range from 0 to 100). This value is only valid when the value of Available Power Sources Resource is 1. |
| BatteryLevelDate | The date and time of the battery level log. |
| AvailableNetworks | Available Network Bearers including LTE. |
| NetworkBearer | Network Bearer such as LTE or 5G.. The value returned will be numeric and valid values are: 0: GSM cellular network |
| NetworkBearerUpdateDate | The date and time when the Network Bearer Information was logged. |
| NetworkBearerStreamStatus | The status of the diagnostic observation. Valid values include:
|
| NetworkBearerIntervalInSeconds | Specified Network Bearer streaming interval for diagnostic observation. |
| NetworkBearerDurationInSeconds | Specified Network Bearer streaming duration for diagnostic observation. |
| PSMTimer | The sleep duration in Power Save Mode. |
| ActiveTimer | The duration for which the device is reachable (via paging) in a Power Save Mode sleep cycle. |
| eDRXTimer | The total time of the extended DRX sleep cycle. |
| PagingTimeWindow | Duration for which Device will wake up, look for pages periodically in an extended DRX sleep cycle and then go to sleep again. |
Information about the device's battery.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| BatteryLevel | A value of "0" to "100" to show the battery's state of charge as a percentage. |
Reboot information for LWM2M devices.
| Extended Attribute Key | Extended Attribute Value Description |
|---|---|
| DeviceRebootStatus | Status of a reboot request. When a request is made, the status will show: "REBOOT_QUEUED" |
| DeviceRebootStatusDate | Timestamp of when the reboot request was made. |
| DeviceRebootStatusErrorCode | If there is an error with the request, the error will show here. An error example would be: "DEVICE_UNREACHABLE". |
| DeviceRebootStatusErrorDescription | A description of what the error is. An example for "DEVICE_UNREACHABLE"would be: "Device not reachable, request will send to device once it become available". |
{
"accountName":"0000123456-00001",
"deviceList":[
{
"id":"15-digit IMEI",
"kind":"imei"
}
],
"categories":[
{
"categoryName":"DeviceIdentifier",
"extendedAttributes":[
{
"key":"ICCID",
"value":"20-digit ICCID"
},
{
"key":"IMEI",
"value":"15-digit IMEI"
},
{
"key":"IMSI",
"value":"15-digit IMSI"
},
{
"key":"MDN",
"value":"10-digit phone number"
},
{
"key":"MIN",
"value":"10-digit phone number"
},
{
"key":"MSISDN",
"value":"1+ 10-digit phone number"
}
]
},
{
"categoryName":"DeviceAttributes",
"extendedAttributes":[
{
"key":"AccountName",
"value":"0000123456-00001"
},
{
"key":"GroupName",
"value":"Default: 0000123456-00001"
},
{
"key":"DeviceSku",
"value":"VZW080000100112"
},
{
"key":"CustomFields1",
"value":"5G SA FWA site"
},
{
"key":"ServicePlanType",
"value":"Public Dynamic"
},
{
"key":"FeatureCodes",
"value":"84777,86112"
},
{
"key":"FeatureNames",
"value":"84777,86112"
},
{
"key":"FeatureTypes",
"value":"4G PUBLIC DYNAM IP DSS STREAM,5G IPV/IPV6 IP"
},
{
"key":"BundleSku",
"value":"TSS-IOT-INTELLIGENCE-CUSTOM"
},
{
"key":"RatePlanCode",
"value":"5GBI100MBPS"
},
{
"key":"DeviceMake",
"value":"ODI"
},
{
"key":"DeviceModel",
"value":"DIGI - EX50-WXS6-GLB"
},
{
"key":"ModemGeneration",
"value":"5G"
},
{
"key":"4GDeviceDetectionDate",
"value":"2024-09-25T22:18:07Z"
},
{
"key":"Services",
"value":"null"
},
{
"key":"ModemType",
"value":"5GE"
},
{
"key":"DiagnosticsEligibility",
"value":"StreamEligible"
},
{
"key":"DiagnosticsSKUName",
"value":"TSS-IOT-INTLG-CUSTOM-DIAG-LWM2M"
},
{
"key":"AvailableNetworks",
"value":"6"
},
{
"key":"ModemCategory",
"value":"IoT Module"
}
]
},
{
"categoryName":"Provisioning",
"extendedAttributes":[
{
"key":"LastActivationBy",
"value":"Verizon, User"
},
{
"key":"LastActivationDate",
"value":"2024-09-25T00:10:24Z"
},
{
"key":"CreatedAt",
"value":"2024-09-24T20:56:12Z"
},
{
"key":"DeviceState",
"value":"active"
},
{
"key":"LastDeactivationDate",
"value":"2024-09-25T00:05:21Z"
}
]
},
{
"categoryName":"Connectivity",
"extendedAttributes":[
{
"key":"Connected",
"value":"false"
},
{
"key":"IPAddress",
"value":"10.0.0.0"
},
{
"key":"APN1",
"value":"V5GA01INTERNET"
},
{
"key":"APN2",
"value":"vzwclass6"
}
]
},
{
"categoryName":"Billing",
"extendedAttributes":[
{
"key":"BillingCycleStartDate",
"value":"2024-09-25T12:00:00Z"
},
{
"key":"BillingCycleEndDate",
"value":"2024-09-25T12:00:00Z"
},
{
"key":"DefaultRatePlan",
"value":"0"
}
]
},
{
"categoryName":"Usage",
"extendedAttributes":[
{
"key":"CurrentRatedUsageRecordDate",
"value":"2024-09-25T00:00:00Z"
},
{
"key":"CurrentBillCycleDataRatedUsage",
"value":"0"
},
{
"key":"CurrentBillCycleRatedSMSUsage",
"value":"0"
},
{
"key":"PromoSmsUsage",
"value":"0"
},
{
"key":"PromoSmsUsagePercent",
"value":"0"
},
{
"key":"PromoDataUsage",
"value":"0"
},
{
"key":"PromoDataUsagePercent",
"value":"0"
},
{
"key":"AaaPromoDataUsage",
"value":"0"
},
{
"key":"RtrPromoDataUsage",
"value":"0"
},
{
"key":"InternationalRoamingUsage",
"value":"0"
}
]
},
{
"categoryName":"Location",
"extendedAttributes":[
{
"key":"LocationSkuName",
"value":"TSS-IOT-INTLG-CUSTOM-LOC-COARSE"
},
{
"key":"LastLocationUpdate",
"value":"2024-06-17T16:23:14Z"
},
{
"key":"Latitude",
"value":"33.122153"
},
{
"key":"Longitude",
"value":"-96.641825"
},
{
"key":"LastLocationAttemptDate",
"value":"2024-09-25T16:23:14Z"
},
{
"key":"LastLocationStatus",
"value":"122"
}
]
},
{
"categoryName":"FOTA",
"extendedAttributes":[
{
"key":"FotaCurrentFirmwareVersion",
"value":"SWIX55C_03.09.11.00"
},
{
"key":"FotaSku",
"value":"TSS-IOT-INTLG-CUSTOM-SWMT"
},
{
"key":"FotaMake",
"value":"Sierra Wireless"
},
{
"key":"FotaModel",
"value":"EM9191"
},
{
"key":"FotaProtocol",
"value":"LWM2M"
}
]
},
{
"categoryName":"PrimaryPlaceOfUse",
"extendedAttributes":[
{
"key":"CustomerFirstName",
"value":"first name"
},
{
"key":"CustomerLastName",
"value":"last name"
},
{
"key":"CustomerAddressLine1",
"value":"street number and name"
},
{
"key":"CustomerAddressCity",
"value":"PLANO"
},
{
"key":"CustomerAddressState",
"value":"TX"
},
{
"key":"CustomerAddressZipCode",
"value":"75075"
},
{
"key":"CustomerCountry",
"value":"USA"
},
{
"key":"CustomerPpuLatitude",
"value":"latitude in decimal degrees"
},
{
"key":"CustomerPpuLongitude",
"value":"longitude in decimal degrees"
}
]
},
{
"categoryName":"SIMSECURE"
},
{
"categoryName":"RTR",
"extendedAttributes":[
{
"key":"RTRUnRatedDataUsage",
"value":"0"
}
]
},
{
"categoryName":"PMEC",
"extendedAttributes":[
{
"key":"IsPmec",
"value":"false"
}
]
},
{
"categoryName":"RfAttributes",
"extendedAttributes":[
{
"key":"CellID",
"value":"cellular ID"
},
{
"key":"CellIDUpdatedDate",
"value":"2024-09-25T21:35:50Z"
},
{
"key":"CellIDStreamStatus",
"value":"ObserveInprogress"
},
{
"key":"CellIDIntervalInSeconds",
"value":"15"
},
{
"key":"CellIDDurationInSeconds",
"value":"900"
},
{
"key":"NetworkBearer",
"value":"6"
},
{
"key":"NetworkBearerUpdateDate",
"value":"2024-09-25T21:35:50Z"
},
{
"key":"NetworkBearerStreamStatus",
"value":"ObserveInprogress"
},
{
"key":"NetworkBearerIntervalInSeconds",
"value":"15"
},
{
"key":"NetworkBearerDurationInSeconds",
"value":"900"
},
{
"key":"RadioSignalStrength",
"value":"-59"
},
{
"key":"RadioSignalStrengthUpdatedDate",
"value":"2024-09-25T21:35:50Z"
},
{
"key":"RadioSignalStrengthStreamStatus",
"value":"ObserveDurationExpired"
},
{
"key":"RadioSignalStrengthIntervalInSeconds",
"value":"15"
},
{
"key":"RadioSignalStrengthDurationInSeconds",
"value":"3600"
},
{
"key":"LinkQuality",
"value":"-11"
},
{
"key":"LinkQualityUpdatedDate",
"value":"2024-09-25T21:35:50Z"
},
{
"key":"LinkQualityStreamStatus",
"value":"ObserveInprogress"
},
{
"key":"LinkQualityIntervalInSeconds",
"value":"15"
},
{
"key":"LinkQualityDurationInSeconds",
"value":"3600"
}
]
},
{
"categoryName":"Battery",
"extendedAttributes":[
{
"key":"BatteryLevel",
"value":"0"
}
]
},
{
"categoryName":"Restart",
"extendedAttributes":[
{
"key":"DeviceRebootStatus",
"value":"REBOOT_QUEUED"
},
{
"key":"DeviceRebootStatusDate",
"value":"2024-05-07T14:21:59Z"
},
{
"key":"DeviceRebootStatusErrorCode",
"value":"DEVICE_UNREACHABLE"
},
{
"key":"DeviceRebootStatusErrorDescription",
"value":"Device not reachable, request will send to device once it become available"
}
]
}
]
}
Status 400
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}
Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.