Rückrufe werden von einem Endnutzer angefordert. Mit der API für Rückrufe können Sie Rückrufe programmatisch planen und geplante Anrufe stornieren. So können Sie Anwendungen erstellen, mit denen Endnutzer Rückrufe aus einer von Ihnen angegebenen Warteschlange anfordern können. Endnutzer können auch Anrufe stornieren, die sie zuvor geplant haben. Informationen zur Authentifizierung mit der API für Rückrufe finden Sie unter Basisauthentifizierung.
API für Rückrufe verwenden
Mit der API für Rückrufe können Sie Rückrufe planen und geplante Anrufe stornieren.
Anruf planen
Wenn Ihre Instanz in Salesforce eingebunden ist, prüfen Sie die Einstellung Optionen für geschlossene Datensätze beim Initiieren eines per API geplanten Anrufs unter Einstellungen > Betriebsmanagement > Details zur CRM-Datensatzerstellung. Planungsanfragen werden
mit 422 abgelehnt, wenn Datensatzstatus nicht prüfen ausgewählt ist. Dies gilt nicht für Zendesk oder ServiceNow.
Rufen Sie zum Planen eines Anrufs POST https://<subdomain>.<domain>/apps/api/v1/calls
auf und fügen Sie einen Anfragetext ähnlich dem 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 stornieren
Rufen Sie zum Stornieren eines geplanten Anrufs PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel auf. Geben Sie die ID des Anrufs an, den Sie stornieren möchten.
Bei einer erfolgreichen Anfrage werden Informationen zum stornierten Anruf zurückgegeben.
Mehrere geplante Anrufe stornieren
Rufen Sie zum Stornieren mehrerer geplanter Anrufe PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel auf. Fügen Sie einen Anfragetext mit einem call_ids-Array der Anruf-IDs als Ganzzahlen für die zu stornierenden Anrufe ein. Ein Wert, der kein Array ist oder einen Eintrag enthält, der keine Ganzzahl ist, wird mit 400 abgelehnt.
Hier ein Codebeispiel:
{
"call_ids": [123, 456, 789]
}
Bei einer erfolgreichen Anfrage wird eine Antwort mit einem Antwortheader zurückgegeben, der eine Location-URL zum Prüfen des Status der Stornierung 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 Verhalten bei Rückrufen
Wenn Sie ein unterstütztes CRM (Salesforce, Zendesk oder ServiceNow) verwenden, wirken sich die folgenden Bedingungen auf das Verhalten bei geplanten Rückrufen aus:
Ein Datensatz ist geöffnet und hat bereits einen aktiven geplanten Anruf: Wenn eine Suche nach der Ticket ID ergibt, dass der Datensatz geöffnet ist und bereits einen aktiven geplanten Anruf hat, wird der Anruf nicht geplant. Dem CRM-Datensatz wird der folgende Kommentar angehängt:
A scheduled call was not created because the record already has an active scheduled call.Das CRM ist nicht erreichbar: Wenn eine Suche nach der Ticket-ID ergibt, dass das CRM nicht erreichbar ist, wird der Anruf storniert. Dem CRM-Datensatz wird der folgende Kommentar angehängt:
A scheduled call was canceled because the CRM was unreachable.
Verhalten bei Rückrufen mit geschlossenen Datensätzen
Die Art und Weise, wie Rückrufe für geschlossene Datensätze verarbeitet werden, hängt davon ab, welches CRM Sie verwenden:
Zendesk- und ServiceNow-Nutzer: Wenn eine Suche nach der Ticket-ID ergibt, dass der Datensatz geschlossen ist, wird der Anruf nicht geplant. Dem CRM-Datensatz wird der folgende Kommentar angehängt:
A scheduled call was not created because the record is closed.Salesforce-Nutzer: Unter Rückrufe mit Salesforce konfigurieren Sie, wie Ihre Instanz geplante Anrufe für geschlossene Datensätze verarbeitet.
Rückrufe mit Salesforce
Wenn Sie die CCAI Platform in Salesforce eingebunden haben, können Sie konfigurieren, wie Ihre Instanz geplante Anrufe für geschlossene Datensätze verarbeitet. Hier sind die Konfigurationsoptionen für Salesforce-Integrationen:
Datensatzstatus prüfen und geschlossene Datensätze wieder öffnen.
Datensatzstatus prüfen und geplante Anrufe für geschlossene Datensätze stornieren
Datensatzstatus nicht prüfen
Sie können die CCAI Platform so konfigurieren, dass der Datensatzstatus vor einem geplanten Anruf nicht geprüft wird. Wenn diese Option ausgewählt ist, werden Anfragen zum Planen eines Anrufs über die API für Rückrufe mit 422 abgelehnt.
So konfigurieren Sie die CCAI Platform, damit der Datensatzstatus nicht geprüft wird:
Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebs management. Wenn das Menü Einstellungen nicht angezeigt wird, klicken Sie auf Menü.
Gehen Sie zu Details zur CRM-Datensatzerstellung > Optionen für geschlossene Datensätze beim Initiieren eines per API geplanten Anrufs.
Wählen Sie Datensatzstatus nicht prüfen. Per API geplanten Anruf immer initiieren aus.
Klicken Sie auf Allgemein speichern.
Datensatzstatus prüfen und geschlossene Datensätze wieder öffnen
Sie können die CCAI Platform so konfigurieren, dass der Datensatzstatus vor einem geplanten Anruf geprüft wird und geschlossene Datensätze wieder geöffnet werden. Wenn der Datensatzstatus „geschlossen“ ist, werden bei dieser Konfiguration die folgenden Aktionen ausgeführt:
Der Anruf wird wie geplant ausgeführt.
Der Datensatz wird wieder geöffnet.
Dem CRM-Datensatz wird der folgende Kommentar angehängt:
The record was reopened at the time of a scheduled call.
So konfigurieren Sie die CCAI Platform, damit der Datensatzstatus geprüft wird und geschlossene Datensätze wieder geöffnet werden:
Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebs management. Wenn das Menü Einstellungen nicht angezeigt wird, klicken Sie auf Menü.
Gehen Sie zu Details zur CRM-Datensatzerstellung > Optionen für geschlossene Datensätze beim Initiieren eines per API geplanten Anrufs.
Wählen Sie Datensatzstatus prüfen aus. Wenn der Datensatz geschlossen ist > Datensatz wieder öffnen.
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 wird und geplante Anrufe für geschlossene Datensätze storniert werden. Wenn der Datensatzstatus „geschlossen“ ist, werden bei dieser Konfiguration die folgenden Aktionen ausgeführt:
Der geplante Anruf wird storniert.
Dem CRM-Datensatz wird der folgende Kommentar angehängt:
A scheduled call was canceled because the record is closed.
So konfigurieren Sie die CCAI Platform, damit der Datensatzstatus geprüft wird und geplante Anrufe für geschlossene Datensätze storniert werden:
Klicken Sie im CCAI Platform-Portal auf Einstellungen > Betriebs management. Wenn das Menü Einstellungen nicht angezeigt wird, klicken Sie auf Menü.
Gehen Sie zu Details zur CRM-Datensatzerstellung > Optionen für geschlossene Datensätze beim Initiieren eines per API geplanten Anrufs.
Wählen Sie Datensatzstatus prüfen aus. Wenn der Datensatz geschlossen ist > Geplanten Anruf stornieren.
Klicken Sie auf Allgemein speichern.