Übersicht

Mit dem Webhook für detaillierte Anrufaufzeichnungen erhalten Sie einen besseren Überblick über die Webex Calling-Aktivitäten Ihrer Kunden für verschiedene Zwecke, von der Rechnungsstellung bis hin zu benutzerdefinierten Berichten. Mit diesem Webhook können Sie bequem Datensätze für alle Ihre Kunden erfassen, ohne die Datensätze für jeden Kunden einzeln abfragen zu müssen. Mit diesem Webhook können Sie benutzerdefinierte Berichts- und Analyseanwendungen sowohl für interne Geschäftszwecke als auch für die Bereitstellung von Mehrwertdiensten für Kunden entwickeln. Eine Einführung in den Webhook und die dazugehörigen APIs finden Sie in diesem vidcast .

Der Webhook liefert Datensätze alle 5 Minuten. Jede Webhook-Nutzlast enthält Datensätze für Anrufe, die vor 10 bis 5 Minuten beendet wurden. Beispielsweise enthält eine Nutzlast, die um 17:00 Uhr empfangen wurde, Anrufe, die zwischen 16:50 und 16:55 Uhr beendet wurden. Anrufe, die zwischen 16:55 und 17:00 Uhr enden, befinden sich in der Nutzlast von 17:05 Uhr.

Webex Calling-Aufzeichnungen werden im selben Format wie die vorhandenen APIs für detaillierte Anrufdatensätze bereitgestellt. Sie können einen Webhook einrichten und zwischen zwei Feedtypen wählen:

  • Analysen – Enthält alle Anrufdatensätze für alle Kundenorganisationen, zu denen der Partner eine Webex Calling-Beziehung hat. Dazu gehören Organisationen, für die:
    • Der Partner verwaltet die Kundenorganisation mit einer Partner-Rolle als vollständiger Administrator.
    • Die Kundenorganisation verfügt über ein aktives Webex Calling-Abonnement innerhalb der Partnerorganisation.
  • Rechnungsstellung – Umfasst nur Anrufaufzeichnungen für Anrufe, die von Benutzern mit einer vom Partner verkauften Webex Calling-Lizenz getätigt wurden. Anrufaufzeichnungen für Arbeitsbereiche sind in diesem Feed enthalten.

Webhook-Rückruf-URL einrichten

Konfigurieren Sie den Webhook im Partner Hub. Sie können pro Partnerorganisation nur einen Webhook einrichten. Sie müssen Volladministrator sein, um einen Webhook einrichten zu können.

1

Melden Sie sich bei Partner Hub an.

2

Gehen Sie zu Organisationseinstellungen > Anrufdetails.

3

Geben Sie unter Webhook eine URL zur Verwendung ein .

4

Wenn Sie Ihre Webhook-Nutzlasten mit einem geheimen Token authentifizieren möchten, können Sie eines hinzufügen. Weitere Informationen zu Webex-Webhooks und geheimen Tokens finden Sie hier .

5

Wählen Sie einen der folgenden Ressourcenarten au s , die für den Webhook verwendet werden sollen:

  • Analysen – Enthält alle Anrufdatensätze für alle Kundenorganisationen, zu denen der Partner eine Webex Calling-Beziehung hat.
  • Abrechnung – umfasst nur Anrufdatensätze, an die der Partner Webex Calling-Lizenzen verkauft hat. Dieser Feed enthält Anrufaufzeichnungen für Arbeitsbereiche.
Webhook-Einrichtung für anrufdetaillierte Datensätze in Partner-Hub

API-Endpunkte

Wir stellen zwei API-Endpunkte zusammen mit dem Webhook zur Verfügung, um bei der Datenabstimmung zu helfen. Mit diesen Endpunkten können Sie Ihre Datenspeicher mit fehlenden Datensätzen, die vom Webhook-Listener nicht empfangen werden, abgleichen. Diese beiden APIs sind der Reconciliation API-Endpunkt und der Records API-Endpunkt .

Datensätze sind über diese APIs 48 Stunden lang verfügbar. Wir empfehlen, die Datensatzspeicher regelmäßig abzugleichen, z. B. alle 12 oder 24 Stunden, damit alle Datensätze wie erwartet empfangen werden. Für die Verwendung dieser API ist ein Partner-Zugriffstoken erforderlich. Sie können ein Partner-Zugriffstoken abrufen und es gemäß den standardmäßigen Verwaltungsprinzipien für Webex Developer-Zugriffstoken verwalten.

API-Endpunkt für die Synchronisierung

Der Abgleich-API-Endpunkt gibt die Anzahl der von jedem Kunden generierten Datensätze zurück, der vom Partner im angegebenen Zeitraum verwaltet wird. Wenn ein Partner mehr als 200 Kundenorganisationen verwaltet, werden die Ergebnisse der API für eine bessere Lesbarkeit paginiert. Sie können diese Summen verwenden, um anhand Ihres lokalen Speichers zu prüfen, ob Datensätze für bestimmte Kunden fehlen. Die URL des Abgleich-API-Endpunkts finden Sie hier:

https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z

Parameter

Die Abgleich-API kann nur für eine maximale Dauer von 1 Stunde aufgerufen werden, wobei die Parameter startTime und endTime nicht länger als 60 Minuten voneinander entfernt sind. Die API kann für einen Zeitraum von 1 Stunde zwischen 5 Minuten und 48 Stunden verwendet werden. Um die Dienstauslastung zu verwalten, kann jedoch nur 1 Stunde gleichzeitig aufgerufen werden.

Folgende Parameter sind verfügbar:

  • startTime (Zeichenfolge): Uhrzeit des ersten Berichts, den Sie erfassen möchten. Die Berichtszeit gibt die Abschlusszeit des Anrufs an.

    Sie müssen die Zeit als YYYY-MM-DDTHH:MM:SS.mmmZ formatieren.

  • endTime (Zeichenfolge): Uhrzeit des letzten Berichts, den Sie erfassen möchten. Die Berichtszeit gibt die Abschlusszeit des Anrufs an.

    Die angegebene Zeit sollte nach startTime liegen, jedoch nicht später als 48 Stunden. Sie müssen die Zeit als YYYY-MM-DDTHH:MM:SS.mmmZ formatieren.

Hier ist ein Beispiel dafür, wie eine JSON-Rückgabenutzlast eines Reconciliation API-Endpunkts aussieht:

{ "cdr_counts": [ { "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy", "Anzahl": 3009 }, { "orgId": "yyyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyy", "count": 129 }, { "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyy", "count": 278 } ] }

Die Kopfzeilen der API-Antwort geben die Gesamtzahl der zurückgegebenen Organisationen an und ob zusätzliche Seiten vorhanden sind. Überprüfen Sie die folgenden Parameter, um sicherzustellen, dass alle Seiten abgefragt wurden.

 Anzahl-Seiten = 2 Organisationen insgesamt = 283 aktuelle Seite = 1

Die obigen Parameter zeigen, dass die aktuelle Seite die erste Seite ist, dass es insgesamt 2 Seiten gibt und dass die gesamte Antwort 283 Organisationen enthält. Greifen Sie wie unten gezeigt auf die zweite Seite zu, indem Sie den Parameter page=2 zur GET -Anforderung hinzufügen.

https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2

Datensätze API-Endpunkt

Dieser API-Endpunkt gibt Anrufdatensätze im JSON-Format zurück, identisch mit dem Format, wie in der detaillierten Anrufprotokoll-API beschrieben. Die zurückgegebene Nutzlast enthält dieselben Felder wie die zurückgegebene Nutzlast im detaillierten Anrufprotokoll. Weitere Details zu den Werten in jedem zurückgegebenen Feld finden Sie hier . Der API-Endpunkt für Datensätze wird verwendet, um fehlende Datensätze nach Organisationen abzufragen, für die Datensätze fehlen. Die API-Endpunkt-URL für Datensätze finden Sie hier:

https://analytics.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z

Parameter

  • orgID – Die Organisations-ID, für die Sie Datensätze abfragen möchten. Sie können diese Kennungen über den vorherigen Abgleichendpunkt öffnen.

  • startTime (Zeichenfolge): Uhrzeit des ersten Berichts, den Sie erfassen möchten. Die Berichtszeit gibt die Abschlusszeit des Anrufs an.

    Die angegebene Zeit muss zwischen 5 Minuten und 48 Stunden liegen. Sie müssen die Zeit als YYYY-MM-DDTHH:MM:SS.mmmZ formatieren.

  • endTime (Zeichenfolge): Uhrzeit des letzten Berichts, den Sie erfassen möchten. Die Berichtszeit gibt die Abschlusszeit des Anrufs an.

    Die angegebene Zeit sollte nach startTime liegen, jedoch nicht später als 48 Stunden. Sie müssen die Zeit als YYYY-MM-DDTHH:MM:SS.mmmZ formatieren.