AT&T · JSON Structure

Device Status Api Device Roaming Request Structure

DeviceRoamingRequest schema

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

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

Properties

device

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/device-status-api-device-roaming-request-structure.json",
  "description": "DeviceRoamingRequest schema",
  "type": "object",
  "required": [
    "device"
  ],
  "properties": {
    "device": {
      "type": "object",
      "description": "Device identifier for connectivity status queries",
      "properties": {
        "phoneNumber": {
          "type": "string",
          "description": "Mobile phone number in E.164 format",
          "example": "+12125551234"
        },
        "ipv4Address": {
          "type": "object",
          "description": "Device IPv4 address (alternative to phoneNumber)",
          "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"
            },
            "publicPort": {
              "type": "int32",
              "description": "Public port if behind NAT",
              "example": 54321
            }
          }
        },
        "networkAccessIdentifier": {
          "type": "string",
          "description": "Network access identifier (alternative to phoneNumber)",
          "example": "user@example.com"
        }
      }
    }
  },
  "name": "DeviceRoamingRequest"
}