AudioCodes - REST

Dieses Kapitel beschreibt die Konfiguration eines AudioCodes Mediant Session Border Controllers zur Anrufersuche im XPhone Connect Directory und Namensanzeige in Microsoft Teams unter Verwendung der REST-Schnittstelle.

Voraussetzungen

• Um die Rufnummernauflösung zu verwenden, muss für Microsoft Teams die Telefonie-Variante Direct Routing verwendet werden.

  • Wir setzen voraus, dass das Direct Routing für Microsoft Teams eingerichtet und funktionsfähig ist.

  • Mit Operator Connect funktioniert die Rufnummerauflösung nicht.

  • Die Rufnummernauflösung ist nur für eingehende Rufe möglich. Für ausgehende Rufe aus Microsoft Teams kann keine Rufnummernauflösung konfiguriert werden.

  • Entsprechende Dokumentationen zum Direct Routing finden Sie im Partnerportal von AudioCodes bzw. auf der Microsoft Webseite:

    • AudioCodes SBCs

    • https://learn.microsoft.com/en-us/microsoftteams/direct-routing-plan

• Getestet wurde die AudioCodes Version:

  • 7.40A.500.357

  • 7.40A.251.284

• Mindestens XPhone Connect Directory in der Version:

  • 9.0.344

• Contacts by XPhone muss für die maximale Anzahl von Benutzern lizenziert sein, die Anrufe über das Telefonnetz führen können.

XPhone Connect Directory Konfiguration

• Richten Sie zunächst das XPhone Connect Directory im Default gemäß Dokumentation ein.

  • Vervollständigen Sie die Wahlparameter unter Einstellungen.

Rufnummernformate

Das XPhone Connect Directory erkennt für die Anruferidentifizierung folgende Rufnummernformate. Voraussetzung ist, dass die Wahlparameter (siehe vorigen Abschnitt) korrekt konfiguriert sind:

• Interne Rufnummern (relevant ist die in den Wahlparametern angegebene Länge der internen Nummern)

• Ortsnetz-Rufnummern (nicht beginnend mit der Ziffer 0 und länger als interne Rufnummern)

• Nationale Rufnummern (beginnend mit der Ziffer 0)

• Internationale Rufnummern (beginnend mit den Ziffern 00)

• E.164 Rufnummern (beginnend mit einem Plus-Zeichen)

Hinweis

Nicht erkannt werden E.164-Rufnummern ohne Pluszeichen. Falls Sie Ihren SBC so konfiguriert haben, dass er mit E.164-Rufnummern arbeitet, fügen Sie das Pluszeichen in der Konfiguration der Abfrage hinzu (siehe Konfiguration des Request Key unten). Beachten Sie, dass das Pluszeichen in HTTP-Aufrufen als %2B formuliert sein muss.

API Secret erstellen

Erstellen Sie den Benutzernamen und das Passwort für den REST-Zugang über Ihre Directory-Administration wie folgt:

• Klicken Sie auf die Schaltfläche Cloud-Verbindung.

• Navigieren Sie zu Lizenzierung und klicken auf ADMIN-PORTAL ÖFFNEN.

  • Das Admin Portal öffnet sich in einem neuen Browserfenster.

    • Öffnen Sie die Seite Anruferindentifikations-API und klicken auf die Schaltfläche + API-Secret erzeugen.

    • Diese Kombination aus Benutzername und Passwort wird für die weitere Konfiguration im Anynode SBC benötigt.

AudioCodes Konfiguration

Das Microsoft Teams-Direct-Routing mit AudioCodes muss entsprechend den Herstellerangaben konfiguriert werden.

Erstellen Sie unter Setup > IP Network > Security einen neuen TLS Context, der für die Überprüfung des API-Zertifikats verwendet wird. Stellen Sie TLS 1.2 ein (nicht TLS 1.3) und aktivieren Sie Use default CA Bundle. Notieren Sie sich den Namen des TLS Contexts, er wird im nächsten Schritt für den Remote Web Service benötigt.

Legen Sie unter Setup > IP Network > Web Services > Remote Web Services einen neuen Remote Web Service an. Notieren Sie sich den gewählten Namen (hier: ContactSearchREST), da dieser später in der Call Setup Rule als Request Target eingetragen werden muss:

• Type: General

• Path: api

• Number of connections: 5-10

• TLS Context: Zuvor erzeugter TLS Context, (ausschließlich TLS 1.2, nicht 1.3)

• Username: Benutzernamen des Directory API

• Password: Passwort des Directory API

Erzeugen Sie aus dem aktuellen Remote Web Service-Datensatz einen neuen HTTP Remote Host mit folgenden Parametern:

• Address: cbx-release-api.c4b.com

Legen Sie nun unter Setup > Signaling & Media > SIP Definitions > Call Setup Rules eine neue Regel an. Vergeben Sie eine eindeutige ID und notieren Sie sich diese (hier 6):

• Request Target: Name des zuvor generierten Remote Web Service (siehe oben).

• Request Key

  'v1/caller-info?MicrosoftTenantID=<your-tenant-id>&CallingPartyNumber='+Func.URL-Encode(Param.Call.Src.User)+'&CalledPartyNumber='+Func.URL-Encode(Param.Call.Dst.User)
  

  • Ersetzen Sie <your-tenant-ID> durch die Tenant-ID Ihres Microsoft 365 Systems. Sie finden diese auch unter Cloud Connection/Licensing in Ihrer Directory-Administration. Beachten Sie die einfachen Anführungszeichen in diesem Ausdruck.

• Condition: HTTP.Response.Status=='200'

Wählen Sie den IP-to-IP Routing Record, der von Ihrem PSTN-SIP-Trunk zu Microsoft Teams routet. Aktivieren Sie die Call Setup Rule, indem Sie deren ID unter Call Setup Rules Set ID eintragen:

Erweiterte Einstellungen

Display Anzeige anpassen

Dieses Kapitel zeigt die Konfiguration des LDAP-Attributs displayName im Format:

<Name> <Vorname>, <Firma>

Diese Konfiguration muss pro Datenquelle durchgeführt werden. Diese Methode ermöglicht die Anpassung des Anzeigeformats passend zur Datenquelle und unabhängig von der Konfiguration des SBC.

Öffnen Sie die Feldverknüpfung der entsprechenden Datenquelle:

Verknüpfen Sie die gewünschten Felder mit dem Displaynamen. Halten Sie die Strg-Taste gedrückt, um eine Mehrfachzuordnung durchzuführen:

Klicken Sie auf das Trichter-Symbol um das folgende Dialog-Fenster zu erhalten. Schieben Sie die Quellfelder in die gewünschte Reihenfolge und definieren Sie die Trennzeichen. Im Text-Element zwischen Vorname und Name befindet sich ein Leerzeichen (im Screenshot unsichtbar).

Troubleshooting

API Test

Um die Funktion des API unabhängig vom Session Border Controller zu testen, kann z.B. das Tool Postman verwendet werden.

Ersetzen Sie die Werte in den spitzen Klammern mit Ihren Testdaten:

https://cbx-release-api.c4b.com/api/v1/caller-info?MicrosoftTenantID=<tenant-id>&CallingPartyNumber=<%2B49891234567>&CalledPartyNumber=<%2B49891234568>

AudioCodes Message Log

Verwenden Sie das Message-Log, um die HTTP-Aufrufe zu überprüfen:

Gehen Sie wie folgt vor:

1. Bereiten Sie einen Testanruf vor.

2. Öffnen Sie das Message-Log-Fenster. Führen Sie „Stop“ und „Clear“ durch.

3. Dann drücken Sie „Start“ und führen unmittelbar darauf den Testanruf durch.

4. Sobald Sie die Microsoft-Teams Anruferanzeige sehen, drücken Sie „Stop“.

5. Kopieren Sie die Ausgabe des Message Logs in einen Text-Editor (z.B. Notepad++)

6. Suchen Sie über die Textsuche nach dem Namen des Remote Webservice, den Sie zur Suche verwenden (z.B. ContactSearchREST). An diesen Stellen finden Sie Informationen zu den Parametern des REST-Aufrufs.. Prüfen Sie diese gegen die „Sollwerte“.

Stellen Sie den Log-Level gegebenenfalls auf Detailed:

Haben Sie einen Fehler auf dieser Seite gefunden?

Oder ist etwas nicht gut oder zu ungenau formuliert? Dann freuen wir uns über eine E-Mail, am besten mit einem Verbesserungsvorschlag, an doku@c4b.de. Vielen Dank!