# Stop Device Reachability Monitoring ### `DELETE /diagnostics/basic/devicereachability` An enterprise application can use this API to stop monitoring the Reachability of devices. At least one Monitor ID (the parameter that is provided when a monitoring request is first made) must be specified in this request for deletion. ## Request Components HTTP Request [DELETE https://thingspace.verizon.com/api/m2m/v1/diagnostics/basic/devicereachability](/docs/standard-apis/connectivity-management/api-endpoints/device-monitoring/device-reachability/devicereachability) ## 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 Stop reachablity monitoring for a specific device(s): ```json { "accountName": "0000123456-00001", "devices": [ { "deviceIds": [ { "id": "1+ 10-digit phone number", "kind": "msisdn" } ] } ] } ``` ## Request Body Parameters All parameters are *(required)* unless marked otherwise. | 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. | | **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: <br> **IMEI** - International Mobile Equipment Identifier, a 15 or 16-digit number <br> **ICCID** - Integrated Circuit Card ID, a 20 or 22-digit number <br> **MDN** - Mobile Device Number, in the USA this is a 10 digit phone number <br> **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. ```json { "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 Callback for a successful request to stop monitoring: ```json { "username": "user", "password": "pwd", "requestId": "595f5c44-eeee-ffff-gggg-020a1545a84d", "deviceIds": [ { "id": "10-digit phone number", "kind": "MDN" } ], "diagnosticsResponse": { "deviceReachabilityResponse": { "accountName": "0000123456-00001", "reportedTime": "10/30/2019 10:13:22 PM", "registrationType": "EVENT_UNREGISTER_FOR_DATA" } }, "status": "Success", "callbackCount": 1, "maxCallbackThreshold": 4 } ``` Callback for a failed request: ```json { "username":"user", "password":"pwd", "requestId":"595f5c44-eeee-ffff-gggg-020a1545a84d", "diagnosticsResponse":{ "deviceReachabilityResponse":{ "accountName":"0000123456-00001", "reportedTime":"2018-11-11T16:39:58-08:00", } }, "status":"Failed", "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. | | **deviceIds** | object | An object with a `kind` and `id` value matching the values in the initial request from customer. | | **diagnosticsResponse** | object | The response object containing the details of a response. | | **accountName** | string | The numeric name of the billing account. | | **reportedTime** | string | Identifies the absolute time at which the reachability report is received from SCEF. The format should be aligned with RFC3339, example: “2017-12-19T16:39:57-08:00” (in UTC passed as a string). | | **registrationType** | string | Valid values include: <br> **EVENT_UNREGISTER_FOR_DATA** <br> **EVENT_UNREGISTER_FOR_SMS** <br> **EVENT_UNREGISTER_FOR_CONNECTION_LOSS** | | **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. |