DeltaResponse

{
  "$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-delta-response-schema.json",
  "title": "DeltaResponse",
  "description": "DeltaResponse schema from AT&T API",
  "type": "object",
  "properties": {
    "deltaResponse": {
      "type": "object",
      "properties": {
        "addedMessages": {
          "type": "array",
          "description": "Messages added since last sync",
          "items": {
            "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"
              }
            }
          }
        },
        "updatedMessages": {
          "type": "array",
          "description": "Messages updated since last sync",
          "items": {
            "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"
              }
            }
          }
        },
        "deletedMessages": {
          "type": "array",
          "description": "Message IDs deleted since last sync",
          "items": {
            "type": "string"
          },
          "example": []
        },
        "state": {
          "type": "string",
          "description": "New state token for next delta sync call",
          "example": "state-e5f6g7h8"
        }
      }
    }
  }
}