How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orange Business Device reachability status API

Operations to get the current reachability status of a device

Orange Business Device reachability status API is one of 92 APIs that Orange Business publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Device reachability status. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version wip.

Requests are made against a single base URL, {apiRoot}/location-retrieval/vwip.

1 operations 1 paths 12 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
wip
Base URL
https://api.orange.com/camara/playground/api/device-reachability-status/v0.6
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

Orange Business Device reachability status API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — OpenID Connect authentication

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Device reachability status 1

Operations to get the current reachability status of a device

POST
/retrieve
Get the current reachability status information
getReachabilityStatus 1 param body → 200400401403404422429503

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Device (4 properties), ReachabilityStatusResponse (3 properties), DeviceIpv4Addr (3 properties), ErrorInfo (3 properties). Each schema is shown below with its type and property counts.

DeviceIpv4Addr
object
The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (o…
3 properties
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
DeviceIpv6Address
string
The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to…
Device
object
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide t…
4 properties
Port
integer
TCP or UDP port number
RequestReachabilityStatus
object
The request to retrieve the current roaming-status for the requested device.
1 property
LastStatusTime
string
Last time that the associated device reachability status was updated
ConnectivityType
string
DATA: The device is connected to the network for Data usage (regardless of the SMS reachability) SMS: The device is connected to the network only for SMS usage
NetworkAccessIdentifier
string
A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Loc…
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
ReachabilityStatusResponse
object
3 properties 1 required
ErrorInfo
object
The error object used for error-cases.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orange-business-device-reachability-status-api-openapi.yml Raw ↑

Other APIs Orange Business publishes across the network.

Orange Business IoT Managed Global Connectivity API
Orange Business Orange Money WebPay API
Orange Business Pay With Orange Bill API
Orange Business SMS Middle East and Africa API
Orange Business Voice as a Service API
Orange Business Contact Everyone API
Orange Business Business Talk API
Orange Business Cloud Avenue API
Orange Business Evolution Platform IaaS API
Orange Business EVPL Online API
Orange Business EVPL Monitoring API
Orange Business Content Delivery Boost API
Where this information came from

This is an independent, third-party profile of Orange Business Device reachability status API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.