REST API v2: GET scheduledemailings (Publisher)

Een scheduled emailing is een emailing die ingeroosterd is. De start datum hiervoor kan in het verleden of de toekomst liggen en de emailing kan een of meerdere keren verstuurd worden. Deze methode vraagt een lijst op van alle scheduled mailings ingeroosterd in Publisher. De methode maakt een HTTP call naar het volgende adres:

https://api.copernica.com/v2/ms/scheduledemailings?access_token=xxxx

Je kunt de methode om alle Publisher emailings op te vragen hier vinden.

Beschikbare parameters

De volgende parameters zijn beschikbaar voor de methode:

  • type: Geeft aan welk type mailings opgevraagd moeten worden: individuele mailings ('individual'), massa mailings ('mass') of beide ('both'). Standaard zulle beide types worden opgevraagd.
  • test: Geeft aan of alleen test mailings ('test'), standaard mailings ('normal') of beide opgevraagd moeten worden ('both'). Standaard zullen alle mailings worden opgevraagd.
  • fromdate: Volgende verzending moet na deze tijdstemp plaatsvinden (YYYY-MM-DD HH:MM:SS formaat).

Teruggegeven velden

Deze methode geeft een JSON object met scheduled emailings onder het data veld terug. Elke emailing bevat de volgende velden:

  • id: De ID van de ingeroosterde mailing.
  • next: De tijdstempel van de volgende mailing (YYYY-MM-DD HH:MM:SS formaat).
  • previous: De tijdstempel van de vorige mailing (YYYY-MM-DD HH:MM:SS formaat).
  • interval: Een array voor de tijd interval die de hoeveelheid ('count') en eenheid ('unit') aangeeft.
  • iterations: Het totale aantal keren dat de mailing verstuurd wordt, of -1 als deze oneindig door gaat.
  • processed_iterations: Het aantal keren dat de mailing al is verstuurd.
  • scheduled_iterations: Het aantal keren dat de mailing nog verstuurd zal worden, of -1 als deze oneindig door gaat.
  • document: De ID van het document dat gebruikt is voor deze mailing.
  • template: De ID van de template die gebruikt is voor deze mailing.
  • subject: Het onderwerp van de mailing.
  • from_address: Een array met de naam ('name') en het e-mailadres ('email') van de afzender.
  • testgroups: Het aantal testgroepen gebruikt in deze mailing.
  • emailing_type: Type van de mailing (splitrun, A/B test, normaal).
  • contenttype: Type content van de mailing; html ('html'), tekst ('text') of beide ('both').
  • target: Bevat het type van het doelwit van de mailing en de ID en types van de entiteiten hierboven (bijvoorbeeld de database waar een collectie onder valt).

JSON voorbeeld

De JSON die terug wordt gegeven bevat een property 'data', die een array met alle emailings bevat. Een enkele emailing ziet er bijvoorbeeld zo uit:

{
    "id":"456",
    "next":"2020-01-01 00:00:00",
    "previous":"2020-01-02 00:00:00",
    "interval":
        {
            "count":1,
            "unit":"day"
        },
    "iterations":-1,
    "processed_iterations":"168",
    "scheduled_iterations":"-1",
    "document":123,
    "template":234,
    "subject":"Your daily reminder",
    "from_address":
        {
            "name":John Doe,
            "email":test@copernica.com
        },
    "testgroups":2,
    "emailing_type":"splitrun",
    "contenttype":"both",
    "target":
        {
            "type":"database",
            "sources":
            [{
                "id":"1234",
                "type":"database"
            }]
        }
    }
}

PHP Voorbeeld

Het volgende script demonstreert hoe je deze methode kunt gebruiken. Omdat we de CopernicaRestAPI klasse gebruiken hoef je je geen zorgen te maken over het escapen van speciale karakters; dit wordt automatisch afgehandeld.

// vereiste scripts
require_once('copernica_rest_api.php');

// verander dit naar je access token
$api = new CopernicaRestAPI("your-access-token", 2);

// parameters om aan de call mee te geven
// in dit geval vragen we alleen emailings op die verstuurd zijn naar 
// meerdere destinations en die geen test zijn
$parameters = array(
    'type'  => 'mass',
    'test'  => 'normal',
);

// voer het verzoek uit en print het resultaat
print_r($api->get("publisher/scheduledemailings", $parameters));

Het bovenstaande voorbeeld vereist de CopernicaRestApi klasse.

Meer informatie