.wpb_animate_when_almost_visible { opacity: 1; }
CAMARA - Quality on Demand Beta
The Quality-On-Demand (QoD) API provides programmable interface for developers to request improved latency or throughput performance.

QoD for enhanced communication
OAS 3.0

https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/t1Gu5D7t6neDskXc/products/zP5ZsT2wcS4jHHDd/contents/swagger/vkTmGnGTdOeItq1k/OD LAB - QOD - 0.0.9.yaml

The Quality-On-Demand (QoD) API provides programmable interface for developers and other users (capabilities consumers) to request stable latency or throughput managed by Telco networks without the necessity to have an in-depth knowledge of the 4G/5G system or the overall complexity of the Telecom Systems.


Industrial (IoT), VR/Gaming, live video streaming, autonomous driving and many other scenarios demand network communication quality and are sensitive to any change in transmission conditions. Being able to request a stable latency (reduced jitter) or prioritized throughput from the network can improve user experience substantially.

The QoD API offers the application developers the capability to request for stable latency (reduced jitter) or throughput for some specified application data flows between application clients (within a user device) and Application Servers (backend services). The developer has a pre-defined set of Quality of Service (QoS) profiles which they could choose from depending on their latency or throughput requirements.

QoD API Overview

The usage of the API is based on QoS session resources, which can be created (based on available QoS profiles), queried and deleted. The deletion of a requested session can be triggered by the API consumer or can be triggered automatically. The automatic process is triggered either when the requested specified duration of a QoS session has reached its limit or the default session expiration time has been reached (within an example provider implementation it is set to 24hrs).

Relevant terms and definitions

  • QOD service endpoint: The URL pointing to the RESTful resource of the QoD API.

  • Authentication: Security access keys such as OAuth 2.0 client credentials used by client applications to invoke the QoD API.

  • QoS profiles and QoS profile labels: Latency or throughput requirements of the application mapped to relevant QoS profile class.

  • Identifier for the device: At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier [5] assigned by the mobile network operator for the device.

  • Identifier for the application server: IPv4 and/or IPv6 address of the application server (application backend)

  • App-Flow (between the application client and application server): The precise application data flow the developer wants to prioritize and have stable latency or throughput for. This flow is in the current API version determined by the identifiers used for the device and the application server. And it can be further elaborated with details such as ports or port-ranges. Future version of the API might allow more detailed flow identification features.

  • Duration: Duration (in seconds) for which the QoS session (between application client and application server) should be created. This parameter is optional. When not specified, a default session duration (e.g. 24 hours) is applied. The user may request a termination before its expiration.

  • Notification URL and token: Developers may provide a callback URL on which notifications (eg. session termination) regarding the session can be received from the service provider. This is an optional parameter.

API functionality

The usage of the QoD API is based on QoS profile classes and parameters which define App-Flows. Based on the API, QoS session resources can be created, queried, and deleted. Once an offered QoS profile class is requested, application users get a prioritized service with stable latency or throughput even in the case of congestion. The QoD API has the following characteristics:

  • A specified App-Flow is prioritized to ensure stable latency or throughput for that flow.
  • The prioritized App-Flow is described by providing information such as device IP address (or other device identifier) & application server IP addresses and port/port-ranges.
  • The developer can optionally specify the duration for which they need the prioritized App-flow.
  • Stable latency or throughput is requested by selecting from the list of QoS profiles made available by the service provider (e.g. QOS_E) to map latency and throughput requirements.
  • The developer can optionally also specify callback URL on which notifications for the session can be sent.

Following diagram shows the interaction between different components

QoD Management API

How QoS profiles are mapped to connectivity characteristics are subject to agreements between the communication service provider and the API invoker. Within the CAMARA project, you can find a sample for such a mapping of QoS profiles. CAMARA QoS Profiles Mapping Table (REFERENCE DRAFT)

Further info and support

(FAQs will be added in a later version of the documentation)

Product documentation at Camara

QoS sessions

QoS Profiles

    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      404List of supported error codes:
      - 60: Resource not found
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      405List of supported error codes:
      - 61: Method not allowed
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      406List of supported error codes:
      - 62: Not acceptable
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      408List of supported error codes:
      - 63: Request time-out
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      409List of supported error codes:
      - 69: Conflict
        "code": 69,
        "message": "Conflict",
        "description": "The request could not be completed due to a conflict with the current state of the resource."
      411List of supported error codes:
      - 64: Length required
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      412List of supported error codes:
      - 65: Precondition failed
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      413List of supported error codes:
      - 66: Request entity too large
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of the request/response (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      414List of supported error codes:
      - 67: Request-URI too long
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      415List of supported error codes:
      - 68: Unsupported Media Type
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      429List of supported error codes:
      - 53: Too many requests
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      500List of supported error codes:
      - 1: Internal error
        "code": 1,
        "message": "Internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      502List of supported error codes:
      - 1: Internal error
      - 3: Bad gateway
        "code": 1,
        "message": "Bad gateway",
        "description": "A runtime execution error occurs (RaiseFault)."
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      504List of supported error codes:
      - 6: Gateway timeout
        "code": 6,
        "message": "Gateway timeout",
        "description": "No response was received in time from a backend server acting as gateway or proxy."