Vonage Device Status API

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

Please note that this API is not currently publicly available. If you wish to get access, please contact our sales or support team using this form.

Download OpenAPI Specification

Get the 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_connectivity)

Three-legged OAuth 2.0 flows require the application to obtain End-User authorization and a token to access resources on behalf of the End-User. More information at https://developer.vonage.com/concepts/guides/authentication.

API specs available at: https://developer.vonage.com/api/camara/auth.

Authorization URLhttps://api-eu.vonage.com/oauth2/bc-authorize
Token URLhttps://api-eu.vonage.com/oauth2/token
Scopes:
  • dpv:NotApplicable#device-status:connectivity:read - Get connectivity status

Request Body
Content Type
application/json

device
object
Required

End-user equipment able to connect to a mobile network. Examples of 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

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

Get the 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_roaming)

Three-legged OAuth 2.0 flows require the application to obtain End-User authorization and a token to access resources on behalf of the End-User. More information at https://developer.vonage.com/concepts/guides/authentication.

API specs available at: https://developer.vonage.com/api/camara/auth.

Authorization URLhttps://api-eu.vonage.com/oauth2/bc-authorize
Token URLhttps://api-eu.vonage.com/oauth2/token
Scopes:
  • dpv:NotApplicable#device-status:roaming:read - Get roaming status

Request Body
Content Type
application/json

device
object
Required

End-user equipment able to connect to a mobile network. Examples of 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

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