Pour: Administrateurs
Ajouter et mettre à jour les utilisateurs avec une clé de gestion
Répertoriez les personnes de votre hub, ajoutez des clients, consultez les détails et les dossiers d'une personne, et désactivez ou réactivez son accès.
Dans cet article7 sections
Avant de commencer
Cette page concerne les appels téléphoniques destinés aux personnes présentes dans votre centre de contrôle. Les chemins de navigation se trouvent sous https://prd-api-manage.caseactive.com/v1/<hub id>. Un clé permet d’ajouter des personnes en tant qu’utilisateurs, et modifie uniquement le fait qu’elles puissent se connecter : il ne permet pas d’en faire des administrateurs ou des gestionnaires, ni de modifier leurs informations après leur ajout.
Appels
| Appel | Ce que cela fait |
|---|---|
GET /users/relations | Cette liste contient les noms des personnes présentes dans votre hub. |
POST /users/relations | Ajoute quelqu’un |
GET /users/relations/<user_id> | Lise une personne |
PUT /users/relations/<user_id> | Désactive ou réactive quelqu’un |
GET /users/relations/<user_id>/cases | Cette liste indique les cas dans lesquels une personne se trouve. |
Liste des personnes
| Paramètre | Ce que cela fait | Requis | Défaut |
|---|---|---|---|
type | 1 destiné uniquement aux personnes actives, 0 destiné aux personnes handicapées. Malgré son nom, il filtre en fonction du statut, et non du type d’utilisateur. | Non. | Les deux |
limit | Combien de personnes peuvent être affichées par une page, jusqu’à 1000 personnes. | Non. | 20 |
start_key | Le startKey de la page précédente | Non. | Première page |
Chaque personne est différente. user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type )admin, manage Ou user), host_user_status )1 Actif, 0 Handicapé, personnes à mobilité réduite) host_ref_id, host_default_role, host_staff_designation, host_cases_ct (Leur nombre de cas) host_granted_status )approve, Ou reject Une fois qu’ils ont supprimé l’accès de votre hub à leur profil… created_on. La liste n’est pas organisée en ordre particulier. Elle comprend les points importants de votre système. Assistante virtuelleAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel., de qui host_user_type C’est. bot, Et les deux personnes qui font partie de chaque nouveau groupe, l’une d’entre elles, Staff Demo, a… host_user_type staff. Tant que des personnes restent encore là, appelez-les. nextLink, Ou envoyez-le. startKey comme start_key.
Ajouter quelqu'un
| Champ | Ce que cela fait | Requis | Défaut |
|---|---|---|---|
username | L’adresse e-mail de ces personnes, ou leur numéro de téléphone avec le code pays correspondant, par exemple +12035556677. Un numéro sans code pays est considéré comme un numéro américain. | Oui. | — |
given_name, family_name | Prénom et nom de famille, toujours en caractères typés. Ceux qui sont écrits en minuscules ou en majuscules doivent être capitalisés, mot par mot : mary smith est saisi comme Mary Smith. | Oui. | — |
locale | Langue : ar, de, en, es, fr, id, it, ja, pl, pt, ru ou zh | Non. | en |
zoneinfo | Fuseau horaire, par exemple America/New_York | Non. | US/Eastern |
host_ref_id | Votre propre identifiant pour eux, par exemple un numéro de client : des lettres, des chiffres, des barres et des crochets. Ce nom doit être écrit en minuscule. Aucune deux personnes ne peut partager le même identifiant. | Non. | Aucun. |
host_default_role | Ce rôle est attribué d’abord lorsqu’il est ajouté à un cas, comme par exemple role::clients. Il ne donne aucun avantage. | Non. | role::clients |
host_staff_designation | Leur désignation habituelle au sein de l’équipe est : primary, attorney, paralegal, case_manager, lead_attorney ou lead_paralegal. | Non. | primary |
birthdate | Date de naissance, par exemple : 1985-04-12 | Non. | Aucun. |
gender | Male ou Female | Non. | Aucun. |
address1, address2, locality, region, postal_code | Adresse, deuxième ligne, ville, État et code postal | Non. | Aucun. |
country | Code de pays composé de deux lettres, par exemple US | Non. | Aucun. |
company, title | Nom de la société et titre professionnel | Non. | Aucun. |
host_meta_data | leurs champs personnels, un objet par page de vos champs utilisateurs. Ces objets sont présentés dans un ordre déterminé. Lisez les pages correspondantes. GET /schemas?schema_type=users. Un champ marqué Champs obligatoires On peut l’ignorer : seuls les contrôles effectués par Edit User le vérifient. | Non. | Aucun. |
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "zoneinfo": "America/New_York", "host_ref_id": "cl-1042"}'
Cela répond à 201 avec leurs user_id.
{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
- Tout utilisateur qui ajoute une clé est considéré comme actif, quel que soit ce qu’il envoie.
- Une clé ne peut pas donner à quiconque les pouvoirs nécessaires pour gérer les affaires : créer des affaires, ajouter des personnes aux affaires ou les retirer. L’envoi de
host_create_case,host_add_case_userouhost_remove_case_userest refusé, et personne n’est ajouté à une affaire. Un administrateur peut assigner ces personnes à une affaire via Modifier l'utilisateur. - Si l’adresse ou le numéro de téléphone existe déjà dans un compte, appartenant à une autre entreprise ou pas du tout, alors cette personne est associée à ce compte. Sinon, un nouveau compte est créé. Dans tous les cas, personne n’est contacté par e-mail ou par texto. Vous pouvez contacter cette personne uniquement lorsque vous l’ajoutez à une affaire, en lui envoyant une invitation. Voir Comment ajouter et supprimer des membres d’une affaire avec la clé de gestion.
Lire quelqu'un
GET /users/relations/<user_id> répond à toutes les informations listées, en plus de la date de naissance, le sexe, l’adresse, l’entreprise et le titre de chacun. Il y a également des champs personnalisés, des choix concernant les notifications, ainsi que la dernière date d’accès de chaque utilisateur. GET /users/relations/<user_id>/cases liste les cas sur lesquels les utilisateurs sont actuellement impliqués, y compris ceux qui ont été clos. Pour chaque cas, on trouve les informations suivantes : case_id, title, case_ref_id (l’ID de votre hub, :: et l’ID de la balise), case_status, ainsi que leurs case_role_id et case_designation.
Désactiver ou réactiver quelqu'un
PUT /users/relations/<user_id> accepte un seul champ : host_user_status. 0 permet de les désactiver, tandis que 1 permet de les réactiver. Cela correspond à l’instruction 204.
curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations/cu-4f1c2a9e8b7d60 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"host_user_status": 0}'
- Une personne handicapée est refusée partout dans votre centre de services, mais elle continue à utiliser ses comptes pour travailler avec d’autres entreprises. Voir Disable ou réactiver un utilisateur.
- Lorsque leur statut change, ils reçoivent un e-mail ou un message texte, s’ils n’ont pas d’e-mail. Ces messages indiquent que leur accès a été désactivé ou restauré. Envoyer les informations concernant leur statut actuel ne change rien et n’apporte aucun avantage.
- Une clé peut désactiver ou réactiver les droits des gestionnaires et des utilisateurs, mais pas ceux des administrateurs, ni elle-même.
Si un appel est refusé
| Statut | message | Pourquoi |
|---|---|---|
| 400 | SchemaFieldsException | Un champ est manquant ou n’est pas valide. Les noms utilisés pour désigner ces champs sont errors. Par exemple, FieldUsernameTypeException peut indiquer un nom d’utilisateur qui n’est pas une adresse e-mail ou un numéro de téléphone. De même, FieldPhoneTypeException peut indiquer un numéro de téléphone qui n’est pas valide. Enfin, FieldNameTypeException peut indiquer un nom. |
| 400 | FieldUsernameDupsException | Quelqu’un qui est actif dans votre réseau dispose déjà de cet adresse e-mail ou de ce numéro de téléphone. reason possède donc leur user_id. |
| 400 | HostUserDisabledException | Cette personne se trouve dans votre hub, mais elle est désactivée. Réactivez-la plutôt. reason détient user_id de cette personne. |
| 400 | UserReferenceIdExistsException | Quelqu’un d’autre possède déjà cette host_ref_id. |
| 400 | HostUserTypeNotAllowedException | Vous avez essayé de désactiver un administrateur, ou bien de désactiver la clé elle-même. |
| 403 | BotRelationFieldNotAllowedException | Vous avez activé la fonction de gestion des cas lors de l’ajout d’une personne ou de n’importe quel autre élément. host_user_status Lors du changement de ces éléments. |
| 404 | ItemNotFoundException | Personne dans votre région n’a ce user_id. |
Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.