Device Status

The Device Status API enables obtaining network information such as roaming and connectivity statuses of a network-connected device.

Download OpenAPI Specification

Device connectivity status

Operations to get the current connectivity status of a device

Get the current connectivity status information

Get the current connectivity status information

posthttps://api-eu.vonage.com/camara/device-status/v050/connectivity

Authentication

OAuth 2.0 (three_legged)

For detailed information on authentication with the Device Status API, please refer to our authentication guide.

Scopes:
  • openid dpv:NotApplicable#device-status:connectivity:read - Verify whether an end-user device is connected to the mobile network.
  • openid dpv:NotApplicable#device-status:roaming:read - Verify whether an end-user device is currently roaming.

Request Body
Content Type
application/json

device
object
Required

The phone number of the end-user device capable of connecting to a mobile network. Examples of such devices include smartphones or IoT sensors/actuators.

phoneNumber
string
example123456789

A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, optionally prefixed with '+'.

Example Request

{
   "device": {
      "phoneNumber": "123456789"
   }
}

Responses
Content Type
application/json

Contains information about current connectivity status

connectivityStatus
string
Required

CONNECTED_DATA: The device is connected to the network for Data usage

CONNECTED_SMS: The device is connected to the network for SMS usage

NOT_CONNECTED: The device is not connected

Must be one of:CONNECTED_DATACONNECTED_SMSNOT_CONNECTED

Example Response

{
   "connectivityStatus": "CONNECTED_DATA"
}

Device roaming status

Operation to get device roaming status and country information (if roaming) synchronously

Get the current roaming status and the country information

Get the current roaming status and the country information

posthttps://api-eu.vonage.com/camara/device-status/v050/roaming

Authentication

OAuth 2.0 (three_legged)

For detailed information on authentication with the Device Status API, please refer to our authentication guide.

Scopes:
  • openid dpv:NotApplicable#device-status:connectivity:read - Verify whether an end-user device is connected to the mobile network.
  • openid dpv:NotApplicable#device-status:roaming:read - Verify whether an end-user device is currently roaming.

Request Body
Content Type
application/json

device
object
Required

The phone number of the end-user device capable of connecting to a mobile network. Examples of such devices include smartphones or IoT sensors/actuators.

phoneNumber
string
example123456789

A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, optionally prefixed with '+'.

Example Request

{
   "device": {
      "phoneNumber": "123456789"
   }
}

Responses
Content Type
application/json

Contains information about current roaming status

roaming
boolean
Required

Roaming status. True, if it is roaming

countryCode
integer

The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.

countryName
array

The ISO 3166 ALPHA-2 country-codes of mapped to mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries. If there is no mapping of MCC to any country, then an empty array [] shall be returned..

Example Response

{
   "roaming": true,
   "countryCode": 0,
   "countryName": [
      "string"
   ]
}