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 QoS Sessions API

Manage QoS sessions

Orange Business QoS Sessions 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 QoS Sessions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version wip.

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

5 operations 4 paths 26 schemas 1 DELETE1 GET3 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/quality-on-demand/v0.11
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

Orange Business QoS Sessions 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 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

QoS Sessions 5

Manage QoS sessions

POST
/sessions
Creates a new session
createSession 1 param body → 201400401403404409422429
GET
/sessions/{sessionId}
Get QoS session information
getSession 2 params → 200400401403404429
DELETE
/sessions/{sessionId}
Delete a QoS session
deleteSession 2 params → 204400401403404429
POST
/sessions/{sessionId}/extend
Extend the duration of an active session
extendQosSessionDuration 2 params body → 200400401403404409429
POST
/retrieve-sessions
Get QoS session information for a device
retrieveSessionsByDevice 1 param body → 200400401403404422429

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are CloudEvent (7 properties), BaseSessionInfo (6 properties), Device (4 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
SinkCredential
object
1 property 1 required
SessionId
string
Session ID in UUID format
BaseSessionInfo
object
Common attributes of a QoD session
6 properties 2 required
ApplicationServer
object
A server hosting backend applications to deliver some business logic to clients. The API consumer can choose to provide the below specified device identifiers:…
2 properties
ExtendSessionDuration
object
Attributes required to extend the duration of an active session
1 property 1 required
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 network. Examples of devices include smartphones or IoT sensors/actuators. The API consumer can choose to provide the b…
4 properties
Port
integer
TCP or UDP port number
RetrieveSessionsInput
object
Parameters to get QoS session information by device
1 property
QosProfileName
string
A unique name for identifying a specific QoS profile. This may follow different formats depending on the API provider implementation. Some options addresses: -…
CreateSession
Attributes required to create a session
CloudEvent
object
Event compliant with the CloudEvents specification
7 properties 5 required
PortsSpec
object
Specification of several TCP or UDP ports
2 properties
StatusInfo
string
Reason for the new qosStatus. Currently statusInfo is only applicable when qosStatus is 'UNAVAILABLE'. DURATIONEXPIRED - Session terminated due to requested du…
QosStatus
string
The current status of the requested QoS session. The status can be one of the following: REQUESTED - QoS has been requested by creating a session AVAILABLE - T…
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…
XCorrelator
string
Value for the x-correlator
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
ErrorInfo
object
Common schema for errors
3 properties 3 required
ApplicationServerIpv4Address
string
IPv4 address may be specified in form as: - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. -…
RetrieveSessionsOutput
array
QoS session information for a given device
ApplicationServerIpv6Address
string
IPv6 address may be specified in form as: - address - The /128 subnet is optional for single addresses: - 2001:db8:85a3:8d3:1319:8a2e:370:7344 - 2001:db8:85a3:…
DeviceResponse
An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer incl…
SessionInfo
Session related information returned in responses. Note that the device object is defined as optional and will only to be returned if provided in createSession…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orange-business-qos-sessions-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 QoS Sessions 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.