Dokumentation für Developers

API Dokumentation

Aktuelle Version 1.19

Gibt es Bibliotheken für PHP??

Sprache: PHP | PHPGestalt | Autor: Zhussupov Zhassulan | GitHub Repository: https://github.com/GestaltMail/php_gestaltmail


Wenn Sie eine Bibliothek haben, um mit GestaltMail zu integrieren, oder Sie möchten, dass sie wirklich erscheint - zögern Sie nicht und schreiben Sie sofort an support@gestaltplatform.com. Wir freuen uns immer über talentierte Entwickler!

Wie rufe ich API auf?

Die Arbeit mit der API erfolgt durch Senden von HTTP-Anfragen (GET, POST-Methoden) an die Adresse:

api.gestaltmail.com

Verwenden Sie HTTP- oder HTTPS-Protokolle. Codierung: UTF-8. Beispiel:

https://api.gestaltmail.com/?method=lists.get&username=example&password=example&format=xml

Erforderliche Abfrageparameter

  • method (aufrufende api-Methode mit dem Typ "Kategorie.Methode", beispielsweise 'lists.get')
  • username (Login für die Autorisierung)
  • password (Passwort für die Autorisierung)

Zurückgegebene Daten

Die Antwort kann in einem von mehreren Formaten sein. Verwenden Sie die Variable format, um sie festzulegen:

  • JSON (default)
  • JSONP
  • XML

Gestalt gibt die Daten folgendermaßen zurück:

  • <msg> Nachricht über die Aktion in Form eines Arrays mit Schlüsseln <err_code> - numerischer Fehlercode (0 - ohne Fehler), <text> - Text der Nachricht, <type> - Typ der Nachricht (message – ohne Fehler, notice und error – es gibt Fehler)
  • <data> angeforderte Daten als ein Array, falls vorhanden.

Probleme? Fragen?

Wenn Sie Probleme mit der Integration haben oder glauben Sie, dass die API-Methode nicht richtig funktioniert, bitte schreiben Sie an support@gestaltplatform.com und unsere Entwickler und Support-Team werden Sie schnell antworten.

Version: 1.9

Fehlercodes

errors

Tabelle bekannter Fehler, die vom Dienst zurückgegeben werden

Kategorien der Methoden

lists - Bearbeitung der Empfängerliste
campaigns - Bearbeitung der Kampagnen
reports - Berichten Aufrufen

Methoden für die Bearbeitung der Empfängerlisten

lists.get ( int list_id )

Empfängerlisten erhalten

lists.add ( string name, string abuse_email, string abuse_name, string company, string address, string city, string zip, string country, string url, string phone )

Eine Empfängerliste erstellen

lists.update ( int list_id, string name, string abuse_email, string abuse_name, string company, string address, string city, string zip, string country, string url, string phone )

Aktualisieren die Daten der Empfängerliste

lists.delete ( int list_id )

Entfernen der Empfängerliste und aller enthaltenen Abonnenten

lists.get_members ( int list_id, string state, int start, int limit, string order, int member_id, string email )

Erhalten Sie Abonnenten in der Empfängerliste mit der Möglichkeit, die Ausgabe zu filtern und anzupassen.

lists.upload ( int list_id, string file, int email, int merge_1, int merge_2, int merge_3, int merge_4, int merge_5, int merge_6, int merge_7, int merge_8, int merge_9, int merge_10, enum gender, string type, string update, int sheet_index, string sheet_name )

Abonnenten aus einer Datei importieren

lists.add_member ( int list_id, string email, string merge_1, string merge_2, string merge_3, string merge_4, string merge_5, string merge_6, string merge_7, string merge_8, string merge_9, string merge_10, enum gender, string update, string no_check )

Hinzufügen eines Abonnenten zur Empfängerliste

lists.add_member_batch ( int list_id, string batch, string update, string no_check )

Hinzufügen mehreren Abonnenten zur Empfängerliste

lists.update_member ( int member_id, string merge_1, string merge_2, string merge_3, string merge_4, string merge_5, string merge_6, string merge_7, string merge_8, string merge_9, string merge_10, enum gender )

Abonnentendaten in der Empfängerliste aktualisieren

lists.delete_member ( int member_id )

Löschen des Abonnenten aus der Empfängerliste.

lists.unsubscribe_member ( int member_id, string email, string list_id )

Empfängerliste für einen Abonnent abmelden.

lists.move_member ( int member_id, int list_id )

Vershieben des Abonnenten in andere Empfängerliste.

lists.copy_member ( int member_id, int list_id )

Kopieren des Abonnenten in andere Empfängerliste.

lists.add_merge ( int list_id, string type, serialized array choices, string title, string req, string var )

Zusätzliches Feld der Empfängerliste hinzufügen.

lists.update_merge ( int list_id, int merge_id, serialized array choices, string title, string req, string var )

Die Einstellungen des zusätzlichen Feldes in der Empfängerliste aktualisieren.

lists.delete_merge ( int list_id, int merge_id )

Ein zusätzliches Feld aus der Empfängerliste entfernen.

Methoden für die Bearbeitung des Mailings

campaigns.get ( int campaign_id, string status, int list_id, string type )

Liste der Mailings erhalten

campaigns.create ( serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string html, string plain_text, serialized array esegment )

Mailing erstellen.

campaigns.create_auto ( serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string html, string plain_text, string action, int delay_1, string delay_2, string campaigns )

Automation erstellen.

campaigns.update ( int campaign_id, serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string html, string plain_text, string status, serialized array esegment )

Mailingsdaten aktualisieren.

campaigns.update_auto ( int campaign_id, serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string html, string plain_text, int delay_1, string delay_2, string campaigns )

Automationsparameter aktualisieren.

campaigns.delete ( int campaign_id )

Mailing entfernen

campaigns.attach ( int campaign_id, string url, string name )

Anhang hinzufügen

campaigns.get_attachments ( int campaign_id )

Dateien zum Anhängen erhalten

campaigns.delete_attachment ( int campaign_id, int id )

Loschen der hinzugefügten Datei

campaigns.get_templates ( string name )

HTML-Vorlage erhalten

campaigns.add_template ( string name, string template )

HTML-Vorlage hinzufügen

campaigns.delete_template ( int id )

HTML-Vorlage entfernen

campaigns.force_auto ( int campaign_id, int member_id, int delay )

Zwanghaft auslösen der Automation (sie sollte dabei aktiv sein

Methoden für Aufruf der Berichte

reports.sent ( int campaign_id, int start, int limit, string order )

Liste der gesendeten E-Mails im Mailing

reports.delivered ( int campaign_id, int start, int limit, string order )

Liste der gelieferten E-Mails in einem Mailing

reports.opened ( int campaign_id, int start, int limit, string order )

Liste der geöffneten E-Mails in einem Mailing

reports.unsubscribed ( int campaign_id, int start, int limit, string order )

Liste der Abonnenten, die das Mailing abbestellt haben

reports.bounced ( int campaign_id, int start, int limit, string order )

Liste der gebounct E-Mails in einem Mailing

reports.clickstat ( int campaign_id )

Klick-Statistik für verschiedenen URLs in einem Mailing

reports.bouncestat ( int campaign_id )

Statistiken für alle möglichen Gründe für die Rückgabe

reports.summary ( int campaign_id )

Kurze Mailingsstatistiken

reports.clients ( int campaign_id )

Browser-, Betriebssystemen und Mail-Clients-Statistiken

reports.geo ( int campaign_id )

Geo-Statistiken