SparkTG

Effektive Pausen abrufen (v2)-Dokumentation

Effektive Pausen abrufen (v2)

v2

Effektive Pausen abrufen (v2)

Pausenstatus, die Agenten nutzen können, optional für einen Agenten

API v2v21 Endpunkt

Übersicht

Listet die Pausenstatus auf, die Agenten in Ihrem Service nutzen können, zum Beispiel für das Status-Dropdown eines Agenten in einem CRM oder CTI. "Effektiv" bedeutet die Pausen, die Agenten aktuell nutzen können: die Standardpausen, die Ihr Admin nicht deaktiviert hat, plus alle benutzerdefinierten Pausen, die er aktiviert hat. Für den gesamten Service deaktivierte Pausen sind nicht in der Liste. Die Liste gilt immer für den Service des Tokens. Senden Sie agent-id, um zusätzlich zu sehen, welche Pausen ein Admin für diesen Agenten ausgeblendet hat. Nicht abgerechnet.

Verfügbare Endpunkte

GET/api/v2/effective-breaks

Wichtige Parameter

agent-id(Integer)

Die ID des Agenten (die von GET /api/v2/agents zurückgegebene id). Wenn gesendet, kommen Pausen, die ein Admin für diesen Agenten ausgeblendet hat, mit "disabled": true zurück. Weglassen oder leer senden, um die Service-Liste ohne agentenspezifische Kennzeichnungen zu erhalten. Der Agent muss aktiv sein und zum Service des Tokens gehören.

Nutzungsszenarien

Pausen für den gesamten Service

Keine Parameter. Verwenden Sie dies, wenn Sie keinen bestimmten Agenten im Blick haben, zum Beispiel um Pausennamen in einem Bericht anzuzeigen. Antwort gekürzt; ein typischer Service hat etwa ein Dutzend Pausen.

0 ParameterIn den Beispielen verfügbar

Pausen für einen Agenten

Senden Sie agent-id. Hier hat ein Admin Leave für Agent 319 ausgeblendet, daher kommt sie mit "disabled": true zurück. Die Pause bleibt in der Liste, damit Sie Name und Farbe anzeigen können; lassen Sie den Agenten sie nur nicht auswählen.

0 ParameterIn den Beispielen verfügbar

Kurzbeispiel

Testen Sie diese API mit einem einfachen cURL-Befehl

Einfacher API-Aufruf
curl 'https://telephonycloud.co.in/api/v2/effective-breaks' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'
💡 Ersetzen Sie <YOUR_TOKEN> durch Ihr API-Token

Antwortvorschau

Beispielantwort dieser API

Beispielantwort
[{"break_id":0,"label":"Available","icon":"available","color":"#5ccc56","is_system":true,"sort_order":1,"is_deleted":false,"category":"SYSTEM"},{"break_id":1,"label":"Meal","icon":"lunch","color":"#F4...
Vollständiges Antwortformat im Abschnitt „Antwort“ ansehen