Aperçu des clients #
La ressource Clients permet la gestion des locataires clients. La base URI pour toutes les demandes 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é | Descriptif | Type | Défaut | Obligatoire |
|---|---|---|---|---|
| Identifiant | L'identifiant unique du client | Chaîne | (généré automatiquement) | Oui (ne pas créer) |
| Nom | Un nom court du client | string[100][100] | ||
| La description | Un nom descriptif plus long pour le client | string[200][200] | ||
| Référence | Un fournisseur de services Référence client | string[200][200] | ||
| dateCreated | La date et l'heure de création du client | Date et heure | ||
| parentTenantId | L'identifiant du locataire parent | Chaîne | (généré automatiquement) | |
| activé | Indique si ce client est activé. Lorsqu'un client est activé, la connexion au PBX sera démarrée et l'invitation par courriel sera envoyée à chaque utilisateur ayant accès au site Web | booléen | faux | |
| Fuseau horaire | Le fuseau horaire de l'IANA par défaut | string[40][40] | Hérité | |
| countryCode | Le code de pays par défaut utilisant la norme ISO 3166 | string[5][5] | Hérité | |
| Caractéristiques | Collection de fonctionnalités sous licence | Caractéristiques sous licence | Hérité | |
| pbxConnectionProfiles1 | Le PBX Détails de la configuration | array(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 | |
| envoyerNouvelleAdresse e-mail | Cela permet de déterminer si les nouveaux utilisateurs recevront des courriels de bienvenue ou non. | booléen | Vrai | |
| envoyerConnecterBienvenueEmail | Cela permet de vérifier si les nouveaux ~.UcClient.~ Les utilisateurs clients recevront un courriel de bienvenue ou non. | booléen | Vrai | |
| tenantProfileType | Le id pour le profil du locataire qui sera attribué au client | Chaîne | Hérité | |
| trialDurée2 | Indique si le client met le système à l'essai et, le cas échéant, pendant combien de jours | entier | 0 |
Caractéristiques sous licence #
| Clé | Descriptif |
|---|---|
| agent | Contrôle l'accès au rôle de module complémentaire de l'agent ACD. 0 est désactivé |
| dispositif | Contrôle l'accès à la licence de l'appareil client en temps réel, c'est-à-dire FireTV client. 0 est désactivé. |
Interfaces disponibles #
| Interface | Descriptif |
|---|---|
| Obtenir tout | Retourne une collection de tous les clients. |
| Obtenir un client | Renvoie une instance client spécifique. |
| Créer un client | Crée une nouvelle instance client. |
| Client de correctifs | Met à jour une instance client existante. |
| Supprimer le client | Supprime une instance de client existante. |
Essais clients #
Si disponible sur votre compte revendeur, la propriété TrialDuration peut être utilisée pour permettre à un nouveau client d'essayer le ~.Dimensions.~ système. Lors de l'essai du système, aucun frais ne sera encouru pour le client.
La durée maximale autorisée pour la durée de l'essai diffère selon le revendeur. Veuillez communiquer avec votre ~.Dimensions.~ pour plus d'informations.
note
Passer 0 comme propriété TrialDuration indique que le client n'essaie 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é comme un client normal.