Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

Obtenir les données de configuration utilisateur

L'API Apps est conçue pour récupérer les données de configuration des utilisateurs. Vous pouvez lire la configuration utilisateur actuelle pour tous les utilisateurs ou pour un seul utilisateur, quel que soit son rôle ou son état. Les rôles système et personnalisés sont inclus dans cette sortie.

Ce point de terminaison diffère de ceux utilisés dans le processus d'importation groupée d'utilisateurs et fournit les informations nécessaires pour prendre en charge les opérations groupées. Pour en savoir plus sur la gestion groupée des utilisateurs, consultez l'API de gestion groupée des utilisateurs.

Fonctionnalités et limites de l'API

Lorsque vous récupérez des données utilisateur, vous pouvez inclure des paramètres pour adapter la réponse de l'API à vos besoins. Les paramètres suivants sont acceptés :

Utilisateur(s) spécifique(s)
- Options d'ID : adresse e-mail, ID système ou ID utilisateur personnalisé. Les utilisateurs peuvent spécifier un ou plusieurs ID. Si plusieurs ID utilisateur pointent vers le même utilisateur, celui-ci ne doit être représenté qu'une seule fois dans la réponse.
Pagination
- Les utilisateurs peuvent récupérer les résultats dans des ensembles paginés pour gérer de grands ensembles de données. La réponse de l'API doit indiquer s'il existe d'autres pages à récupérer.
- Un paramètre d'API permet aux utilisateurs de demander une page spécifique de résultats.
- Les utilisateurs peuvent spécifier la taille de la page. La taille de page par défaut est de 100 et la taille maximale est de 1 000. Lorsqu'un numéro de page spécifique est fourni, les ID utilisateur ne peuvent pas être inclus dans la requête.

La réponse de l'API inclut tous les champs de profil et de configuration de l'utilisateur, à l'exception du champ "État". Au lieu du champ "État", l'API fournit un champ deactivated_at. Ce champ contient les informations suivantes :

Aucune valeur pour les utilisateurs actifs.
La date et l'heure de désactivation d'un utilisateur.

Le tableau suivant répertorie les champs de profil utilisateur qui seront inclus dans la réponse de l'API :

Tableau 1. Tableau des champs de profil utilisateur

Order	Type de colonne	Nombre de colonnes	Nom(s) de la colonne	Valeurs valides
1	E-mail	1	E-mail	E-mail
2	ID de l'agent	1	ID de l'agent	Chaîne
3	Prénom	1	Prénom	Chaîne
4	Nom	1	Nom	Chaîne
5	Alias	1	Alias	Chaîne
6	Désactivé à	1	Désactivé à	Aucune valeur, Date/heure
7	Emplacement	1	Emplacement	Chaîne correspondant à un nom de lieu, Vide (aucune modification), Nulle (supprimer l'emplacement actuel).
8	Conversation simultanée	1	Conversation simultanée	1 à X (où X est la valeur configurée), Vide
9	État de la conversation simultanée	1	État de la conversation simultanée	0, 1, Vide
10	Appels internationaux non restreints	1	Appels internationaux non restreints	(Vrai/Faux)
11	Utilisateur externe	1	Utilisateur externe	(Oui/Non)
12	URI SIP externe	1	URI SIP externe	Chaîne
13	Nom d'utilisateur UCaaS	1	Nom d'utilisateur UCaaS	Chaîne
14	Extensions d'agent	1	Extensions d'agent
15	Rôles	Plusieurs	Rôle : Nom du rôle A Rôle : Nom du rôle B Rôle : Nom du rôle C, etc.	0, 1, Vide
16	Équipe	Plusieurs	Équipe : Nom de l'équipe A, Équipe : Nom de l'équipe B, Équipe : Nom de l'équipe C, etc.	0, 1, Vide
17	Numéro de téléphone	Plusieurs	Numéro d'appel direct : 1, Numéro d'appel direct : 2, Numéro d'appel direct : 3	Numéro de téléphone au format E.164
18	Filtre	Unique	Filtre	Chaîne
19	Délai avant expiration du filtre	Unique	Délai avant expiration du filtre	Valeur numérique comprise entre 0 et 1 440

Limites

Un seul type d'ID utilisateur est accepté par requête.
Le nombre maximal d'ID par requête API est de 1 000.
Les utilisateurs ne peuvent pas fournir à la fois des ID utilisateur et une demande de numéro de page dans une seule requête API. L'API renvoie tous les utilisateurs en fonction de la requête, jusqu'à 1 000.

Messages d'erreur de l'API

L'API fournit les messages d'erreur suivants pour des scénarios spécifiques :

Taille de la page : "Exceeded maximum page size request (1,000 is the maximum)" (Demande de taille de page maximale dépassée (1 000 est le maximum))
Taille de la page (exigence de saisie numérique) : "Invalid page size request; must be a numeric value" (Demande de taille de page non valide ; doit être une valeur numérique)
Requête combinée d'ID utilisateur et de pagination : "Combination of user ID and pagination request is not supported" (La combinaison d'une requête d'ID utilisateur et de pagination n'est pas acceptée)
ID utilisateur (dépassement) : "Exceeded maximum number of user IDs (1,000 is the maximum)" (Nombre maximal d'ID utilisateur dépassé (1 000 est le maximum))

Exemple de requête et de réponse

Cet exemple montre comment récupérer la première page d'utilisateurs avec 100 utilisateurs par page. Le corps de la réponse inclut un tableau d'objets utilisateur, chacun contenant des données de configuration utilisateur détaillées.

Requête :

Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/users?page=1&per_page=100

Réponse :

[
  {
    "email": "email",
    "agent_number": "number",
    "first_name": "first",
    "last_name": "last",
    "status": "Active",
    "location": "location",
    "max_chat_limt": 3,
    "max_chat_limit_enabled": true,
    "deleted_at": "2024-07-16T15:57:12.000Z",
    "ucaas_user_name": "username",
    "external_user": true,
    "ucaas_sip_uri": "sip uri",
    "unrestricted_international_calling": false,
    "roles": [
      { "name": "Admin" },
      { "name": "Manager" }
    ],
    "teams": [
      { "name": "name" }
    ],
    "phone_numbers": [
      "123-456-7890",
      "098-765-4321"
    ]
  },
  ...
]

Cet exemple montre comment récupérer les détails d'un seul utilisateur en transmettant un paramètre d'e-mail. Le corps de la réponse inclut un objet utilisateur contenant des données de configuration utilisateur détaillées.