PBX Profilübersicht #
Die PbxConnectionProfiles-Ressource ermöglicht die Verwaltung von Verbindungen von Kunden PBX. Die Basis URI für alle Anfragen lautet:
/{VERSION}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}
Dies zeigt dem System, wie es eine Verbindung zum API im Telefonsystem des Kunden herstellen kann. Da jede Art von Telefonsystem unterschiedlich ist, dann Sie benötigen einen anderen Satz von Details.
PBX Typen #
| Typ | Beschreibung |
|---|---|
| KazooPbxConnectionProfile | Verbindung für das ~.pbx.kazoo.name.~ Telefonsystem. |
| ThreeCxConnectionProfile | Verbindung für das 3CX Telefonsystem |
PBX Profilschema #
Diese enthält die erforderlichen Details, um sich mit dem PBX System für diesen Kunden verbinden zu können. Da jeder Typ von PBX einen anderen Informationssatz erfordern kann, gibt es für jeden Typ zusätzliche Details.
~.pbx.kazoo.name.~ PBX Verbindungsprofil #
| Legende | Beschreibung | Datentyp |
|---|---|---|
| _type | Dies muss auf "KazooPbxConnectionProfile" gesetzt werden. | String |
| id | Die eindeutige Kennung dieses Profils | GUID |
| Name | Ein kurzer beschreibender Name | String |
| MieterID | Die ~.Dimensions.~ Tenant-ID dieses Profil ist für dieses Profil | GUID |
| Ländercode | Der Ländercode (ISO 3166), der zur Telefonnummernidentifikation verwendet wird | String |
| hostRest | Die Uri der ~.pbx.kazoo.name.~ Crossbar REST API | String |
| hostWebsocket | Die Uri der ~.pbx.kazoo.name.~ Blackhole websocket API | String |
| accountId | Die Konto-ID der ~.pbx.kazoo.name.~ Konto-Tenant | GUID |
| apiKey | Ein API Schlüssel, der Berechtigungen für dieses ~.pbx.kazoo.name.~ Konto hat. | String |
| monitorSubAccounts1 | Für Kunden mit mehreren separaten Niederlassungen unter einer einzigen Ebene. | Bool |
warning
Das Patchen eines PBX Profil gegen einen Kunden führt dazu, dass der PBX Collector neu gestartet wird. Um Datenverlust zu minimieren, ist es ratsam, dies außerhalb der Arbeitszeiten zu tun.
info
Sub-Account Monitoring ist nicht für Reseller-Top-Level-Konten gedacht.
3CX PBX Verbindungsprofil #
| Legende | Beschreibung | Datentyp |
|---|---|---|
| _type | Dies muss auf "ThreeCxConnectionProfile" gesetzt werden. | String |
| id | Die eindeutige Kennung dieses Profils | GUID |
| Name | Ein kurzer beschreibender Name | String |
| MieterID | Die ~.Dimensions.~ Tenant-ID dieses Profil ist für dieses Profil | GUID |
| licenseKey | Die Lizenzschlüsselzeichenfolge aus der 3CX Instanz, die mit ~.Dimensions.~. Dies wird verwendet, um die eingehenden Daten zu identifizieren. | String |
| Benutzername | Der Benutzername des Kontos, das in der 3CX Instanz für ~.Dimensions.~ zur Verwendung | String |
| Passwort | Das Passwort des Kontos, das in der 3CX Instanz für ~.Dimensions.~ zur Verwendung | String |
| enableRecordingArchive | Aktiviert oder deaktiviert die Funktion des automatisierten Aufzeichnungsarchivs der 3CX Aufnahmen. | Bool |
| recordingArchiveFrequency | Häufigkeit, wie oft 3CX Aufnahmen archiviert werden (HH:mm:ss:) | String |
Verfügbare Schnittstellen #
| Schnittstelle | Beschreibung |
|---|---|
| Macht alles | Gibt eine Sammlung aller PBXs zurück. |
| Erhalten Sie PBX | Gibt eine bestimmte PBX Instanz zurück. |
| Erstellen Sie PBX | Erstellt eine neue PBX Instanz. |
| Patch PBX | Aktualisiert eine bestehende PBX Instanz. |
| Löschen PBX | Entfernt eine bestehende PBX Instanz. |
| Erhalten Sie PBX Instanz | Wird verwendet, um zu prüfen, ob die Zielinstanz PBX bereits auf eine ~.Dimensions.~ Kunde irgendwo. |
-
Wenn aktiviert, werden Benutzer/Anrufe auf der angegebenen AccountId nicht überwacht, aber die auf allen Unterkonten (eine Ebene tiefer) schon. ↩︎