CTI Anbindung
Generelle Informationen
Was ist die CTI Anbindung?
Anbindung von Telefon-Software über HTTP Aufruf in DocBee.
Wann sollten Sie die CTI Anbindung verwenden?
Falls einer oder mehrere der folgenden Punkte zutreffen, empfehlen wir den Einsatz der CTI Anbindung.
- Ihre Telefon-Software bietet die Möglichkeit, HTTP Aufruf zu starten
Aufrufe
Ein Aufruf setzt sich immer aus Ihrer DocBee Domain ( z.B. https://my.docbee.com ) und den unten aufgeführten Aufrufen zusammen.
Wichtig: Alle Parameter müssen URL kodiert werden, damit Sie korrekt verarbeitet werden können.
Kontakt-ID
/cti/id/{id}/
Dieser Aufruf öffnet, falls eine gültige Kontakt id übergeben wird, eine Seite, auf der alle Vorgänge und Leistungen dieses Kontaktes aufgelistet sind. Falls keine gültige ID übergeben wird, wird auf eine Auswahlseite weitergeleitet.
Hinweis: Wir empfehlen diesen Aufruf, falls Ihre Telefonsoftware ermöglicht, eine externe ID zu Kontakten zu hinterlegen.
Parameter
| Name | Pflichtfeld | Beschreibung | Beispielwerte |
|---|---|---|---|
| id | Ja | Die eindeutige Kontakt ID aus DocBee. Die benötigte ID kann aus der URL der Kontakte entnommen werden ( https://ihredocbeedomain.com/customerContact/1) oder über die REST API geholt werden. | 1 |
| timerId | Nein | Falls eine Timer ID übergeben wird, wird automatisch ein Timer innerhalb von DocBee gestartet (Falls kein aktueller Timer mit dieser ID gestartet ist). Als Timer ID könnten z.B. die Gesprächs-ID der Telefonsoftware genutzt werden, falls eine solche vorhanden ist. | T1234 |
| timerName | Nein | Ein optionaler Name für den Timer. Dieser Name wird in das zugehörige Textfeld innerhalb des DocBee Timers geschrieben. timerName funktioniert nur im Kombination mit timerId | Frau Müller |
Beispiele
Standard-Aufruf
https://my.docbee.com/cti/id/1/
Öffnet die Kontaktseite.
Timer starten
https://my.docbee.com/cti/id/1/?timerId=T1234&timerName=Beispiel
Öffnet die Kontaktseite und startet einen Timer mit dem Namen „Beispiel“
Telefonnummer
/cti/phone/{phoneNumber}/
Dieser Aufruf öffnet, falls die übergebende Telefonnummer nur einmal vor kommt, die Kontaktseite mit allen Vorgängen und Leistungen dieses Kontaktes. Falls die Telefonnummer mehrfach vorkommen sollte, wird zu einer Auswahlseite mit allen Kontakten, die diese Telefonnummer haben, weitergeleitet. Falls die Telefonnummer gar nicht in DocBee gefunden wurde, wird zur Auswahl mit allen Kontakten weitergeleitet.
Parameter
| Name | Pflichtfeld | Beschreibung | Beispielwerte |
|---|---|---|---|
| phoneNumber | Ja | Die Telefonnummer oder Mobilnummer eines Kontaktes. Bitte beachten Sie, falls Ihre Telefonsoftware die Telefonnummer mit Länderkennung angibt, dass dies auch in DocBee so interlegt werden müssen. | 0511 / 123459 - 555 |
| timerId | Nein | Falls eine Timer ID übergeben wird, wird automatisch ein Timer innerhalb von DocBee gestartet (Falls kein aktueller Timer mit dieser ID gestartet ist). Als Timer ID könnten z.B. die Gesprächs-ID der Telefonsoftware genutzt werden, falls eine solche vorhanden ist. | T1234 |
| timerName | Nein | Ein optionaler Name für den Timer. Dieser Name wird in das zugehörige Textfeld innerhalb des DocBee Timers geschrieben. timerName funktioniert nur im Kombination mit timerId | Frau Müller |
Beispiele
Standard-Aufruf
https://my.docbee.com/cti/phone/0511%20%2F%20123459%20-%20555/
Öffnet die Kontaktseite für den Kontakt mit dieser Telefonnummer.
Timer starten
https://my.docbee.com/cti/phone/0511%20%2F%20123459%20-%20555/? timerId=T1234&timerName=Beispiel
Öffnet die Kontaktseite für den Kontakt mit dieser Telefonnummer und startet einen Timer mit dem Namen „Beispiel“.
Timer starten
/cti/startTimer
Dieser Aufruf startet einen neuen Timer, falls dieser noch nicht gestartet ist, und leitet zum Dashboard weiter.
Parameter
| Name | Pflichtfeld | Beschreibung | Beispielwerte |
|---|---|---|---|
| timerId | Ja | Timer ID (Falls kein aktueller Timer mit dieser ID gestartet ist). Als Timer ID könnten z.B. die Gesprächs-ID der Telefonsoftware genutzt werden, falls eine solche vorhanden ist. | T1234 |
| timerName | Nein | Ein optionaler Name für den Timer. Dieser Name wird in das zugehörige Textfeld innerhalb des DocBee Timers geschrieben. | Frau Müller |
Beispiele
Standard-Aufruf
https://my.docbee.com/cti/startTimer/?timerId=T1234
Startet einen neuen Timer und öffnet das DocBee Dashboard.
Starte Timer mit Name
https://my.docbee.com/cti/startTimer/?timerId=T1234&timerName=Beispiel
Startet einen neuen Timer mit dem Namen „Beispiel“ und öffnet das DocBee Dashboard.
Timer pausieren
/cti/pauseTimer
Dieser Aufruf pausiert einen Timer, falls dieser noch nicht pausiert ist, und leitet zum Dashboard weiter.
Parameter
| Name | Pflichtfeld | Beschreibung | Beispielwerte |
|---|---|---|---|
| timerId | Ja | Timer ID welcher definiert, welche Timer pausiert werden soll. Als Timer ID könnten z.B. die Gesprächs-ID der Telefonsoftware genutzt werden, falls eine solche vorhanden ist. | T1234 |
Beispiele
Standard-Aufruf
https://my.docbee.com/cti/pauseTimer/?timerId=T1234
Pausiert den Timer und öffnet das DocBee Dashboard.
Verpasster Anruf
Verpasste Anrufe können in DocBee ebenfalls berücksichtigt werden. Wir empfehlen an dieser Stelle die Verwendung von externen Ereignissen um sicher zugehen, dass ein Anruf auch bei einem abgemeldeten Benutzer innerhalb von DocBee funktioniert. Folgende Parameter sind bei Externen Ereignissen in diesem Fall von Interesse.
Parameter
| Name | Pflichtfeld | Beschreibung | Beispielwerte |
|---|---|---|---|
| owner | Nein | Die Benutzer ID des Verantwortlichen des neuen Vorgangs / der neuen Leistung. Dieser Parameter wird nur berücksichtigt, falls kein Verantwortlicher in der Vorlage des Vorgang oder der Leistung gesetzt ist. | 1 |
| ownerUsername | Nein | Der Benutzername ohne Mandantenkürzel z.B. DOCBEE/m.mustermann => m.mustermann Dieser Parameter wird nur berücksichtigt, falls der Parameter owner nicht gesetzt ist und kein Verantwortlicher in der Vorlage des Vorgangs oder der Leistung gesetzt ist. | m.mustermann |
| contact | Nein | Die Kontakt ID des Kontaktes des neuen Vorgangs / der neuen Leistung. Anhand des Kontaktes wird auch automatisch der Kunde und der Standort gesetzt. Dieser Parameter wird nur berücksichtigt, falls kein Kontakt in der Vorlage des Vorgang oder der Leistung gesetzt ist und der Kontakt zu vielleicht gesetzten Kunden und/oder Standorten passt. | 1 |
| contactPhone | Nein | Die Telefonnummer des Kontaktes des neuen Vorgangs / der neuen Leistung. Anhand des Kontaktes wird auch automatisch der Kunde und der Standort gesetzt. Dieser Parameter wird nur berücksichtigt, falls der Parameter contact nicht gesetzt ist und kein Kontakt in der Vorlage des Vorgang oder der Leistung gesetzt ist und der Kontakt zu vielleicht gesetzten Kunden und/oder Standorten passt. | 0511 / 123459 - 555 |
Hinweis: Weitere Informationen zu Externen Ereignissen entnehmen Sie bitte der Dokumentation zu Externen Ereignisse.