Device Reachability Status wip
OAS 3.0
https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/JB0xeBGeKKVM15kG/products/p5Cw4X27jlP1izUB/contents/swagger/AQwyVI3JjFS6O4RF/OD device-reachability-status.yamlThis API provides the customer with the ability to query device reachability status.
Introduction
Reachability Status
API consumer is able to verify whether a certain user device is reachable from the network via data- or sms-usage.
Relevant terms and definitions
Device: A device refers to any physical entity that can connect to a network and participate in network communication. At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device.
Reachability : Reachability status.
CONNECTED_SMS
, if device is connected to the network via SMS usageCONNECTED_DATA
, if device is connected to the network via data usageNOT_CONNECTED
, if device is not connected to the network
LastStatusTime : This property specifies the time when the status was last updated. Its presence in the response indicates the freshness of the information, while its absence implies the information may be outdated or its freshness is uncertain.
API Functionality
The API exposes following capabilities:
Device Reachability situation
The endpoint POST /retrieve
allows to get current connectivity status information synchronously.
Authorization and authentication
Camara Security and Interoperability Profile provides details on how a client requests an access token.
Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control.
Further info and support
(FAQs will be added in a later version of the documentation)
https://api.orange.com/camara/orange-lab/device-reachability-status/v0
Server variables
apiRoot |
Device reachability statusOperations to get the current reachability status of a device
Operations to get the current reachability status of a device