Device Roaming Status wip
OAS 3.0
https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/d6RD7SBFZ3a1l7tB/products/zwEZTe3dz7Al6ztI/contents/swagger/nxzLaTCKTqfjFVxX/OD device-roaming-status.yamlThis API provides the customer with the ability to query device roaming Status
Introduction
Roaming Status
API consumer is able to verify whether a certain user device is in roaming situation (or not).
The verification of the roaming situation depends on the network's ability. Additionally to the roaming status, when the device is in roaming situation, visited country information could be returned in the response.
Possible Use-Cases
Roaming status verification could be useful in scenario such as (not exhaustive):
- 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
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.
Roaming : Roaming status -
true
, if device is in roaming situation -false
else.Country : Country code and name - visited country information, provided if the device is in roaming situation.
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 roaming situation
The endpoint POST /retrieve
allows to get roaming status and country information (if device in roaming situation) 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-roaming-status/v0
Server variables
apiRoot |
Roaming status retrievalOperation to get device roaming status and country information (if roaming) synchronously
Operation to get device roaming status and country information (if roaming) synchronously