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.

OpenAPI-Spezifikation herunterladen

Get the connectivity status information

Get the current connectivity status information

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

Authentifizierung

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.

Autorisierungs-URLhttps://api-eu.vonage.com/oauth2/bc-authorize
Token-URLhttps://api-eu.vonage.com/oauth2/token
pages.documentation.api.security.scopes:
  • dpv:NotApplicable#device-status:connectivity:read - Get connectivity status

Anfrage Körper
Inhalt Typ
application/json

device
object
Erforderlich

End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.

phoneNumber
string
Beispiel123456789

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 '+'.

Beispiel Anfrage

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

Antworten
Inhalt Typ
application/json

Contains information about current connectivity status

connectivityStatus
string
Erforderlich

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

Muss eines der folgenden sein:CONNECTED_DATACONNECTED_SMSNOT_CONNECTED

Beispiel Antwort

{
   "connectivityStatus": "CONNECTED_DATA"
}

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

Authentifizierung

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.

Autorisierungs-URLhttps://api-eu.vonage.com/oauth2/bc-authorize
Token-URLhttps://api-eu.vonage.com/oauth2/token
pages.documentation.api.security.scopes:
  • dpv:NotApplicable#device-status:roaming:read - Get roaming status

Anfrage Körper
Inhalt Typ
application/json

device
object
Erforderlich

End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.

phoneNumber
string
Beispiel123456789

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 '+'.

Beispiel Anfrage

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

Antworten
Inhalt Typ
application/json

Contains information about current roaming status

roaming
boolean
Erforderlich

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..

Beispiel Antwort

{
   "roaming": true,
   "countryCode": 262,
   "countryName": [
      "DE"
   ]
}