POST /devices/extendeddiagnostics/actions/list
Returns 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/list
None.
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": "1223334444-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. |
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 |
---|---|
BillingCycleEndDate | The date and time that the device’s current billing cycle ends. |
Data and SMS usage.
Extended Attribute Key | Extended Attribute Value Description |
---|---|
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. |
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. |
Connection quality information for LWM2M devices.
Extended Attribute Key | Extended Attribute Value Description |
---|---|
LinkQuality | Cellular link quality, in db. |
LinkQualityDate | The date and time of the LinkQuality measurement. |
RadioSignalStrength | Cellular signal strength, in dbm. |
RadioSignalStrengthDate | The date and time of the RadioSignalStrength measurement. |
IOTDeviceType | Type of IOT device (e.g., smart meter, Vending machine, etc.). |
HostDeviceMake | Name of manufacturer of host device. |
HostDeviceModel | Name of model of host device. |
HostDeviceIdentifier | Unique Equipment ID of host device. |
HostCurrentHardwareVersion | Hardware version of form factor IOT device (e.g., vending machine, ATM machine). |
HostCurrentFirmwareVersion | Firmware version of host IOT device (e.g., vending machine, ATM machine). |
HostCurrentSoftwareVersion | Software version of host IOT device (e.g., vending machine, ATM machine). |
HostSoftwareUpdateDate | Date of most recent software or firmware update for host device. |
ModemMake | Manufacturer of communications module (modem) inside host device. |
ModemModel | Model name of communications module (modem) inside host device. |
ModemSerialNumber | Serial number of communications module (modem) inside host device. |
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 |
NetworkBearerDate | The date and time when the Network Bearer Information was logged. |
CellTower | ID of Cell Tower device is attached to. |
CellTowerDate | The date and Time when the CellTower information was logged. |
InternetAPN | Class 3 Access Point Node for Internet Access (e.g., Public IP, VZWINTERNET, MPN, etc.). |
EnterpriseAPN | Class 6 Enterprise Access Point Node for Enterprise domain access. |
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. |
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. |
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. |
ServicePlanType | Based on the type of IP assignment. For example: Public Dynamic IP, Public Static IP, Private IP, etc. |
{
"categories":[
{
"categoryName":"DeviceIdentifier",
"extendedAttributes":[
{
"key":"ICCID",
"value":"20-digit ICCID"
},
{
"key":"IMEI",
"value":"15-digit IMEI"
},
{
"key":"IMSI",
"value":"15-digit IMEI"
},
{
"key":"MDN",
"value":"10-digit MDN"
},
{
"key":"MIN",
"value":"10-digit MIN"
},
{
"key":"MSISDN",
"value":"1+10-digit MSISDN"
}
]
},
{
"categoryName":"DeviceAttributes",
"extendedAttributes":[
{
"key":"AccountName",
"value":"1223334444-00001"
},
{
"key":"GroupName",
"value":"Default"
},
{
"key":"MCC",
"value":"311"
},
{
"key":"MNC",
"value":"480"
},
{
"key":"ServicePlanType",
"value":"Public Dynamic"
},
{
"key":"FeatureCodes",
"value":"86112,84777"
},
{
"key":"FeatureNames",
"value":"86112,84777"
},
{
"key":"FeatureTypes",
"value":"5G IPV/IPV6 IP,4G PUBLIC DYNAM IP DSS STREAM"
},
{
"key":"BundleSku",
"value":"TSS-IOT-INTELLIGENCE-TIERED"
},
{
"key":"RatePlanCode",
"value":"5GBI200MBPSCband"
},
{
"key":"DeviceMake",
"value":"ODI"
},
{
"key":"DeviceModel",
"value":"ASIATELCO - WB550"
},
{
"key":"ModemGeneration",
"value":"5G"
},
{
"key":"Services",
"value":"null"
},
{
"key":"ModemType",
"value":"5GE"
},
{
"key":"DiagnosticsEligibility",
"value":"StreamNotEligible"
},
{
"key":"DiagnosticsSKUName",
"value":"TSS-IOT-INTLG-TIERED-DIAG-LWM2M"
}
]
},
{
"categoryName":"Provisioning",
"extendedAttributes":[
{
"key":"LastActivationBy",
"value":"User Surname, User Name"
},
{
"key":"LastActivationDate",
"value":"2018-08-17T18:55:34Z"
},
{
"key":"CreatedAt",
"value":"2018-08-17T18:55:28Z"
},
{
"key":"LastDateSuspended",
"value":"2018-08-21T00:00:00Z"
},
{
"key":"DeviceState",
"value":"active"
},
{
"key":"ResumeDate",
"value":"2018-08-21T00:00:00Z"
}
]
},
{
"categoryName":"Connectivity",
"extendedAttributes":[
{
"key":"Connected",
"value":"false"
},
{
"key":"LastConnectionDate",
"value":"2018-09-17T19:38:43Z"
},
{
"key":"IPAddress",
"value":"10.3.20.98"
},
{
"key":"LastDisconnectDate",
"value":"2018-09-17T19:38:54Z"
},
{
"key":"NetworkIdentity",
"value":"Assigned network ID"
}
]
},
{
"categoryName":"Billing",
"extendedAttributes":[
{
"key":"BillingCycleEndDate",
"value":"2019-01-14T00:00:00Z"
}
]
},
{
"categoryName":"Usage",
"extendedAttributes":[
{
"key":"CurrentBillCycleDataUsage",
"value":"2097152"
},
{
"key":"CurrentBillCycleSMSUsage",
"value":"10"
}
]
},
{
"categoryName":"Location",
"extendedAttributes":[
{
"key":"LocationSkuName",
"value":"TS-LOC-COARSE-CELLID-5K"
}
]
},
{
"categoryName":"FOTA",
"extendedAttributes":[
{
"key":"FotaSku",
"value":"TS-HFOTA-MRC"
}
]
},
{
"categoryName":"LWM2M",
"extendedAttributes":[
{
"key":"RadioSignalStrength",
"value":"0"
},
{
"key":"LinkQuality",
"value":"0"
}
]
}
]
}
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.