PBX Aperçu des profils #
La ressource PbxConnectionProfiles permet de gérer les clients PBX connexions. La base URI pour toutes les demandes est :
/{VERSION}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}
C'est ce qui indique au système comment établir une connexion avec le API sur le système téléphonique des clients. Comme chaque type de système téléphonique est différent alors ils nécessiteront un ensemble différent de détails.
PBX Types #
| Type | Descriptif |
|---|---|
| KazooPbxConnectionProfile | Connexion pour le ~.pbx.kazoo.name.~ système téléphonique. |
| ThreeCxConnectionProfile | Connexion pour le 3CX système téléphonique |
PBX Schéma des profils #
Celui-ci contient les détails requis pour pouvoir se connecter au PBX pour ce client. Comme chaque type de PBX peut nécessiter un ensemble différent d'informations, il y a des détails supplémentaires pour chaque type.
~.pbx.kazoo.name.~ PBX Profil de connexion #
| Clé | Descriptif | Type de données |
|---|---|---|
| _type | Ceci doit être défini sur « KazooPbxConnectionProfile » | Chaîne |
| Identifiant | L'identificateur unique de ce profil | GUID |
| Nom | Un court nom descriptif | Chaîne |
| locataireId | Le ~.Dimensions.~ Identifiant du locataire pour lequel ce profil est destiné | GUID |
| countryCode | Le code de pays (ISO 3166) utilisé pour l'identification du numéro de téléphone | Chaîne |
| hostRest | L'Uri du ~.pbx.kazoo.name.~ Crossbar REST API | Chaîne |
| hostWebsocket | L'Uri du ~.pbx.kazoo.name.~ Blackhole websocket API | Chaîne |
| accountId | L'identifiant de compte du ~.pbx.kazoo.name.~ Locataire du compte | GUID |
| apiKey | Un API clé qui a les autorisations pour cela ~.pbx.kazoo.name.~ Compte | Chaîne |
| monitorSubComptes1 | Pour les clients ayant plusieurs succursales distinctes sous un seul niveau. | bool |
warning
Patching a PBX profil contre un client entraînera le PBX collecteur à redémarrer. Pour minimiser la perte de données, il est conseillé de le faire en dehors des heures de travail.
info
La surveillance des sous-comptes n'est pas destinée aux comptes de premier niveau des revendeurs.
3CX PBX Profil de connexion #
| Clé | Descriptif | Type de données |
|---|---|---|
| _type | Ceci doit être défini sur « ThreeCxConnectionProfile » | Chaîne |
| Identifiant | L'identificateur unique de ce profil | GUID |
| Nom | Un court nom descriptif | Chaîne |
| locataireId | Le ~.Dimensions.~ Identifiant du locataire pour lequel ce profil est destiné | GUID |
| licenseKey | La chaîne de clé de licence du 3CX instance qui se connectera à ~.Dimensions.~. Ceci est utilisé pour identifier les données reçues. | Chaîne |
| nom d'utilisateur | Le nom d'utilisateur du compte créé sur le 3CX instance pour ~.Dimensions.~ à utiliser | Chaîne |
| mot de passe | Le mot de passe du compte créé sur le 3CX instance pour ~.Dimensions.~ à utiliser | Chaîne |
| enableRecordingArchive | Active ou désactive la fonction d'archivage d'enregistrement automatisé du 3CX enregistrements. | bool |
| recordingArchiveFrequency | Fréquence de la fréquence 3CX les enregistrements seront archivés (HH :mm :ss :) | Chaîne |
Interfaces disponibles #
| Interface | Descriptif |
|---|---|
| Obtenir tout | Renvoie une collection de tous les PBX. |
| Obtenir PBX | Renvoie un PBX exemple. |
| Créer PBX | Crée un nouveau PBX exemple. |
| Patch PBX | Met à jour un PBX exemple. |
| Supprimer PBX | Supprime un PBX exemple. |
| Obtenir PBX Exemple | Utilisé pour vérifier si la cible PBX instance est déjà mappée à un ~.Dimensions.~ client quelque part. |
-
Lorsqu'elle est activée, les utilisateurs/appels sur le accountId fourni ne sont pas surveillés, mais ceux de tous les sous-comptes (1 niveau inférieur) le sont. ↩︎