Gestion des utilisateurs

La CLI de Vonage peut être utilisée pour créer et gérer des utilisateurs, un objet qui identifie un utilisateur unique de Vonage dans le contexte d'une Application Vonage. Vous pouvez en savoir plus sur conversations et utilisateurs dans la documentation de la Conversation API.

Créer un utilisateur

Les vonage users create permet de créer un utilisateur. Vous pouvez définir les détails de l'utilisateur et les configurations spécifiques au canal en utilisant les drapeaux ci-dessous :

Utilisateur

Drapeau Description Type
--name Votre nom d'utilisateur interne. Il doit être unique. S'il n'est pas fourni, un nom généré de manière aléatoire sera utilisé. Chaîne
--display-name Le nom public de l'utilisateur. Chaîne
--image-url URL d'une image à associer à l'utilisateur. Chaîne
--custom-data Données personnalisées (sous forme de JSON) à associer à l'utilisateur. Chaîne
--ttl Time to leave. Après combien de secondes un utilisateur vide est supprimé. Numbers

RTPC

Drapeau Description Type
--pstn-number Numéro de téléphone à associer à l'utilisateur Tableau

SIP

Drapeau Description Type
--sip-url URL SIP à associer à l'utilisateur Tableau
--sip-username Nom d'utilisateur SIP à associer à l'utilisateur Tableau
--sip-password Mot de passe SIP à associer à l'utilisateur Tableau

WebSocket

Drapeau Description Type
--websocket-url URL Websocket à associer à l'utilisateur Tableau
--websocket-content-type Type de contenu Websocket à associer à l'utilisateur Tableau
--websocket-headers En-têtes Websocket (entrée en JSON) à associer à l'utilisateur Tableau

SMS

Drapeau Description Type
--sms-number Numéro de téléphone à partir duquel cet utilisateur peut envoyer/recevoir des SMS Tableau

MMS

Drapeau Description Type
--mms-number Numéro de téléphone à partir duquel cet utilisateur peut envoyer/recevoir des MMS Tableau

WhatsApp

Drapeau Description Type
--whats-app-number Numéro de téléphone à partir duquel cet utilisateur peut envoyer/recevoir des messages WhatsApp. Tableau

Viber

Drapeau Description Type
--viber-number Numéro de téléphone à partir duquel cet utilisateur peut envoyer/recevoir des messages Viber. Tableau

Facebook Messenger

Drapeau Description Type
--facebook-messenger-id Identifiant Facebook Messenger à partir duquel cet utilisateur peut envoyer/recevoir des messages Tableau
vonage users create `
  --name='Alice'
  
✅ Creating User

User ID: USR-00000000-0000-0000-0000-000000000000
Name: Alice
Display Name: Not Set
Image URL: Not Set
Time to Live: Not Set

Channels:
  None Set

Supprimer un utilisateur

Les vonage users delete <id> peut être utilisée pour supprimer un utilisateur, où <id> est l'identifiant de l'utilisateur à supprimer.

vonage users delete USR-00000000-0000-0000-0000-000000000000 

✅ Fetching User
Are you sure you want to delete this user? [y/n] y
✅ Deleting user

User deleted

Liste des utilisateurs

Les vonage users list vous permet de dresser la liste de tous les utilisateurs que vous avez créés. Comme il peut y avoir un grand nombre d'utilisateurs, cette commande vous demandera de continuer à parcourir les utilisateurs. Vous pouvez utiliser les drapeaux ci-dessous pour contrôler le nombre d'utilisateurs affichés par page :

Recherche de personnes

Drapeau Description Type
--page-size Nombre d'utilisateurs à renvoyer par page Nombre (par défaut : 100)
--cursor Curseur pour la page suivante
--sort Trier les utilisateurs par nom dans l'ordre croissant ou décroissant Chaîne (doit être l'un des éléments suivants : "ASC", "DESC")

Utilisateur

Drapeau Description Type
--name Filtrer par nom d'utilisateur Chaîne
vonage users 

✅ Fetching Users

User ID                                   Name                                      Display Name
----------------------------------------  ----------------------------------------  ------------
USR- 00000000-0000-0000-0000-000000000000 Alice

Montrer un utilisateur

Les vonage users show <id> peut être utilisée pour afficher les détails d'un utilisateur donné.

vonage users show USR-00000000-0000-0000-0000-000000000000 

✅ Fetching User

User ID: USR-00000000-0000-0000-0000-000000000000
Name: Alice
Display Name: Not Set
Image URL: Not Set
Time to Live: Not Set

Channels:
  None Set

Mise à jour d'un utilisateur

Les vonage users update <id> peut être utilisée pour mettre à jour la configuration d'un utilisateur donné. Elle utilise les mêmes drapeaux que la commande création d'un utilisateur.

vonage users update USR-00000000-0000-0000-0000-000000000000 `
  --name='bob' `
  --display-name='Bob' `
  --image-url='https://tinyurl.com/5ey2vhw2' \
  --custom-data='{"foo": "bar"}' `
  --ttl=600

✅ Fetching User
✅ Updating User

User ID: USR-00000000-0000-0000-0000-000000000000
Name: bob
Display Name: Bob
Image URL: https://developer.vonage.com/branding/vonage/assets/desktop-logo.svg
Time to Live: 600

Channels:
  None Set