Menu Close

peoplefone CONNECTOR API (REST API)

Terminologie

Der Begriff Client wird verwendet, um personenbezogene Kunden oder Partner zu identifizieren, die eine Integration mit dem personenbezogenen peoplefone CONNECTOR durchführen

Der Begriff Telefonsuchdienst wird verwendet, um den Dienst des Clients zu identifizieren, der die aktuelle Schnittstelle für den peoplefone CONNECTOR zum Erfassen von Daten verfügbar macht.

Wann kann die peoplefone CONNECTOR API verwendet werden?

Wenn das CRM des Kunden nicht von peoplefone unterstützt wird, bitten wir den Kunden, einen Telefonsuchdienst bereitzustellen.

Überblick

Die peoplefone CONNECTOR API deckt mehrere Anwendungsfälle ab:

  • Datensuche zu Benachrichtigungszwecken
    Wenn ein Telefonanruf ausgeführt wird (eingehend oder ausgehend), benachrichtigt peoplefone HOSTED den peoplefone CONNECTOR, der mithilfe der in diesem Artikel beschriebenen REST API nach Daten sucht.
  • Interaktion mit dem Business Workflow
    Wenn der Benutzer von peoplefone CONNECTOR auf einen der Geschäftsabläufe klickt, überträgt der Benutzer von peoplefone CONNECTOR die Anforderung zur Behandlung an den Telefonsuchdienst. Der Geschäftsworkflow kann das Erstellen eines Tickets oder eines Anrufverlaufs im CRM umfassen.

Hinweis: Nur Teil 1 wird im Moment behandelt, Teil 2 befindet sich noch im Aufbau.

Teil 1 – Datenabfrage

Anfrage

URL

https://clientServiceAddress/someController
Der Request-URL wird vom Client definiert, damit peoplefone CONNECTOR den Telefonsuchdienst erreichen kann. Diese URL enthält KEINE privaten Daten, die für die Suche erforderlich sind. Diese Daten werden über HTTP-Header bereitgestellt.

Parameter abfragen

peoplefone CONNECTOR gibt die Telefonnummer über den folgenden Abfrage-Parameter an:
Schlüssel: Telefonnummer
Wert (sample): 4178907228
https://clientServiceAddress/someController?PhoneNumber=4178907228

HTTP-Header

Zur Authentifizierung stellt peoplefone CONNECTOR einen Token über den folgenden HTTP-Header bereit:
Schüssel: X-Execution-Token
Wert: jlvlkdshvövdjhwgjwogjhwg

Body

Der Body der Anfrage wird vorerst nicht vom peoplefone CONNECTOR verwendet

Antwort

Beispiel vom HTTP Body

[
   {
      "Name": "Alexa Holiday",
      "Company": "White Cross Co",
      "ContactUri": "https://...",
      "CompanyUri": "https://...",
      "Id": "Crm Identification Number",
      "CrmName": "Sugar CRM",
      "CrmLogo": "https://...",
      "CustomData": {
         "Title1": "Data1", 
         "Title2": "Data2"
      }
   },
   {
      ...
   }
]

Layer 1: Die Liste

Das erwartete Ergebnis ist ein Array von Objekten. Es wird empfohlen, nur eine sehr kleine Anzahl von Ergebnissen zurückzugeben. Der Wert von maximal 5 Ergebnissen eignet sich am besten für ein ausgewogenes Verhältnis zwischen Leistung und Präzision. Das Erhöhen dieses Werts kann jedoch in allen Phasen des Systems zu erheblichen Verzögerungen und Leistungsproblemen führen.

Wenn die Abfrage keinen Wert zurückgibt, wird von peoplefone CONNECTOR erwartet, dass sie ein leeres Array mit einem Statuscode von 200 erhält. In diesem Fall wird KEIN 404-Statuscode erwartet. Der 404-Statuscode bedeutet, dass auf den Telefonsuchdienst nicht zugegriffen werden kann.

Layer 2: Das Objekt

Die Objekte, aus denen die Liste besteht, stellen einen Eintrag dar, der für die angegebene Telefonnummer im integrierten CRM gefunden wurde. Dieses Objekt enthält nur wenige Felder, die für peoplefone CONNECTOR erforderlich sind, um den Eintrag ordnungsgemäss anzuzeigen, sowie eine Liste von Schlüssel-Wert-Paaren für bestimmte Daten, die unser Kunde hinzufügen möchte.

FeldnameBeschreibung
NameDer vollständige Name des gefundenen Kontakts. Dies wird in der Benutzeroberfläche verwendet, um den Namen des Kontakts anzuzeigen.
FirmaDer Name der Firma, mit der der Kontakt verknüpft ist. Dies wird in der Benutzeroberfläche verwendet, um den Namen des Unternehmens anzuzeigen.
ContactUriDer URI für den Zugriff auf die Kontaktseite im CRM. Dies wird in der Benutzeroberfläche verwendet, um eine verbindung zum Kontakt herzustellen.
CompanyUriDer URI für den Zugriff auf die Unternehmensseite im CRM. Dies wird in der Benutzeroberfläche verwendet, um eine verbindung zum Unternehmen herzustellen.
IdDie ID des Kontakts im CRM. Dieser Wert wird nicht angezeigt.|
CrmNameDer Name des CRM. Dieser Wert wird, insofern angegeben, verwendet, um einen Tooltip zum CRM-Logo hinzuzufügen.
CrmLogoDie URL des Logos des CRM. Dieser Wert wird, falls angegeben, verwendet, um ein Logo auf der Kontaktkarte für diesen Eintrag hinzuzufügen. Dies ist optional, wenn der Kunde nur ein CRM integriert. Es wird jedoch nützlich, wenn der Kunde mehrere CRM-Integrationen hat.
CustomFieldsDas Objekt CustomFields ist eine Reihe von Schlüssel-Wert-Paaren, mit denen der Kunde alle Daten übertragen kann, die er für die benötigt.

Teil 2 – Geschäftsablauf

Folgt demnächst

Leistung

Die Antwortzeit ist der Schlüssel, damit der Benutzer die entsprechenden Informationen in der peoplefone CONNECTOR-Anwendung so schnell wie möglich sehen kann. Das bedeutet, dass der Telefonsuchvorgang so schnell wie möglich sein sollte. Um sicherzustellen, dass der Benutzer nicht betroffen ist, wenn die Telefonsuche manchmal zu langsam ist, wird der peoplefone CONNECTOR nach einer konfigurierten Anzahl von Sekunden eine Zeitüberschreitung für die Telefonsuche verursachen und dann die grundlegenden Informationen zurückgeben (Telefonnummer und Anrufstatus).