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.
Operaciones disponibles
Autenticación
| 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. | |
| URL de autorización | https://api-eu.vonage.com/oauth2/bc-authorize |
| URL del token | https://api-eu.vonage.com/oauth2/token |
pages.documentation.api.security.scopes:
| |
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.
123456789A 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 '+'.
Ejemplo Solicitar
{
"device": {
"phoneNumber": "123456789"
}
}{
"device": {
"phoneNumber": "123456789"
}
}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
CONNECTED_DATACONNECTED_SMSNOT_CONNECTEDEjemplo Respuesta
{
"connectivityStatus": "CONNECTED_DATA"
}Autenticación
| 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. | |
| URL de autorización | https://api-eu.vonage.com/oauth2/bc-authorize |
| URL del token | https://api-eu.vonage.com/oauth2/token |
pages.documentation.api.security.scopes:
| |
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.
123456789A 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 '+'.
Ejemplo Solicitar
{
"device": {
"phoneNumber": "123456789"
}
}{
"device": {
"phoneNumber": "123456789"
}
}Roaming status. True, if it is roaming
The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.
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..
Ejemplo Respuesta
{
"roaming": true,
"countryCode": 262,
"countryName": [
"DE"
]
}