Callback Call API

Rückrufe sind Anrufe, die von einem Endnutzer angefordert werden. Mit der Callback-API können Sie Callback-Anrufe programmatisch planen und geplante Anrufe abbrechen. Mit diesen Funktionen können Sie Anwendungen erstellen, mit denen Endnutzer Rückrufe aus einer von Ihnen angegebenen Warteschlange anfordern können. Endnutzer können auch Anrufe absagen, die sie zuvor geplant haben. Informationen zur Authentifizierung mit der Callback-API finden Sie unter Basisauthentifizierung.

Callback-API verwenden

Mit der Callback-API können Sie Rückrufe planen und geplante Anrufe abbrechen.

Termin für ein Gespräch vereinbaren

Rufen Sie zum Planen eines Anrufs POST https://<subdomain>.<domain>/apps/api/v1/calls auf und fügen Sie einen Anfragetext wie den folgenden ein:

{
    "call_type": "ScheduledCall",
    "menu_id": 12345,
    "end_user_number": "+18005550100",
    "scheduled_at": "2025-09-02T14:30:00Z"
}

Bei einer erfolgreichen Anfrage wird ein Anrufobjekt zurückgegeben, das die Anruf-ID enthält.

Geplanten Anruf abbrechen

Wenn Sie einen geplanten Anruf abbrechen möchten, rufen Sie PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel an. Geben Sie die ID des Anrufs an, den Sie abbrechen möchten.

Bei einer erfolgreichen Anfrage werden Informationen zum abgebrochenen Anruf zurückgegeben.

Mehrere geplante Anrufe abbrechen

Wenn Sie mehrere geplante Anrufe gleichzeitig kündigen möchten, rufen Sie PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel an. Fügen Sie einen Anfragetext ein, der ein call_ids-Array mit den Anruf-IDs der zu stornierenden Anrufe enthält.

Hier ein Codebeispiel:

{
    "call_ids": [123, 456, 789]
}

Eine erfolgreiche Anfrage gibt eine Antwort mit einem Antwortheader zurück, der eine Location-URL zum Prüfen des Status der Kündigung enthält.

Rückrufe mit CRMs verwenden

Sie können die API für Rückrufe mit Salesforce-, Zendesk- und ServiceNow-CRM-Integrationen verwenden.

Allgemeines Rückrufverhalten

Wenn Sie ein unterstütztes CRM (Salesforce, Zendesk oder ServiceNow) verwenden, gelten für das Verhalten geplanter Rückrufe die folgenden Bedingungen:

Ein Datensatz ist offen und hat bereits einen aktiven geplanten Anruf: Wenn bei der Suche nach der Ticket-ID angegeben wird, dass der Datensatz offen ist und bereits einen aktiven geplanten Anruf hat, wird der Anruf nicht geplant. Der folgende Kommentar ist an den CRM-Datensatz angehängt: A scheduled call was not created because the record already has an active scheduled call.
Das CRM ist nicht erreichbar: Wenn bei der Suche nach einer Ticket-ID angegeben wird, dass das CRM nicht erreichbar ist, wird der Anruf beendet. Der folgende Kommentar ist an den CRM-Datensatz angehängt: A scheduled call was canceled because the CRM was unreachable.

Callback-Verhalten bei geschlossenen Datensätzen

Wie Rückrufe für geschlossene Datensätze behandelt werden, hängt davon ab, welches CRM Sie verwenden:

Zendesk- und ServiceNow-Nutzer: Wenn bei der Suche nach einer Ticket-ID angezeigt wird, dass der Datensatz geschlossen ist, wird der Anruf nicht geplant. Der folgende Kommentar ist an den CRM-Datensatz angehängt: A scheduled call was not created because the record is closed.
Salesforce-Nutzer:Informationen dazu, wie Ihre Instanz geplante Anrufe für geschlossene Datensätze verarbeitet, finden Sie unter Rückrufe mit Salesforce.

Rückrufe mit Salesforce

Wenn Sie die CCAI Platform in Salesforce integriert haben, können Sie konfigurieren, wie Ihre Instanz geplante Anrufe für geschlossene Datensätze verarbeitet. Hier finden Sie die Konfigurationsoptionen für Salesforce-Integrationen:

Den Status des Datensatzes nicht prüfen:
Eintragstatus prüfen und geschlossene Einträge wieder öffnen
Status von Datensätzen prüfen und geplante Anrufe für geschlossene Datensätze stornieren

Datensatzstatus nicht prüfen

Sie können CCAI Platform so konfigurieren, dass der Aufzeichnungsstatus vor einem geplanten Anruf nicht geprüft wird. Bei dieser Konfiguration wird der Anruf wie geplant ausgeführt, unabhängig davon, ob der Datensatz geöffnet oder geschlossen ist.

So konfigurieren Sie die CCAI-Plattform so, dass der Datensatzstatus nicht geprüft wird:

Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebsverwaltung. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.
Weitere Informationen finden Sie unter Details zur Erstellung von CRM-Einträgen.
Wählen Sie Eintragstatus nicht prüfen aus. Immer den API-geplanten Aufruf initiieren.
Klicken Sie auf Allgemein speichern.

Datensatzstatus prüfen und geschlossene Datensätze wieder öffnen

Sie können CCAI Platform so konfigurieren, dass der Datensatzstatus vor einem geplanten Anruf geprüft und geschlossene Datensätze wieder geöffnet werden. Wenn der Datensatzstatus „Geschlossen“ ist, werden mit dieser Konfiguration die folgenden Aktionen ausgeführt:

Der Anruf wird wie geplant getätigt.
Der Eintrag wird wieder geöffnet.
Der folgende Kommentar ist an den CRM-Datensatz angehängt: The record was reopened at the time of a scheduled call.

So konfigurieren Sie die CCAI-Plattform, damit der Datensatzstatus geprüft und geschlossene Datensätze wieder geöffnet werden:

Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebsverwaltung. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.
Weitere Informationen finden Sie unter Details zur Erstellung von CRM-Einträgen.
Wählen Sie Eintragstatus prüfen aus. Wenn der Datensatz geschlossen ist, >öffnen Sie ihn wieder.
Klicken Sie auf Allgemein speichern.

Datensatzstatus prüfen und geplante Anrufe für geschlossene Datensätze stornieren

Sie können die CCAI Platform so konfigurieren, dass der Datensatzstatus vor einem geplanten Anruf geprüft und geplante Anrufe für geschlossene Datensätze abgebrochen werden. Wenn der Datensatzstatus „Geschlossen“ ist, werden die folgenden Aktionen ausgeführt:

Der geplante Anruf wurde abgesagt.
Der folgende Kommentar ist an den CRM-Datensatz angehängt: A scheduled call was canceled because the record is closed.

So konfigurieren Sie die CCAI-Plattform, damit der Aufzeichnungsstatus geprüft und geplante Anrufe für geschlossene Datensätze abgebrochen werden:

Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebsverwaltung. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.
Weitere Informationen finden Sie unter Details zur Erstellung von CRM-Einträgen.
Wählen Sie Eintragstatus prüfen aus. Wenn der Eintrag geschlossen ist, >sollten Sie den geplanten Anruf absagen.
Klicken Sie auf Allgemein speichern.