AT&T Developer Hub · Schema

CreateSessionRequest

CreateSessionRequest schema

Fortune 1005GNetwork APIsCAMARAConnectivityTelecommunicationsEdge ComputingDevice StatusSIM Swap

Properties

Name Type Description
device object Device identifier for QoD session
qosProfile string Requested QoS profile
duration integer Session duration in seconds (default and max vary by profile)
notificationUrl string Webhook URL to receive QoS status change notifications
notificationAuthToken string Bearer token for webhook notification authentication
View JSON Schema on GitHub

JSON Schema

quality-on-demand-api-create-session-request-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-create-session-request-schema.json",
  "title": "CreateSessionRequest",
  "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": "integer",
      "description": "Session duration in seconds (default and max vary by profile)",
      "minimum": 1,
      "maximum": 86400,
      "example": 3600
    },
    "notificationUrl": {
      "type": "string",
      "format": "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"
    }
  }
}