PBX Présentation des profils #
La ressource PbxConnectionProfiles permet de gérer les PBX Connexions. La base URI Pour toute demande est :
/{VERSION}/clients/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}
C'est ce qui indique au système comment établir une connexion au 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 | Description |
|---|---|
| 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 informations nécessaires pour pouvoir se connecter au PBX système pour ce client. Comme chaque type de PBX peut nécessiter un ensemble d'informations différent, il existe des détails supplémentaires pour chaque type.
~.pbx.kazoo.name.~ PBX Profil de connexion #
| Clé | Description | Type de données |
|---|---|---|
| _type | Il doit être défini sur « KazooPbxConnectionProfile » | corde |
| id | L'identifiant unique de ce profil | GUID |
| nom | Un nom descriptif court | corde |
| tenantId | Le ~.Dimensions.~ ID de locataire pour lequel ce profil est destiné | GUID |
| countryCode | L'indicatif du pays (ISO 3166) utilisé pour l'identification du numéro de téléphone | corde |
| hostRest | L'Uri du ~.pbx.kazoo.name.~ Crossbar REST API | corde |
| hostWebsocket | L'Uri du ~.pbx.kazoo.name.~ Blackhole websocket API | corde |
| accountId | L'identifiant de compte du ~.pbx.kazoo.name.~ Locataire du compte | GUID |
| apiKey | Un API clé disposant d'autorisations pour cette ~.pbx.kazoo.name.~ Compte | corde |
| monitorSubAccounts1 | Pour les clients disposant de plusieurs succursales distinctes sous un seul niveau. | Bool |
warning
Réparation d'un PBX profil d'un client provoquera 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 ne doit pas être utilisée sur les comptes de niveau supérieur des revendeurs.
3CX PBX Profil de connexion #
| Clé | Description | Type de données |
|---|---|---|
| _type | Celui-ci doit être défini sur « ThreeCxConnectionProfile » | corde |
| id | L'identifiant unique de ce profil | GUID |
| nom | Un nom descriptif court | corde |
| tenantId | Le ~.Dimensions.~ ID de locataire pour lequel ce profil est destiné | GUID |
| clé-licence | Chaîne de clé de licence du 3CX instance qui se connectera à ~.Dimensions.~. Ceci est utilisé pour identifier les données entrantes. | corde |
| nom d’utilisateur | Nom d'utilisateur du compte créé sur le 3CX instance pour ~.Dimensions.~ Utilisation | corde |
| mot de passe | Le mot de passe du compte créé sur le 3CX instance pour ~.Dimensions.~ Utilisation | corde |
| enableRecordingArchive | Active ou désactive la fonction d'archivage automatique des enregistrements du 3CX Enregistrements. | Bool |
| enregistrementArchiveFréquence | Fréquence de la fréquence 3CX les enregistrements seront archivés (HH :mm :ss :) | corde |
Interfaces disponibles #
| Interface | Description |
|---|---|
| Tout obtenir | Renvoie une collection de tous les PBX. |
| Obtenez PBX | Renvoie un PBX instance. |
| Créer PBX | Crée un nouveau PBX instance. |
| Patch PBX | Met à jour un PBX instance. |
| Supprimer PBX | Supprime un PBX instance. |
| Obtenez PBX Instance | Permet de vérifier si la cible PBX instance est déjà mappée à un ~.Dimensions.~ client quelque part. |
-
Lorsqu'il est activé, 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. ↩︎