AT&T Developer Hub · Schema

Device

Device identifier for network metrics queries

Fortune 1005GNetwork APIsCAMARAConnectivityTelecommunicationsEdge ComputingDevice StatusSIM Swap

Properties

Name Type Description
phoneNumber string Mobile phone number in E.164 format
ipv4Address object Device IP address (alternative to phoneNumber)
View JSON Schema on GitHub

JSON Schema

network-insights-api-device-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/network-insights-api-device-schema.json",
  "title": "Device",
  "description": "Device identifier for network metrics queries",
  "type": "object",
  "properties": {
    "phoneNumber": {
      "type": "string",
      "description": "Mobile phone number in E.164 format",
      "example": "+12125551234"
    },
    "ipv4Address": {
      "type": "object",
      "description": "Device IP address (alternative to phoneNumber)",
      "properties": {
        "publicAddress": {
          "type": "string",
          "example": "203.0.113.42"
        }
      }
    }
  }
}