Standard APIsConnectivity ManagementAPI EndpointsDevice DiagnosticsRetrieve Active Monitors Using POST
API Reference
Retrieve All Active Reachability Monitoring Events
POST /diagnostics/basic/devicereachability/monitors
An enterprise application can use this API to retrieve All outstanding (Active) Monitoring Reachability (DATA, SMS, LOSS_OF_CONN) events.
Request Components
HTTP Request
POST https://thingspace.verizon.com/api/m2m/v1/diagnostics/basic/devicereachability/monitors
Header Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization bearer token. |
| VZ-M2M-Token (required) | string | A valid session token returned by POST /api/m2m/v1/session/login. |
| Content-Type (required) | string | Must be application/json. |
Request Body
Retrieve all monitors for given devices:
{
"accountName": "0242123520-00001",
"devices": [
{
"deviceIds": [
{
"id": "12016560696",
"kind": "msisdn"
}
]
}
]
}Retrieve all monitors of a certain type for given devices:
{
"accountName": "0242123520-00001",
"requestType": "REACHABLE_FOR_DATA",
"devices": [
{
"deviceIds": [
{
"id": "12016560696",
"kind": "msisdn"
}
]
}
]
}Request Body Parameters
All parameters are (required) unless marked (optional).
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName | String | The name of a billing account, which is numeric, in the format of 10 digits, a hyphen and then five more digits. Must include any leading zeros. |
| requestType (optional) | string | Valid values include: REACHABLE_FOR_DATA REACHABLE_FOR_SMS LOSS_OF_CONNECTIVITY |
| devices | array | An array containing deviceId entries to stop reachability monitoring. |
| deviceId | array | An array containing device identifier objects (id, kind). |
| id | string | The value of the type of identifier. |
| kind | string | The type of device identifier. Valid values include: IMEI - International Mobile Equipment Identifier, a 15 or 16-digit number ICCID - Integrated Circuit Card ID, a 20 or 22-digit number MDN - Mobile Device Number, in the USA this is a 10 digit phone number MSISDN - Mobile Services International Subscriber Directory Number, in the USA this is 1+ the 10 digit phone number |
Success Response
Status 200
A successful Response includes a requestID that can be used to correlate the callbacks.
{
"requestId": "595f5c44-eeee-ffff-gggg-020a1545a84d"
}Success Response Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| requestID | string | A unique string (UUID) that associates the delete request with the results that are sent via a callback message (The Callback Service to suscibe to is DiagnosticsService). |
Callback Responses
{
"username" : "user",
"password" : "pwd",
"requestId" : "595f5c44-eeee-ffff-gggg-020a1545a84d",
"diagnosticsResponse" : {
"monitorResponse" : {
"accountName" : "0000123456-00001",
"monitors" : [ {
"deviceIds": [
{
"id": "12016560696",
"kind": "msisdn"
}
],
"monitorType" : "LOSS_OF_CONNECTIVITY",
"creationTime" : "2019-10-29T19:46:41.467Z",
"expirationTime" : "2019-10-31T22:00:00.000Z"
} ],
"pageNumber" : "1",
"totalPages" : "1"
}
},
"status" : "Success",
"callbackCount" : 1,
"maxCallbackThreshold" : 4
}Callback Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| username | string | The user name used to register the callback listener. This will be "Null" if no value. |
| password | string | The password of the user name used to register the callback listener. This will be "Null" if no value. |
| requestId | string | A unique string (UUID) that associates the delete request for group of devices. |
| diagnosticsResponse | object | The response object. |
| monitorResponse | object | The response object containing the details of the response. |
| accountName | string | The numeric name of the billing account. |
| monitors | array | An array of objects containing the details of the devices responding. |
| deviceIds | array | An array of device idenifier objects (kind, id) matching the initial request. |
| monitorType | string | Valid values returned include: REACHABLE_FOR_DATA REACHABLE_FOR_SMS LOSS_OF_CONNECTIVITY Note: If this value is specified in the request, it will not appear in the response. |
| creationTime | string | Identifies the absolute time at which the monitoring was started. The format should be aligned with RFC3339, example: “2017-12-19T16:39:57-08:00” (in UTC passed as a string). |
| expirationTime | string | Identifies the absolute time at which the monitoring ends. The format should be aligned with RFC3339, example: “2017-12-19T16:39:57-08:00” (in UTC passed as a string). |
| pageNumber | integer | Index of the current block of 2000 monitors included in this callback report. if there are no active monitors for the set of devices requested by user, then this shall be set to 1. |
| totalPages | integer | Total number of blocks in entire report; if there are no active monitors for the set of devices requested by user, then this shall be set to 1. |
| status | string | This will be either Success or Failed based on the status of the request. |
| callbackCount | integer | The number of callback responses returned. |
| maxCallbackThreshold | integer | The maximum number of attempts to retrieve a callback. |