CRM-Kampagnen
Ausgehende Anrufkampagnen über die Talkturo-CRM-API erstellen, verwalten und ausführen — Kontakte hinzufügen, Echtzeit-Dashboard-Statistiken überwachen, Kampagnen starten und stoppen sowie Anrufprotokolle und KI-Einblicke abrufen.
curl -X POST "https://app.talkturo.com/api/crm/campaigns" \
-H "Content-Type: application/json" \
-H "Cookie: sb-session=example_session_token" \
-d '{
"name": "Q3 Renewal Outreach",
"assistant_id": "asst_7f3d2c91",
"schedule": {
"timezone": "Europe/Berlin",
"days": ["monday", "tuesday", "wednesday"],
"start_time": "09:00",
"end_time": "17:00"
}
}'
const response = await fetch("https://app.talkturo.com/api/crm/campaigns", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
credentials: "include",
body: JSON.stringify({
name: "Q3 Renewal Outreach",
assistant_id: "asst_7f3d2c91",
schedule: {
timezone: "Europe/Berlin",
days: ["monday", "tuesday", "wednesday"],
start_time: "09:00",
end_time: "17:00"
}
})
});
const campaign = await response.json();
console.log(campaign);
{
"id": "cmp_2d9a4c71",
"name": "Q3 Renewal Outreach",
"assistant_id": "asst_7f3d2c91",
"schedule": {
"timezone": "Europe/Berlin",
"days": ["monday", "tuesday", "wednesday"],
"start_time": "09:00",
"end_time": "17:00"
}
}
curl -X POST "https://app.talkturo.com/api/crm/campaigns/cmp_2d9a4c71/run" \
-H "Content-Type: application/json" \
-H "Cookie: sb-session=example_session_token" \
-d '{
"action": "start"
}'
const response = await fetch("https://app.talkturo.com/api/crm/campaigns/cmp_2d9a4c71/run", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
credentials: "include",
body: JSON.stringify({
action: "start"
})
});
const result = await response.json();
console.log(result);
{
"success": true,
"status": "running"
}
curl "https://app.talkturo.com/api/crm/campaigns/cmp_2d9a4c71/dashboard" \
-H "Cookie: sb-session=example_session_token"
const response = await fetch("https://app.talkturo.com/api/crm/campaigns/cmp_2d9a4c71/dashboard", {
credentials: "include"
});
const dashboard = await response.json();
console.log(dashboard);
{
"total_calls": 148,
"answered": 96,
"failed": 27,
"in_progress": 5
}
curl "https://app.talkturo.com/api/crm/campaigns/cmp_2d9a4c71/contacts" \
-H "Cookie: sb-session=example_session_token"
const response = await fetch("https://app.talkturo.com/api/crm/campaigns/cmp_2d9a4c71/contacts", {
credentials: "include"
});
const contacts = await response.json();
console.log(contacts);
[
{
"id": "cnt_5ce91a20",
"first_name": "Maya",
"last_name": "Schneider",
"phone": "+493012345678",
"email": "maya.schneider@northstar-industries.com"
},
{
"id": "cnt_88db41ef",
"first_name": "Jonas",
"last_name": "Weber",
"phone": "+498912345678",
"email": "jonas.weber@helios-logistik.de"
}
]
CRM-Kampagnen für ausgehende Anrufe verwalten
Mit den CRM-Kampagnen-Endpunkten erstellen und steuern Sie ausgehende Anrufkampagnen in Talkturo. Sie können Kampagnen anlegen, Kontakte zuordnen, eine Kampagne starten oder stoppen und den aktuellen Fortschritt über Dashboard-Statistiken verfolgen.
Alle Endpunkte in diesem Bereich verwenden Sitzungsauthentifizierung. Rufen Sie diese API daher aus einer angemeldeten Talkturo-Sitzung heraus auf.
Die Kampagnen-API deckt den Kampagnenablauf selbst ab. Für verfügbare Outbound-Assistenten, Anrufprotokolle und KI-Einblicke stehen separate CRM-Endpunkte bereit, die in der Übersicht unten mit aufgeführt sind.
Endpunktübersicht
| Methode | Pfad | Zweck |
|---|---|---|
GET | /api/crm/campaigns | Kampagnen auflisten |
POST | /api/crm/campaigns | Kampagne erstellen |
GET | /api/crm/campaigns/[id] | Kampagne abrufen |
PATCH | /api/crm/campaigns/[id] | Kampagne aktualisieren |
DELETE | /api/crm/campaigns/[id] | Kampagne löschen |
GET | /api/crm/campaigns/[id]/contacts | Kontakte einer Kampagne auflisten |
POST | /api/crm/campaigns/[id]/contacts | Kontakte zu einer Kampagne hinzufügen |
GET | /api/crm/campaigns/[id]/dashboard | Echtzeit-Statistiken einer Kampagne abrufen |
POST | /api/crm/campaigns/[id]/run | Kampagne starten oder stoppen |
GET | /api/crm/outbound-assistants | Für Outbound verfügbare Assistenten auflisten |
GET | /api/crm/calls | Anrufprotokolle auflisten |
GET | /api/crm/intelligence | KI-Einblicke abrufen |
Kampagne erstellen
Erstellen Sie eine Kampagne mit einem Namen und optional mit einem zugewiesenen Assistenten oder einem Zeitplan.
Request-Body
Name der Kampagne.
ID des Assistenten, der die ausgehenden Anrufe für diese Kampagne ausführen soll.
Optionaler Zeitplan für die Kampagne. Die genaue Objektstruktur ist implementierungsabhängig; übergeben Sie ein JSON-Objekt mit den gewünschten Planungswerten.
Antwort
Eindeutige ID der erstellten Kampagne.
Name der Kampagne.
ID des zugewiesenen Outbound-Assistenten, falls gesetzt.
Gespeicherte Planungseinstellungen der Kampagne, falls übermittelt.
Wenn Sie eine Kampagne direkt nach der Erstellung ausführen möchten, weisen Sie zuerst einen passenden Outbound-Assistenten zu und fügen Sie anschließend Kontakte hinzu. Danach kann der Endpunkt zum Starten der Kampagne den Lauf anstoßen.
Kampagne starten oder stoppen
Mit dem Run-Endpunkt steuern Sie den Laufstatus einer vorhandenen Kampagne. Senden Sie start, um die Kampagne zu starten, oder stop, um sie anzuhalten.
Pfadparameter
ID der Kampagne, die Sie starten oder stoppen möchten.
Request-Body
Legt fest, ob die Kampagne gestartet oder gestoppt wird.
startstopAntwort
Gibt an, ob die Aktion erfolgreich ausgeführt wurde.
Aktueller Status der Kampagne nach der Aktion.
Echtzeit-Dashboard-Statistiken abrufen
Das Kampagnen-Dashboard liefert einen kompakten Überblick über den aktuellen Fortschritt. Sie erhalten Zähler für alle Anrufe sowie für beantwortete, fehlgeschlagene und laufende Anrufe.
Pfadparameter
ID der Kampagne, deren Dashboard-Daten Sie abrufen möchten.
Antwort
Gesamtzahl der zur Kampagne erfassten oder ausgeführten Anrufe.
Anzahl beantworteter Anrufe.
Anzahl fehlgeschlagener Anrufe.
Anzahl aktuell laufender Anrufe.
Kampagnenkontakte auflisten
Rufen Sie die einer Kampagne zugeordneten Kontakte über den Kontakt-Endpunkt der Kampagne ab. Dieser Endpunkt unterstützt außerdem POST, um zusätzliche Kontakte zu einer vorhandenen Kampagne hinzuzufügen.
Pfadparameter
ID der Kampagne, deren Kontakte Sie abrufen möchten.
Antwortsfelder
Eindeutige ID des Kontakts.
Vorname des Kontakts.
Nachname des Kontakts.
Telefonnummer des Kontakts.
E-Mail-Adresse des Kontakts, falls vorhanden.
Nutzen Sie POST /api/crm/campaigns/[id]/contacts, um Kontakte derselben Kampagne hinzuzufügen. Für die Verwaltung einzelner Kontakte selbst stehen die CRM-Kontakt-Endpunkte unter /api/crm/contacts bereit.