AT&T · JSON Structure

Quality On Demand Api Create Session Request Structure

CreateSessionRequest schema

Type: object Properties: 5 Required: 2
5GBroadbandCAMARAConnectivityDevice StatusEdge ComputingEnterpriseFortune 100MessagingMobileNetworkNetwork APIsSIM SwapSpeechTelecommunicationsWirelessWireline

CreateSessionRequest is a JSON Structure definition published by AT&T, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

device qosProfile duration notificationUrl notificationAuthToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/att/refs/heads/main/json-structure/quality-on-demand-api-create-session-request-structure.json",
  "description": "CreateSessionRequest schema",
  "type": "object",
  "required": [
    "device",
    "qosProfile"
  ],
  "properties": {
    "device": {
      "type": "object",
      "description": "Device identifier for QoD session",
      "properties": {
        "phoneNumber": {
          "type": "string",
          "description": "Mobile phone number in E.164 format",
          "example": "+12125551234"
        },
        "ipv4Address": {
          "type": "object",
          "description": "Device IPv4 address",
          "properties": {
            "publicAddress": {
              "type": "string",
              "description": "Public IPv4 address",
              "example": "203.0.113.42"
            },
            "privateAddress": {
              "type": "string",
              "description": "Private IPv4 address",
              "example": "10.0.0.5"
            }
          }
        }
      }
    },
    "qosProfile": {
      "type": "string",
      "description": "Requested QoS profile",
      "enum": [
        "LOW_LATENCY",
        "THROUGHPUT_S",
        "THROUGHPUT_M",
        "THROUGHPUT_L",
        "VOICE"
      ],
      "example": "LOW_LATENCY"
    },
    "duration": {
      "type": "int32",
      "description": "Session duration in seconds (default and max vary by profile)",
      "minimum": 1,
      "maximum": 86400,
      "example": 3600
    },
    "notificationUrl": {
      "type": "uri",
      "description": "Webhook URL to receive QoS status change notifications",
      "example": "https://webhook.example.com/qod-events"
    },
    "notificationAuthToken": {
      "type": "string",
      "description": "Bearer token for webhook notification authentication",
      "example": "webhook-token-abc123"
    }
  },
  "name": "CreateSessionRequest"
}