Search
K

Quality on Demand (QoD) API

Overview

The Quality on Demand (QoD) API allows applications to request temporary network quality guarantees for a subscriber device, manage QoD sessions, and query their status.

  • Version: 0.1.0
  • Base URL: https://api.pxg.konera.com/camara
  • OpenAPI: qod.openapi.json

Typical use cases

  • Cloud gaming / XR – Request low‑latency, high‑bandwidth profiles for immersive sessions.
  • Live streaming & broadcasting – Ensure consistent uplink bandwidth for live video contributions.
  • Mission‑critical IoT – Improve reliability for critical telemetry or control flows during certain operations.

Security

  • OAuth2 Client Credentials
    • Token URL: https://auth.konera.com/oauth2/token
    • Scope: qod:request – Request QoD sessions

Common Headers

  • x-correlation-id (optional, string) – Correlation ID for request tracing.

Create QoD Session

POST https://api.pxg.konera.com/camara/qod/v0.1/sessions

Request body: QodSessionRequest

{
  "device": {
    "phoneNumber": "+12065550123"
  },
  "duration": 300,
  "qosProfile": {
    "maxLatency": 50,
    "minDownlinkBandwidth": 5000,
    "minUplinkBandwidth": 1000
  }
}
  • device.phoneNumber (string, required) – MSISDN in E.164 format.
  • duration (integer, required) – Requested session duration in seconds.
  • qosProfile (object, required) – QoS requirements:
    • maxLatency (integer, ms)
    • minDownlinkBandwidth (integer, kbps)
    • minUplinkBandwidth (integer, kbps)

201 – Session created

Body schema: QodSessionResponse

{
  "sessionId": "qod-session-123456",
  "status": "ACTIVE",
  "expiresAt": "2026-02-10T18:30:00Z"
}

Get QoD Session Status

GET https://api.pxg.konera.com/camara/qod/v0.1/sessions/{sessionId}

  • sessionId (path, string, required) – QoD session identifier.

200 – Session status

Returns QodSessionResponse.

Terminate QoD Session

DELETE https://api.pxg.konera.com/camara/qod/v0.1/sessions/{sessionId}

  • sessionId (path, string, required) – QoD session identifier.

204 – Session terminated

HTTP status codes

All operations may return Error for 4xx/5xx as defined in the OpenAPI.

  • 201 Created – QoD session successfully created.
  • 200 OK – Session details successfully retrieved.
  • 204 No Content – Session successfully terminated.
  • 400 Bad Request – Invalid QoS profile, device info, or parameters.
  • 401 Unauthorized – Invalid/missing token.
  • 403 Forbidden – Caller not permitted to request or manage QoD sessions.
  • 404 Not Found – Session ID does not exist.
  • 429 Too Many Requests – Rate limit exceeded for QoD operations.
  • 500 Internal Server Error – Unexpected server error.