endpoint

Retrieve connectivity information for an endpoint

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

Endpoint.Connectivity + Get <span className="permission-callout__also">+1 endpoint</span>

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info>

Returns device location information based on the cell tower to which the device is connected.

<Note> emnify validates the data requested, sends the signal request to the network operator, and interprets the response. Whether the network returns useful data is outside of emnify's control.

To distinguish these cases, this call returns the HTTP 200 OK response code whenever the request is successfully executed, even if it includes an error. See the response body for details. </Note>

get/api/v1/endpoint/{endpoint_id}/connectivity_info

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/endpoint/{endpoint_id}/connectivity_info
  • Auth: HTTP bearer

Path parameters

endpoint_idinteger required

Numeric ID of an endpoint

Query parameters

subscriberboolean

Indicates whether the subscriber information is retrieved. This parameter must be true to retrieve the connectivity information.

Upon successful execution, the response contains the following information:

  • success (Boolean) Indicates whether the location is successfully retrieved from the network.
  • state (String) Provides the subscriber state information.
    • Assumed Idle - The network cannot determine whether the device is reachable.
    • Network determined not reachable - Subscriber is marked not reachable by the network.
    • Not provided from VLR - No information on the Visitor Location Register (VLR) exists on the core network. The following scenarios may result in this state:
      • The device is attached to a 4G/LTE-M/NB-IoT network.
      • The request for fetching location information failed.
      • The core network has no VLR information.
  • location (Object) Contains the following information:
    • current_location_retrieved (Boolean) Indicates whether the current location is successfully retrieved.
    • age_of_location (Number) Time in minutes since the last contact with the device.
    • cell_global_id (Object) Includes the MCC, MNC, LAC, and CID.

Otherwise, the response contains the success field and an error (String) field with the error message.

All responses include the following fields:

  • request_timestamp (String, Date format) Time in UTC the location information was requested.
  • reply_timestamp (String, Date format) Time in UTC the network provides the location information.

Response

Success

OR
OR

Changes

No recorded changes to this operation across all 1 revision of this API.