Zum Hauptinhalt gehen

  Artikel aktualisiert: 04. Januar 2022

Sparkcentral Echtzeit-Metriken-API

Die Echtzeit-Metriken-API bietet Ihnen direkten Zugriff auf Echtzeitmetriken in der Sparkcentral Plattform über eine bequeme und sichere RESTful-API. Die API bietet Sparkcentral-Kunden die Möglichkeit, sich in interne Contact Center-Dashboards in Verbindung mit anderen traditionellen und/oder digitalen Kommunikationskanälen wie Telefon, E-Mail, Live-Chat usw. zu integrieren.

Echtzeit-Metriken, die API verwendet

Wenn Sie Software erstellen, können Sie die API verwenden, um Ihre Kunden zu gewinnen, indem Sie:

  • Anzeige der aktuellen Wartezeit für Kunden in einer mobilen Anwendung oder Website.

Wenn Sie ein Unternehmen sind, können Sie die API verwenden, um interne Geschäftsprozesse zu rationalisieren, indem Sie:

  • Anzeige des aktuellen Rückstands und wichtiger Kennzahlen auf digitalen Kanälen zusammen mit anderen Contact Center-Medien auf intern gepflegten Echtzeit-Dashboards.
  • Halten Sie interne Stakeholder auf dem Laufenden, indem Sie über stündliche Trends der& Volumenrückstandsstatistiken über digitale Kanäle hinweg berichten, um Agenten effizient zu einem anderen Kanal zu leiten, wenn die Volumenspitzen

Unterstützte Netzwerke

Sparkcentral ist bestrebt, die meisten Messaging-Netzwerke auf dem Markt mit den umfangreichsten Funktionen zu unterstützen. Heute können Sie Sparkcentral verwenden, um sich über Folgendes zu unterhalten:

  • Facebook
  • Twitter
  • Instagram
  • MessageBird
  • In-App-Nachrichten
  • WhatsApp
  • Twilio
  • WeChat
  • Mailgun
  • Telegram
  • Viber

Jetzt anfangen

Für den Zugriff auf die Sparkcentral Proactive-Messaging-Endpunkte sind Zugriffsschlüssel erforderlich. Benutzer mit Zugriff auf Administratorebene können Schlüssel in den Admin-Einstellungen generieren, indem sie Integration und APIs erweitern und Rest-API-Schlüssel auswählen.

Authentifizierung

Die Echtzeit-Metrik-API verwendet den Grant-Ablauf der Oauth 2.0-Spezifikation für Clientanmeldeinformationen für die Clientauthentifizierung und -autorisierung. Clients erhalten eine client_id und client_secret, um sich beim Autorisierungsserver von Sparkcentral zu authentifizieren und erhalten ein access_token, das für die Autorisierung von API-Anfragen verwendet werden kann. Das access_token sollte in einem Autorisierungs-Header verwendet werden, kann aber optional als Abfragezeichenfolgenparameter übergeben werden (siehe Details zu Request/Response weiter unten in diesem Artikel). Wenn das access_token abläuft, gibt die API einen nicht autorisierten 401 zurück. Der Client kann dies automatisieren, indem er ein neues Zugriffstoken generiert und die fehlgeschlagene Anforderung mit dem neuen Zugriffstoken wiedergibt, wie im folgenden Abschnitt dokumentiert.

Zuweisen von Clientan

Rufen Sie ein access_token ab, um autorisierte API-Anfragen zu stellen. Wenn das access_token abläuft, generieren Sie mit diesem Endpunkt ein neues Token.

Anfrage

Kopieren
US-Plattform: 
$ curl -X POST https://public-api.sparkcentral.com/oauth2/token -H 'Inhaltstyp: application/x-www-form-urlencoded' -d 'grant_type=client_credentials& Client_ID=Your_Client_ID=Your_Client_ID_Here Client_Id_Here& Client_Secret=Your_Client_ SECRET_HERE&
scope=client-Lese-EU-Plattform:
$ curl -X POST https://public-api-eu.sparkcentral.com/oauth2/token -H 'Inhaltstyp: application/x-www-form-urlencoded' -d 'grant_type=client_credentials& client_id=Your_ CLIENT_ID_HERE& Client_Secret=Your_Client_Secret_Here& scope=Client-Lese-Client'
Anforderung von Parametern, Status und Beschreibungen
Parameter Status Beschreibung
grant_type erforderlich Muss auf client_credentials eingestellt sein
client_id erforderlich Sparkcentral hat die Kundenkennung angegeben
client_secret erforderlich Sparkcentral stellte Kundengeheimnis zur Verfügung
Geltungsbereich erforderlich Muss auf client-Lesen eingestellt sein

Antwort

Kopieren
{ “token_type”: “bearer”, “access_token”: “a1b2c3d4e5f6”, “expires_in”: 43200 }
Response-Parameter und Beschreibungen
Parameter Beschreibung
token_type Der Tokentyp, der im Autorisierungsheader verwendet werden soll. Dies wird immer Träger für die Erteilung von Client-Anmeldeinformationen sein.
access_token Das Token, das zur Autorisierung von Anfragen verwendet wurde. Dies sollte den Anfragen als Autorisierungsheader hinzugefügt werden: Autorisierung: Inhaber a1b2c3d4e5f6. Die API akzeptiert auch access_token als Abfragezeichenfolgenparameter; die Verwendung des Autorisierungsheaders ist jedoch die bevorzugte Methode.
expires_in Die Anzahl der Sekunden bis zum Ablauf des Tokens (12 Stunden)

Daten-APIs

Volumen für eingehende Nachrichten

Eine Anzahl eingehender Nachrichten basierend auf angewendeten Filtern.

Beispiel URI:

GET /reporting-metrics/inbound-message-volume

URI-Parameter

URI-Parameter
   
von

string (erforderlich)

Eine ISO-8601-Datumszeit, die den inklusiven Beginn des Ergebnisses markiert. Muss URL-codiert sein. Der von Filter kann in der Vergangenheit maximal 14 Tage betragen.

zu

string (optional)

Eine ISO-8601-Datumszeit, die das exklusive Ende des Ergebnisses markiert. Muss URL-codiert sein. Wenn kein Filtern angegeben wird, werden die bisher gesendeten Nachrichten einbezogen.

MediumId

string (optional)

Filtern Sie nach mittlerer Kennung. Wenn kein MediumID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Medien gesendet werden, eingeschlossen. Wahlmöglichkeiten: fb twit instagram messagebird rtm whatsapp twilio wechat Mailgun Telegramm Viber

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

GroupByInterval

string (optional)

Ein Intervall zum Gruppieren von Ergebnissen. Wenn kein GroupByInterval angegeben wird, wird die Gesamtzahl für Nachrichten zurückgegeben, die mit bestimmten Filtern übereinstimmen. Auf Anfrage können nicht mehr als 60 Intervalle angefordert werden. Wenn Sie beispielsweise Minute auswählen, darf der angeforderte Zeitraum nicht länger als 1 Stunde sein. Auswahl: Minutenstunden-Tag

Zeitzone

string (optional)

Der Name der Zeitzone, der in Verbindung mit GroupByInterval verwendet werden soll, z. B. America/Los_Angeles. Muss URL-codiert sein. Wenn keine Zeitzone angegeben wird, wird die Standardzeitzone „UTC“ verwendet.

Volume für ausgehende Nachrichten

Eine Anzahl ausgehender Nachrichten basierend auf angewendeten Filtern.

Beispiel URI:

GET /reporting-metrics/outbound-message-volume

URI-Parameter

URI-Parameter
   
von

string (erforderlich)

Eine ISO-8601-Datumszeit, die den inklusiven Beginn des Ergebnisses markiert. Muss URL-codiert sein. Der von Filter kann in der Vergangenheit maximal 14 Tage betragen.

zu

string (optional)

Eine ISO-8601-Datumszeit, die das exklusive Ende des Ergebnisses markiert. Wenn kein Filtern angegeben wird, werden die bisher gesendeten Nachrichten einbezogen.

MediumId

string (optional)

Filtern Sie nach mittlerer Kennung. Wenn kein MediumID-Filter bereitgestellt wird, werden die an alle verbundenen Medien gesendeten Nachrichten eingeschlossen. Wahlmöglichkeiten: fb twit instagram messagebird rtm whatsapp twilio wechat Mailgun Telegramm Viber

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

GroupByInterval

string (optional)

Ein Intervall zum Gruppieren von Ergebnissen. Wenn kein GroupByInterval angegeben wird, wird die Gesamtzahl für Nachrichten zurückgegeben, die mit bestimmten Filtern übereinstimmen. Auf Anfrage können nicht mehr als 60 Intervalle angefordert werden. Wenn Sie beispielsweise Minute auswählen, darf der angeforderte Zeitraum nicht länger als 1 Stunde sein. Auswahl: Minutenstunden-Tag

Zeitzone

string (optional)

Der Zeitzonenname, der in Verbindung mit GroupByInterval verwendet werden soll. Muss URL-codiert sein. Wenn keine Zeitzone angegeben wird, wird die Standardzeitzone „UTC“ verwendet.

Durchschnittliche erste Reaktionszeit

Die durchschnittliche Zeit in Sekunden bis zur ersten Antwort auf eine eingehende Nachricht.

Beispiel URI:

GET /reporting-metrics/erste Antwortzeit

URI-Parameter

URI-Parameter
   
von

string (erforderlich)

Eine ISO-8601-Datumszeit, die den inklusiven Beginn des Ergebnisses markiert. Muss URL-codiert sein. Der von Filter kann in der Vergangenheit maximal 14 Tage betragen.

zu

string (optional)

Eine ISO-8601-Datumszeit, die das Ende des Ergebnisses markiert. Muss URL-codiert sein. Nur eingehende Nachrichten und Antworten, die vor der aktuellen Uhrzeit gesendet wurden, werden in die durchschnittliche Berechnung der ersten Antwortzeit einbezogen. Wenn kein Filtern angegeben wird, werden die bisher gesendeten Nachrichten einbezogen.

MediumId

string (optional)

Filtern Sie nach mittlerer Kennung. Wenn kein MediumID-Filter bereitgestellt wird, werden die in verbundenen Medien gesendeten Nachrichten eingeschlossen. Wahlmöglichkeiten: fb twit instagram messagebird rtm whatsapp twilio wechat Mailgun Telegramm Viber

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

Mit Antwort gelöst

Die Anzahl der Nachrichten, die mit mindestens einer Antwort gelöst wurden.

Beispiel URI:

GET /reporting-metrics/aufgelöste mit-eins-antwort

URI-Parameter

URI-Parameter
   
von

string (optional)

Eine ISO-8601-Datumszeit, die den inklusiven Beginn des Ergebnisses markiert. Muss URL-codiert sein. Nur eingehende Nachrichten und Antworten, die nach dem Datum gesendet wurden, werden in die Berechnung mit Antwort gelöst aufgenommen. Wenn kein vom Filter angegeben wird, werden die seit 5 Tagen gesendeten Nachrichten eingeschlossen.

zu

string (optional)

Eine ISO-8601-Datumszeit, die das exklusive Ende des Ergebnisses markiert. Muss URL-codiert sein. Nur eingehende Nachrichten und Antworten, die vor der aktuellen Uhrzeit gesendet wurden, werden in die Berechnung „Gelöst mit Antwort“ aufgenommen. Wenn kein Filtern angegeben wird, werden die bisher gesendeten Nachrichten einbezogen.

MediumId

string (optional)

Filtern Sie nach mittlerer Kennung. Wenn kein MediumID-Filter bereitgestellt wird, werden die in verbundenen Medien gesendeten Nachrichten eingeschlossen. Wahlmöglichkeiten: fb twit instagram messagebird rtm whatsapp twilio wechat Mailgun Telegramm Viber

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

 

Durchschnittliche Handle-Zeit

Die durchschnittliche Zeit in Sekunden, in der eine Konversation von einem Agenten behandelt wird, insbesondere der Unterschied zwischen Zeitstempeln der offenen Konversation und dem Hängen/Auflösen der Konversation. Damit die durchschnittliche Handle-Zeit berechnet werden kann, muss ein Outbound zwischen open und pend/Resolve -Ereignis vorhanden sein.

Beispiel URI:

GET /reporting-metrics/handle-time

URI-Parameter

URI-Parameter
   
von

string (erforderlich)

Eine ISO-8601-Datumszeit, die den inklusiven Beginn des Ergebnisses markiert. Muss URL-codiert sein. Der von Filter kann in der Vergangenheit maximal 14 Tage betragen.

zu

string (optional)

Eine ISO-8601-Datumszeit, die das exklusive Ende des Ergebnisses markiert

MediumId

string (optional)

Filtern Sie nach mittlerer Kennung. Wenn kein MediumID-Filter bereitgestellt wird, werden die in verbundenen Medien gesendeten Nachrichten eingeschlossen. Wahlmöglichkeiten: fb twit instagram messagebird rtm whatsapp twilio wechat Mailgun Telegramm Viber

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

Verfügbarkeit von Agenten

Die Anzahl der verfügbaren oder auswärtigen Agenten.

Beispiel URI:

GET /reporting-metrics/agent-verfügbarkeit

URI-Parameter

URI-Parameter
   
UserPresenceStatus

string (optional)

Agentstatus, nach dem gefiltert werden soll. Es wird empfohlen, immer UserPresenceStatus bereitzustellen, andernfalls wird das Ergebnis immer 0 sein. Wahlmöglichkeiten: weg verfügbar

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

Kontakte warten in Warteschlange

Die Anzahl der Kontakte, die in der Warteschlange auf eine Antwort warten.

Beispiel URI:

GET /queue-metrics/kontakte-warte

URI-Parameter

URI-Parameter
   
Status

string (erforderlich)

Status der Warteschlange, nach dem gefiltert werden soll Wahlmöglichkeiten: neu ausstehend

MediumId

string (optional)

Filtern Sie nach mittlerer Kennung. Wenn kein MediumID-Filter bereitgestellt wird, werden die in verbundenen Medien gesendeten Nachrichten eingeschlossen. Wahlmöglichkeiten: fb twit instagram messagebird rtm whatsapp twilio wechat Mailgun Telegramm Viber

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

Längste Wartezeit in Warteschlange

Die derzeit längste Zeit in Sekunden, in der ein Kontakt auf eine Antwort wartet. Wenn kein MediumID-Filter bereitgestellt wird, werden die in verbundenen Medien gesendeten Nachrichten eingeschlossen.

Beispiel URI:

GET /queue-metrics/längste Wartezeit

URI-Parameter

URI-Parameter
   
Status

string (erforderlich)

Status der Warteschlange zum Filtern Wahlmöglichkeiten: neu ausstehend

MediumId

string (optional)

Nach mittlerer Kennung filtern Wahlmöglichkeiten: f b twit instagram messagebird rtm whatsapp twilio wechat Mailgun Telegramm Viber

ChannelID

string (optional)

Filtern Sie nach Kanalkennung (um eine Liste Ihrer Channel-IDs zu erhalten, wenden Sie sich an einen Vertreter von Sparkcentral). Wenn kein ChannelID-Filter bereitgestellt wird, werden die Nachrichten, die von allen verbundenen Kanälen gesendet werden, eingeschlossen.

Beispiele

1. Zeigen Sie mir stündlich eingehende Nachrichtenvolumen für alle Medien

Beispiel URI:

GET /reporting-metrics/inbound-message-volume

2. Zeigt mir die aktuelle durchschnittliche Reaktionszeit für einen Kanal über ein rollendes 30-Minuten-Intervall

Wenn die aktuelle Uhrzeit ist: 2017-06-22T 14:00:00 + 01:00; ChannelID ist: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

Beispiel URI:

GET /reporting-metrics/erste Antwortzeit

3. Zeigen Sie mir die Gesamtzahl der gelösten Kontakte mit mindestens einer Antwort für gestern auf Twitter

Beispiel URI:

GET /reporting-metrics/aufgelöste mit-eins-antwort

4. Zeig mir die durchschnittliche Handle-Zeit für die letzte Stunde für einen Twitter-Kanal in der PST-Zeitzone

Wenn die aktuelle Uhrzeit ist: 2017-06-22T 14:00:00-07:00; ChannelID ist: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

Beispiel URI:

GET /reporting-metrics/handle-time

5. Zeigt mir die Gesamtzahl der Kontakte, die derzeit in der neuen Warteschlange für alle Kanäle warten

Beispiel URI:

GET /queue-metrics/kontakte-warte

 

Sie können nicht finden, was Sie suchen? Wir sind hier um zu helfen