Beschreibung
Mit Hilfe der Funktion GetSubscribers können zu den angegebenen E-Mail Adressen die Listenabonements und die persönlichen Informationen ausgelesen werden. Wenn eine Adresse nicht im System ist, dann wird die im Status-Feld des Response-Objekts angegeben. Mit Hilfe dieser FUnktion können maximal 1000 Adressen geprüft und ausgelesen werden.
Wenn Sie die Daten auslesen wollen, dann müssen folgende Angaben gemacht werden:
- ID des Mandanten
- API-Key (optionale Authentifizierung, wenn nicht angegeben, dann wird die Authentifizierung über die IP-Adressen vorgenommen)
- Sollen die persönlichen Daten mit ausgelesen werden? (Standard: "fillSubscriberFields" => false); optionale Angabe
- Liste der auszulesenden E-Mail Adressen
Als Ergebis des Aufrufs bekommen Sie ein Objekt, welcjhe die gewünschten Informationen enthält. Wenn Feld "status" des Ergebnisobjekts eine "-1" steht, dann ist die Adresse nicht als Abonnent im System hinterlegt.
Folgende Fehlermeldungen können bei fehlerhaften Requests auftreten:
- Too many emailaddresses in request! Max email addresses per request: n => Es wurden zu viele Adressen in einem Requets abgefragt, die maximal mögliche Anzahl an abzufragenden Adressen steht am Ende der Fehlermeldung.
Beispiel
$client = new SoapClient($wsdlUrl); date_default_timezone_set('Europe/Berlin'); $getSubscribersRequest = new StdClass(); $getSubscribersRequest->mandatorId = 0; $getSubscribersRequest->emailAddresses = array(); array_push($getSubscribersRequest->emailAddresses, 'user@example.com'); $getSubscribersRequest->fillSubscriberFields = true; try { $result = $client->getSubscribers($getSubscribersRequest); var_dump($result); } catch (Exception $e) { echo "Error: " . $e->getMessage() . "\n"; }
object(stdClass)#3 (1) { ["subscribers"]=> object(stdClass)#4 (1) { ["item"]=> object(stdClass)#5 (5) { ["subscriberEmail"]=> string(22) user@example.com" ["status"]=> int(1) ["mandatorId"]=> int(0) ["newsletterListIds"]=> string(7) "1" ["subscriberFields"]=> object(stdClass)#6 (1) { ["item"]=> array(2) { [0]=> object(stdClass)#7 (2) { ["fieldName"]=> string(7) "VORNMER" ["fieldValue"]=> string(3) "User" } } } } } }
Quellcode
Um ein funktionsfähiges Beispiel testen können, steht hier der Quellcode zum Download zur Verfügung.
Beispiel um einen Abonnenten im System abzurufen