AT&T · Schema

MessageSummary

MessageSummary schema from AT&T API

5GBroadbandCAMARAConnectivityDevice StatusEdge ComputingEnterpriseFortune 100MessagingMobileNetworkNetwork APIsSIM SwapSpeechTelecommunicationsWirelessWireline

Properties

Name	Type	Description
messageId	string	Unique message identifier
from	string	Sender address (phone number or email)
recipients	array	List of recipient addresses
isUnread	boolean	Whether the message has been read
isIncoming	boolean	True if message was received, false if sent
type	string	Message type
typeCode	string	Numeric type code
timeStamp	string	Date and time the message was sent or received

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/att/refs/heads/main/json-schema/in-app-messaging-api-message-summary-schema.json",
  "title": "MessageSummary",
  "description": "MessageSummary schema from AT&T API",
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "description": "Unique message identifier",
      "example": "msg-500123"
    },
    "from": {
      "type": "string",
      "description": "Sender address (phone number or email)",
      "example": "tel:+12125551234"
    },
    "recipients": {
      "type": "array",
      "description": "List of recipient addresses",
      "items": {
        "type": "string"
      },
      "example": [
        "tel:+12125559999"
      ]
    },
    "isUnread": {
      "type": "boolean",
      "description": "Whether the message has been read",
      "example": false
    },
    "isIncoming": {
      "type": "boolean",
      "description": "True if message was received, false if sent",
      "example": true
    },
    "type": {
      "type": "string",
      "description": "Message type",
      "enum": [
        "TEXT",
        "MMS"
      ],
      "example": "TEXT"
    },
    "typeCode": {
      "type": "string",
      "description": "Numeric type code",
      "example": "1"
    },
    "timeStamp": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the message was sent or received",
      "example": "2026-04-19T14:30:00Z"
    }
  }
}