OptOutListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-opt-out-list-response-schema.json",
  "title": "OptOutListResponse",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-opt-out-management-api-openapi.yml#/components/schemas/OptOutListResponse",
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/OptOutItem"
      },
      "type": "array"
    },
    "meta": {
      "$ref": "#/$defs/messaging_PaginationMeta"
    }
  },
  "type": "object",
  "$defs": {
    "OptOutItem": {
      "properties": {
        "created_at": {
          "description": "The timestamp when the opt-out was created",
          "format": "date-time",
          "type": "string"
        },
        "from": {
          "description": "Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).",
          "type": "string",
          "x-format": "address"
        },
        "keyword": {
          "description": "The keyword that triggered the opt-out.",
          "type": [
            "string",
            "null"
          ]
        },
        "messaging_profile_id": {
          "description": "Unique identifier for a messaging profile.",
          "type": [
            "string",
            "null"
          ]
        },
        "to": {
          "$ref": "#/$defs/ToNumber"
        }
      },
      "type": "object"
    },
    "ToNumber": {
      "description": "Receiving address (+E.164 formatted phone number or short code).",
      "type": "string",
      "x-format": "address"
    },
    "messaging_PaginationMeta": {
      "properties": {
        "page_number": {
          "type": "integer"
        },
        "page_size": {
          "type": "integer"
        },
        "total_pages": {
          "type": "integer"
        },
        "total_results": {
          "type": "integer"
        }
      },
      "required": [
        "total_pages",
        "total_results",
        "page_size",
        "page_number"
      ],
      "type": "object"
    }
  }
}