Technical Details
The Device Status API enables you to query a device's connectivity and roaming status. Some example use cases for these capabilities include:
- For regulatory reasons, where a customer may need to be within a certain jurisdiction, or out with others, in order for transactions to be authorized.
- For security / fraud reasons, to establish that a customer is located where they claim to be.
- For service delivery reasons, to ensure that the customer has access to particular service and will not incur roaming charges in accessing them.
Authentication
The authentication process for Device Status is known as Back-End Authentication. In summary, the Back-End Authentication is a series of
POST
requests from the mobile application in order to obtain an authorization code from the relevant mobile operator. This authorization token will then be used as part of the API request when checking the device status.See our guide on Network API Authentication for code samples and more information on how Back-End Authentication works.
Device Status API Operations
Connectivity Status
The connectivity operation gives you information about a device's current connectivity status, returning one of three options:
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.
Roaming Status
The roaming operation gives you information on whether or not a device is roaming, returning:
roaming: whether or not the device is currently roaming.countryCode: if roaming, the mobile country code for the country the device is roaming in.countryName: if roaming, the name of the country the device is roaming in.
Further Reading
For more detailed information on the Device Status API, see the API Reference.