Gerenciamento de usuários

A CLI da Vonage pode ser usada para criar e gerenciar usuários, um objeto que identifica um usuário exclusivo da Vonage no contexto de uma Application da Vonage. Você pode ler mais sobre conversas e usuários na documentação da Conversation API.

Criar um usuário

O vonage users create O comando permite criar um usuário. Você pode definir os detalhes dele e as configurações específicas do canal usando os parâmetros a seguir:

Usuário

Bandeira Descrição Tipo
--name Seu nome de usuário interno. Deve ser único. Caso não seja fornecido, será utilizado um nome gerado aleatoriamente. String
--display-name O nome do usuário exibido ao público. String
--image-url Um URL de uma imagem a ser associada ao usuário. String
--custom-data Dados personalizados (no formato JSON) a serem associados ao usuário. String
--ttl Hora de sair. Após quantos segundos um usuário vazio é excluído. Número

PSTN

Bandeira Descrição Tipo
--pstn-number Número de telefone a ser associado ao usuário Matriz

SIP

Bandeira Descrição Tipo
--sip-url URL SIP a ser associada ao usuário Matriz
--sip-username Nome de usuário SIP a ser associado ao usuário Matriz
--sip-password Senha SIP a ser associada ao usuário Matriz

WebSocket

Bandeira Descrição Tipo
--websocket-url URL do WebSocket a ser associada ao usuário Matriz
--websocket-content-type Tipo de conteúdo WebSocket a ser associado ao usuário Matriz
--websocket-headers Cabeçalhos WebSocket (entrada em JSON) a serem associados ao usuário Matriz

SMS

Bandeira Descrição Tipo
--sms-number Número de telefone do qual este usuário pode enviar/receber SMS Matriz

MMS

Bandeira Descrição Tipo
--mms-number Número de telefone do qual este usuário pode enviar/receber MMS Matriz

WhatsApp

Bandeira Descrição Tipo
--whats-app-number Número de telefone do qual este usuário pode enviar/receber mensagens pelo WhatsApp Matriz

Viber

Bandeira Descrição Tipo
--viber-number Número de telefone do qual este usuário pode enviar/receber mensagens pelo Viber Matriz

Facebook Messenger

Bandeira Descrição Tipo
--facebook-messenger-id ID do Facebook Messenger com o qual esse usuário pode enviar e receber mensagens Matriz
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

Excluir um usuário

O vonage users delete <id> O comando pode ser usado para excluir um usuário, onde <id> é o ID do usuário a ser excluído.

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

Listar usuários

O vonage users list O comando permite listar todos os usuários que você criou. Como pode haver um grande número de usuários, esse comando solicitará que você continue navegando pelas páginas de usuários. Você pode usar os parâmetros abaixo para controlar o número de usuários exibidos por página:

Paginação

Bandeira Descrição Tipo
--page-size Número de usuários a serem exibidos por página Número (Padrão: 100)
--cursor Cursor para a próxima página
--sort Classificar os usuários por nome em ordem crescente ou decrescente String (deve ser uma das seguintes opções: "ASC", "DESC")

Usuário

Bandeira Descrição Tipo
--name Filtrar por nome de usuário String
vonage users 

✅ Fetching Users

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

Mostrar um usuário

O vonage users show <id> O comando pode ser usado para exibir os detalhes de um determinado usuário.

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

Atualizar um usuário

O vonage users update <id> O comando pode ser usado para atualizar a configuração de um determinado usuário. Ele utiliza os mesmos parâmetros que criar um usuário.

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