Présentation des clients #
La ressource Clients permet de gérer les locataires Customer. La base URI Pour toute demande est :
/{VERSION}/clients/{CUSTOMER_TENANT_ID}
Schéma des clients #
Les clients représentent un locataire sur le système auquel les utilisateurs finaux peuvent être affectés via le API.
| Clé | Description | Type | Faire défaut | Obligatoire |
|---|---|---|---|---|
| id | L'identifiant unique du client | corde | (généré automatiquement) | Oui (pas créer) |
| nom | Un nom de client abrégé | chaîne[100][100] | ||
| description | Un nom descriptif plus long pour le Client | chaîne[200][200] | ||
| référence | Un prestataire Référence client | chaîne[200][200] | ||
| dateCréation | La date et l'heure de création du Client | Dateheure | ||
| parentTenantId | L'id du locataire parent | corde | (généré automatiquement) | |
| Activé | Indique si ce client est activé. Lorsqu'un client est activé, la connexion Pbx est démarrée et l'invitation par e-mail envoyée à chaque utilisateur ayant accès à l'utilisateur du site Web | booléen | faux | |
| fuseau horaire | Le fuseau horaire IANA par défaut | chaîne[40][40] | Hérité | |
| countryCode | Le code de pays par défaut selon la norme ISO 3166 | chaîne[5][5] | Hérité | |
| fonctionnalités | Collection de fonctionnalités sous licence | Fonctionnalités sous licence | Hérité | |
| pbxConnectionProfiles1 | Le PBX Détails de la configuration | tableau(pbxConnectionProfile) | ||
| syncAcdAgentWithPbx2 | Indique si les utilisateurs doivent être automatiquement activés pour le rôle ACD s'ils sont configurés en tant qu'agent ACD sur le PBX | booléen | faux | |
| sendNewUserEmail | Cela permet de contrôler si les nouveaux utilisateurs recevront des e-mails de bienvenue ou non. | booléen | vrai | |
| sendConnectWelcomeEmail | Cela permet de déterminer si les nouveaux ~.UcClient.~ Les utilisateurs clients recevront ou non un e-mail de bienvenue. | booléen | vrai | |
| tenantProfileType | Le id pour le profil de locataire qui sera attribué au client | corde | Hérité | |
| durée2 | Indique si le client teste le système et, le cas échéant, pendant combien de jours | entier | 0 |
Fonctionnalités sous licence #
| Clé | Description |
|---|---|
| agent | Contrôle l'accès au rôle Add-On de l'agent ACD. 0 est désactivé |
| appareil | Contrôle l'accès à la licence du périphérique Real-Time Client, c'est-à-dire FireTV client. 0 est désactivé. |
Interfaces disponibles #
| Interface | Description |
|---|---|
| Tout obtenir | Renvoie une collection de tous les clients. |
| Obtenir le client | Renvoie une instance client spécifique. |
| Créer un client | Crée une instance client. |
| Client de correctifs | Met à jour une instance client existante. |
| Supprimer le client | Supprime une instance client existante. |
Essais clients #
Si elle est disponible sur votre compte revendeur, la propriété TrialDuration peut être utilisée pour permettre à un nouveau client de tester le ~.Dimensions.~ système. Lors de l'essai du système, aucun frais ne sera facturé au client.
La durée maximale autorisée pour l'essaiLa durée varie selon le revendeur. Veuillez contacter votre ~.Dimensions.~ pour plus d'informations.
note
Le fait de passer 0 en tant que propriété TrialDuration indique que le client n'évalue pas le système.
warning
Si un client n'est pas résilié avant la fin de la période d'essai, il commencera à être facturé en tant que client normal.