Wie man die erste Kampagne über die API startet
Eine Kampagne im NN Agent besteht aus drei Teilen: Kontakte, Pool von ersten Nachrichten und verknüpfte Konten. Unten ist die Reihenfolge der Aufrufe der Version v2.
Bevor Sie beginnen, verbinden Sie mindestens ein Konto — siehe Konto über die API verbinden.
curl -X POST https://api.nexifyneo.com/v2/campaigns \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'Die Antwort enthält die Kampagnen-ID im UUID-Format. Diese wird dann in den Pfad aller anderen Anfragen eingesetzt.
Kontakte werden per Datei und nicht zeilenweise hochgeladen. CSV und XLSX werden unterstützt; das Format wird durch den Anfrageparameter format angegeben, standardmäßig csv.
curl -X POST "https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/contacts/upload?format=csv" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-F "file=@contacts.csv"Überprüfen Sie, ob die Datenbank erfolgreich hochgeladen wurde, mit einer Zusammenfassung: GET /v2/campaigns/{campaign_id}/contacts/stats.
curl -X POST https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/message-pool \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'Fügen Sie mehrere Varianten hinzu, nicht nur eine. Der NN Agent nimmt aus dem Pool den Text für den nächsten Kontakt, und das ist der einzige Weg, um zu verhindern, dass der gesamten Datenbank derselbe Text zeilenweise gesendet wird.
curl -X POST https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/accounts \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d 'YOUR_JSON_BODY'Die aus den verknüpften Konten gesendeten Nachrichten werden ausgehen. Die Trennung erfolgt mit derselben Adresse über die Methode DELETE.
curl https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID \
-H "Authorization: Bearer YOUR_API_TOKEN"Stellen Sie sicher, dass die Kampagne Kontakte, einen Pool von Nachrichten und mindestens ein Konto hat. Eine Kampagne ohne Pool oder ohne Konto hat nichts zu senden.
Wie der Versand gestartet wird#
Die veröffentlichte Spezifikation erklärt keine separate Operation „Kampagne starten“. Der Start erfolgt durch Aktualisierung der Kampagne (POST /v2/campaigns/{campaign_id}/update) entweder aus dem Dashboard; welche Felder genau beim Start geändert werden, klären Sie bitte mit den Managern im Bot @NN_official_bot.
Was passiert als Nächstes mit den Dialogen#
Nach der ersten Berührung führt das Gespräch AI gemäß Ihrem Szenario — siehe Chat-Flow. Die Korrespondenz kann manuell über Dialogoperationen gelesen und fortgesetzt werden.
Die Datenbank mit den Ergebnissen zurück exportieren: GET /v2/campaigns/{campaign_id}/contacts/export?format=xlsx.
Weiter#
- Kampagnen und Kontakte in der API — vollständige Liste der Operationen.
- Dialoge — Lesen von Konversationen und Senden von Nachrichten.
- AI Outreach — wie es im Dashboard aussieht.