CRM-Kampagnen

CRM-Kampagnen verwalten

Mit der CRM Campaigns API erstellen und verwalten Sie Kampagnen, ordnen Kontakte zu, prüfen Einschreibungen und starten Anrufläufe.

Endpunkte

Authentifizierung

Senden Sie Ihren API-Schlüssel im Authorization-Header jeder Anfrage.

curl https://api.talkturo.com/api/crm/campaigns?accountSlug=acme \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

Der API-Schlüssel muss Zugriff auf den angegebenen Workspace besitzen.

Kampagnen auflisten

Mit GET /api/crm/campaigns rufen Sie die Kampagnen eines Workspaces ab. Die Ergebnisse verwenden eine Limit- und Offset-Paginierung.

Abfrageparameter

Anfrage

Antwort

Kampagne erstellen

Mit POST /api/crm/campaigns erstellen Sie eine Kampagne für ein Team und weisen ihr einen Assistant zu.

Body-Parameter

Anfrage

Antwort

Kampagnenfelder

Einzelne Kampagne abrufen

Mit GET /api/crm/campaigns/[id] rufen Sie eine Kampagne anhand ihrer ID ab.

Pfad-Parameter

Abfrageparameter

curl "https://api.talkturo.com/api/crm/campaigns/cmp_7f3a91c2?accountSlug=acme" \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

Kampagne aktualisieren

Mit PUT /api/crm/campaigns/[id] aktualisieren Sie die Einstellungen einer bestehenden Kampagne.

Body-Parameter

curl https://api.talkturo.com/api/crm/campaigns/cmp_7f3a91c2 \
  -X PUT \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r" \
  -H "Content-Type: application/json" \
  -d '{
    "accountSlug": "acme",
    "name": "Q4 renewal outreach - priority",
    "callWindow": {
      "timezone": "America/Los_Angeles",
      "start": "10:00",
      "end": "16:00"
    }
  }'

Kampagne löschen

Mit DELETE /api/crm/campaigns/[id] löschen Sie eine Kampagne.

Kampagnen können nur gelöscht werden, wenn sie den Status draft oder cancelled haben. Entfernen Sie Kontakte nicht einzeln, um eine aktive Kampagne zu stoppen. Verwenden Sie stattdessen den vorgesehenen Kampagnenstatus oder beenden Sie den laufenden Prozess.

curl "https://api.talkturo.com/api/crm/campaigns/cmp_7f3a91c2?accountSlug=acme" \
  -X DELETE \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

Kontakte verwalten

Mit den Unterendpunkten /api/crm/campaigns/[id]/contacts können Sie die Kontakte einer Kampagne auflisten und neue Kontakte hinzufügen.

Kontakte auflisten

GET /api/crm/campaigns/[id]/contacts gibt die Kontakte der Kampagne zurück.

curl "https://api.talkturo.com/api/crm/campaigns/cmp_7f3a91c2/contacts?accountSlug=acme&limit=50&offset=0" \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

Kontakte hinzufügen

Mit POST /api/crm/campaigns/[id]/contacts fügen Sie Kontakte anhand ihrer IDs, einzelner Kontaktdaten oder einer Audience hinzu.

curl https://api.talkturo.com/api/crm/campaigns/cmp_7f3a91c2/contacts \
  -X POST \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r" \
  -H "Content-Type: application/json" \
  -d '{
    "accountSlug": "acme",
    "contactIds": ["contact_8c2f6a10", "contact_19d4b7e2"]
  }'

Kampagnen-Dashboard abrufen

Mit GET /api/crm/campaigns/[id]/dashboard rufen Sie die zusammengefassten Kampagnenkennzahlen ab.

Die Antwort enthält Zählwerte, die aktuelle Anrufwarteschlange und die letzten Anrufe.

Antwortfelder

curl "https://api.talkturo.com/api/crm/campaigns/cmp_7f3a91c2/dashboard?accountSlug=acme" \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

Kampagnenlauf starten

Mit POST /api/crm/campaigns/[id]/run starten Sie einen Anruflauf für eine Kampagne.

Body-Parameter

curl https://api.talkturo.com/api/crm/campaigns/cmp_7f3a91c2/run \
  -X POST \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r" \
  -H "Content-Type: application/json" \
  -d '{
    "accountSlug": "acme",
    "maxCalls": 25,
    "dryRun": true
  }'

Einschreibung vorab prüfen

Mit POST /api/crm/campaigns/preview-enrollment prüfen Sie, welche Kontakte für eine Einschreibung ausgewählt würden, bevor Sie sie einer Kampagne hinzufügen.

Body-Parameter

curl https://api.talkturo.com/api/crm/campaigns/preview-enrollment \
  -X POST \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r" \
  -H "Content-Type: application/json" \
  -d '{
    "accountSlug": "acme",
    "campaignId": "cmp_7f3a91c2",
    "contactIds": ["contact_8c2f6a10", "contact_19d4b7e2"]
  }'

Outbound-Assistenten auflisten

Mit GET /api/crm/outbound-assistants rufen Sie die Assistants ab, die für ausgehende Kampagnen verwendet werden können.

curl "https://api.talkturo.com/api/crm/outbound-assistants?accountSlug=acme" \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

CRM-Anrufe abrufen

Mit GET /api/crm/calls rufen Sie die Anrufe ab, die mit CRM-Kampagnen verbunden sind.

curl "https://api.talkturo.com/api/crm/calls?accountSlug=acme&campaignId=cmp_7f3a91c2&limit=25&offset=0" \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

CRM-Intelligence abrufen

Mit GET /api/crm/intelligence rufen Sie CRM-Intelligence-Daten für einen Workspace oder eine Kampagne ab.

curl "https://api.talkturo.com/api/crm/intelligence?accountSlug=acme&campaignId=cmp_7f3a91c2" \
  -H "Authorization: Bearer sk_live_example_9xmk7q2r"

Typischer Workflow

Der folgende Ablauf eignet sich für eine neue Kampagne:

Verwandte Ressourcen