NN Agent
Übersicht

Kampagnen und Kontakte in der API

Eine Kampagne besteht aus drei Teilen: Kontakte, Pool von Optionen für die erste Nachricht und verknüpfte Konten. Unten sind die Operationen der Version v2; die Kunden-ID wird durch das Token ersetzt.

Kampagnen#

GET/v2/campaigns

Liste der Kampagnen des Kunden.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

POST/v2/campaigns

Kampagne erstellen. Der Anfragekörper ist JSON.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

GET/v2/campaigns/{campaign_id}

Kampagnenkarte.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

POST/v2/campaigns/{campaign_id}/update

Ändern Sie die Kampagnenparameter. Der Anfragekörper ist JSON.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

DELETE/v2/campaigns/{campaign_id}

Die Kampagne zusammen mit ihren Kontakten und dem Nachrichtenpool löschen.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

Kampagnenkonten#

POST/v2/campaigns/{campaign_id}/accounts

Konten an die Kampagne binden: von ihnen werden die ausgehenden Nachrichten gesendet. Der Anfrageinhalt ist JSON.

Autorisierung
Authorizationstring

Wird als Authorization-Header gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

DELETE/v2/campaigns/{campaign_id}/accounts

Konten von der Kampagne trennen. Der Anfrageinhalt ist JSON.

Autorisierung
Authorizationstring

Wird als Authorization-Header gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

Kontakte#

Die Kontakte der Kampagne werden per Datei hochgeladen und im gleichen Format exportiert. Der Parameter format akzeptiert nur csv oder xlsx, standardmäßig csv.

POST/v2/campaigns/{campaign_id}/contacts/upload

Die Kontaktbasis per Datei hochladen. Der Anfragekörper ist multipart/form-data mit dem Feld file.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

Körper
formatstring

csv oder xlsx, standardmäßig csv

GET/v2/campaigns/{campaign_id}/contacts

Liste der Kontakte der Kampagne.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

GET/v2/campaigns/{campaign_id}/contacts/stats

Zusammenfassung der Kontakte der Kampagne.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

GET/v2/campaigns/{campaign_id}/contacts/export

Kontakte der Kampagne als Datei exportieren.

Autorisierung
Authorizationstring

Wird als Authorization-Header gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet – er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

Abfrage
formatstring

csv oder xlsx, standardmäßig csv

DELETE/v2/campaigns/{campaign_id}/contacts

Die Kontaktdatenbank der Kampagne leeren.

Autorisierung
Authorizationstring

Wird als Authorization-Header gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet – er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

Nachrichtenspeicher#

Der Speicher enthält Varianten der ursprünglichen Nachricht. Der NN-Agent entnimmt den Text für den nächsten Kontakt, sodass identischer Text nicht an die gesamte Datenbank hintereinander gesendet wird.

GET/v2/campaigns/{campaign_id}/message-pool

Liste der Varianten der ersten Nachricht der Kampagne.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

POST/v2/campaigns/{campaign_id}/message-pool

Eine Nachrichtenvariante zum Pool hinzufügen. Der Anfrageinhalt ist JSON.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

DELETE/v2/campaigns/{campaign_id}/message-pool/{message_id}

Eine Variante aus dem Pool löschen.

Autorisierung
Autorisierungstring

Wird als Autorisierungsheader gesendet. Ihr Schlüssel wird nur von Ihrem Browser für diese Anfrage verwendet — er wird niemals an Docsbook gesendet oder gespeichert.

Pfad
campaign_idstringerforderlich

UUID der Kampagne

message_idstringerforderlich

UUID der Nachrichtenvariante

Weiter#

Updated

Powered by Docsbook
Kampagnen und Kontakte in der API — NN Agent