AT&T Developer Hub · Schema

SessionInfo

SessionInfo schema

Fortune 1005GNetwork APIsCAMARAConnectivityTelecommunicationsEdge ComputingDevice StatusSIM Swap

Properties

Name Type Description
sessionId string Unique identifier for the QoD session
device object Device identifier for QoD session
qosProfile string QoS profile applied to this session
duration integer Session duration in seconds
startedAt string Session start timestamp
expiresAt string Session expiry timestamp
qosStatus string Current QoS provisioning status
View JSON Schema on GitHub

JSON Schema

quality-on-demand-api-session-info-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/at-t-developer-hub/refs/heads/main/json-schema/quality-on-demand-api-session-info-schema.json",
  "title": "SessionInfo",
  "description": "SessionInfo schema",
  "type": "object",
  "properties": {
    "sessionId": {
      "type": "string",
      "description": "Unique identifier for the QoD session",
      "example": "session-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "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": "QoS profile applied to this session",
      "enum": [
        "LOW_LATENCY",
        "THROUGHPUT_S",
        "THROUGHPUT_M",
        "THROUGHPUT_L",
        "VOICE"
      ],
      "example": "LOW_LATENCY"
    },
    "duration": {
      "type": "integer",
      "description": "Session duration in seconds",
      "example": 3600
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Session start timestamp",
      "example": "2026-04-19T14:30:00Z"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Session expiry timestamp",
      "example": "2026-04-19T15:30:00Z"
    },
    "qosStatus": {
      "type": "string",
      "description": "Current QoS provisioning status",
      "enum": [
        "REQUESTED",
        "AVAILABLE",
        "UNAVAILABLE"
      ],
      "example": "AVAILABLE"
    }
  }
}