CXM stellt eine spezielle REST-Schnittstelle zur Verfügung, um Ihre Telefonielösung anzubinden.
Über diese Schnittstelle kann eine übergebene Telefonnummer zur Identifizierung von Anrufern genutzt werden.
Die Suche erfolgt innerhalb der Firmen- und Kontaktdatensätze der jeweiligen CXM-Instanz.
Falls die übergebene Telefonnummer keinem bekannten Kontakt zugeordnet ist, kann optional versucht werden, die zugehörige Firma zu ermitteln – etwa dann, wenn die Telefonnummer einen Teil der zentralen Firmenrufnummer enthält.
Endpunkt
GET /api/cti/v1/CallControl/SearchCallNumberForCTI
URL-Parameter
| Parameter | Beschreibung |
| canonicalPhoneNumber | Telefonnummer im internationalen Format, die zur Identifizierung des Anrufers verwendet wird. |
| hitListCap (optional) | Maximale Anzahl der zurückgegebenen Treffer, falls mehrere Firmen oder Kontakte gefunden werden. Standardwert: 10 |
| maxNumOfSearchBack (optional) | Wenn keine exakte Übereinstimmung gefunden wird, werden schrittweise die hier angegebene Anzahl von Ziffern am Ende entfernt und erneut gesucht. So kann ggf. die zugehörige Firma (z. B. über die Zentrale) ermittelt werden. Standardwert: 4 |
Antwortdaten
Die Schnittstelle liefert eine Liste mit den gefundenen Firmen- und Kontaktdatensätzen.
Die Ergebnisse sind nach Relevanz sortiert; Einträge mit zu geringer Übereinstimmung werden automatisch herausgefiltert.
Nicht verfügbare Werte (z. B. Vorname bei einem reinen Firmeneintrag) werden als `null` zurückgegeben.
| Feld | Beschreibung |
| cellphone | Mobilfunknummer des Kontakts |
| company | Zugehöriger Firmenname |
| E-Mail-Adresse | |
| firstname | Vorname des Kontakts |
| id | Interne GUID des Datensatzes |
| lastname | Nachname des Kontakts |
| phonenumber | Telefonnummer der Firma oder des Kontakts |
| salutation | Anrede des Kontakts |
| url | Vollständige URL zum Aufruf des jeweiligen Datensatzes |
Beispielantwort
Beispielhafte Antwort für die Suche nach `+496652919xxx10`:
{
"contact": [
{
"cellphone": "+49 176 154xxx44",
"company": "Deisenweiss GmbH",
"email": "gaugstein@deisenweiss.test",
"firstname": "Gudrun",
"id": "1a57b8d6-a213-428b-b37f-3f3be800e95e",
"lastname": "Augstein",
"phonenumber": "+49 6652 919xxx10",
"salutation": "Frau",
"url": "https://MYSERVER/MYCXM/OpenRecord/1a57b8d6-a213-428b-b37f-3f3be800e95e?ormType=44fcb6fb-9230-48cf-a406-8f1f8c4d0b8c"
}
]
}