Callback Call API

Rückrufe sind Anrufe, die von einem Endnutzer angefordert werden. Mit der Callback Call API können Sie Rückrufe 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 von ihnen geplante Anrufe abbrechen. Informationen zur Authentifizierung mit der Callback-Aufruf-API finden Sie unter Basisauthentifizierung.

Callback Call API verwenden

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

Telefontermin vereinbaren

Wenn Sie einen Aufruf planen möchten, rufen Sie 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, einschließlich der Anruf-ID.

Geplanten Anruf absagen

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

Bei einer erfolgreichen Anfrage wird ein 200 OK mit dem aktualisierten Anrufobjekt zurückgegeben. Der status des Anrufobjekts ist cancelled, wenn der Anruf auf die geplante Zeit gewartet hat oder in die Warteschlange eingetreten ist oder dort gewartet hat, und completed, wenn Sie einen aktiven Rückruf des virtuellen Kundenservicemitarbeiters abbrechen, der bereits den ersten Wählversuch unternommen hat. Wenn der Aufruf bereits abgebrochen wurde, gibt die Anfrage 204 No Content mit einem leeren Text zurück. Eine Anfrage für einen Aufruf, der bereits aus einem anderen Grund als einem Abbruch fehlgeschlagen ist oder sich in einem Zustand befindet, der nicht abgebrochen werden kann, gibt 400 zurück.

Mehrere geplante Anrufe absagen

Wenn Sie mehrere geplante Anrufe abbrechen möchten, rufen Sie PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel auf. Fügen Sie einen Anfragetext mit einem call_ids-Array der Aufruf-IDs für die abzubrechenden Aufrufe ein.

Hier ein Codebeispiel:

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

Eine erfolgreiche Anfrage gibt einen 202 Accepted mit einem Location-Antwortheader zurück, der auf eine Jobressource verweist, die Sie auf Fertigstellung abfragen können. Die Antwort 202 Accepted bedeutet nicht, dass alle Aufrufe bereits abgebrochen wurden. Folgen Sie dem Header Location, um den Abschluss zu bestätigen und Teilfehler zu prüfen.

Callback-Anrufe mit CRMs verwenden

Sie können die Callback Calls API mit Salesforce-, Zendesk- und ServiceNow-CRM-Integrationen verwenden.

Allgemeines Callback-Verhalten

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

  • Ein Datensatz ist offen und es gibt bereits einen aktiven geplanten Anruf: Wenn eine Ticket-ID-Suche ergibt, dass der Datensatz offen ist und bereits ein aktiver geplanter Anruf vorhanden ist, wird der Anruf nicht geplant. Der folgende Kommentar ist an den CRM-Eintrag angehängt: A scheduled call was not created because the record already has an active scheduled call.

  • Das CRM ist nicht erreichbar: Wenn eine Ticket-ID-Suche ergibt, dass das CRM nicht erreichbar ist, wird der Anruf abgebrochen. Der folgende Kommentar ist an den CRM-Eintrag angehängt: A scheduled call was canceled because the CRM was unreachable.

Rückrufverhalten bei geschlossenen Datensätzen

Wie Rückrufe für geschlossene Datensätze verarbeitet werden, hängt vom verwendeten CRM ab:

  • Zendesk- und ServiceNow-Nutzer: Wenn bei der Suche nach einer Ticket-ID festgestellt wird, dass der Datensatz geschlossen ist, wird der Anruf nicht geplant. Der folgende Kommentar ist an den CRM-Eintrag angehängt: A scheduled call was not created because the record is closed.

  • Salesforce-Nutzer:Unter Rückrufe mit Salesforce erfahren Sie, wie Sie konfigurieren, wie Ihre Instanz mit geplanten Anrufen für geschlossene Datensätze umgeht.

Rückrufe mit Salesforce

Wenn Sie die CCAI Platform in Salesforce eingebunden haben, können Sie konfigurieren, wie Ihre Instanz mit geplanten Anrufen für geschlossene Datensätze umgeht. Hier sind die Konfigurationsoptionen für Salesforce-Integrationen:

Eintragsstatus nicht prüfen

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

So konfigurieren Sie die CCAI Platform so, dass der Aufzeichnungsstatus nicht geprüft wird:

  1. Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebsverwaltung. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.

  2. Gehen Sie zu Details zur Erstellung von CRM-Einträgen > Optionen für geschlossene Einträge beim Initiieren eines API-geplanten Anrufs.

  3. Wählen Sie Datensatzstatus nicht prüfen aus. Initiieren Sie immer den über die API geplanten Anruf.

  4. Klicken Sie auf Allgemeine Einstellungen speichern.

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

Sie können die CCAI-Plattform so konfigurieren, dass der Datensatzstatus vor einem geplanten Anruf geprüft wird und geschlossene Datensätze wieder geöffnet werden. Wenn der Datensatzstatus bei dieser Konfiguration „Geschlossen“ ist, werden 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-Eintrag angehängt: The record was reopened at the time of a scheduled call.

So konfigurieren Sie die CCAI-Plattform, um den Datensatzstatus zu prüfen und geschlossene Datensätze wieder zu öffnen:

  1. Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebsverwaltung. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.

  2. Gehen Sie zu Details zur Erstellung von CRM-Einträgen > Optionen für geschlossene Einträge beim Initiieren eines API-geplanten Anrufs.

  3. Wählen Sie Eintragsstatus prüfen aus. Wenn der Datensatz geschlossen ist, > öffnen Sie ihn wieder.

  4. Klicken Sie auf Allgemeine Einstellungen 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 wird und geplante Anrufe für geschlossene Datensätze abgebrochen werden. Wenn der Datensatzstatus bei dieser Konfiguration „Geschlossen“ ist, werden die folgenden Aktionen ausgeführt:

  • Der geplante Anruf wird abgesagt.

  • Der folgende Kommentar ist an den CRM-Eintrag angehängt: A scheduled call was canceled because the record is closed.

So konfigurieren Sie die CCAI Platform, um den Datensatzstatus zu prüfen und geplante Anrufe für geschlossene Datensätze abzubrechen:

  1. Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebsverwaltung. Wenn Sie das Menü Einstellungen nicht sehen, klicken Sie auf Menü.

  2. Gehen Sie zu Details zur Erstellung von CRM-Einträgen > Optionen für geschlossene Einträge beim Initiieren eines API-geplanten Anrufs.

  3. Wählen Sie Eintragsstatus prüfen aus. Wenn der Eintrag geschlossen ist > Geplanten Anruf abbrechen.

  4. Klicken Sie auf Allgemeine Einstellungen speichern.