Gestión de usuarios
La CLI de Vonage puede usarse para crear y administrar usuarios, un objeto que identifica a un usuario único de Vonage en el contexto de una aplicación de Vonage. Puedes obtener más información sobre conversaciones y usuarios en la documentación de la Conversation API.
Crear un usuario
En vonage users create te permite crear un usuario. Puedes establecer sus detalles y configuraciones específicas de canal utilizando las banderas de abajo:
Usuario
| Bandera | Descripción | Tipo |
|---|---|---|
--name | Su nombre de usuario interno. Debe ser único. Si no se proporciona, se utilizará un nombre generado aleatoriamente. | Cadena |
--display-name | El nombre de cara al público del usuario. | Cadena |
--image-url | Una URL a una imagen para asociar con el usuario. | Cadena |
--custom-data | Datos personalizados (como JSON) para asociar al usuario. | Cadena |
--ttl | Tiempo de baja. Después de cuántos segundos se elimina un usuario vacío. | Numbers |
RTPC
| Bandera | Descripción | Tipo |
|---|---|---|
--pstn-number | Número de teléfono que se asociará al usuario | Matriz |
SIP
| Bandera | Descripción | Tipo |
|---|---|---|
--sip-url | URL SIP a asociar con el usuario | Matriz |
--sip-username | Nombre de usuario SIP para asociar con el usuario | Matriz |
--sip-password | Contraseña SIP a asociar al usuario | Matriz |
WebSocket
| Bandera | Descripción | Tipo |
|---|---|---|
--websocket-url | URL de Websocket para asociar con el usuario | Matriz |
--websocket-content-type | Tipo de contenido Websocket a asociar con el usuario | Matriz |
--websocket-headers | Cabeceras Websocket (entrada como JSON) para asociar con el usuario | Matriz |
SMS
| Bandera | Descripción | Tipo |
|---|---|---|
--sms-number | Número de teléfono desde el que este usuario puede enviar/recibir SMS | Matriz |
MMS
| Bandera | Descripción | Tipo |
|---|---|---|
--mms-number | Número de teléfono desde el que este usuario puede enviar/recibir MMS | Matriz |
| Bandera | Descripción | Tipo |
|---|---|---|
--whats-app-number | Número de teléfono desde el que este usuario puede enviar/recibir mensajes de WhatsApp | Matriz |
Viber
| Bandera | Descripción | Tipo |
|---|---|---|
--viber-number | Número de teléfono desde el que este usuario puede enviar/recibir mensajes de Viber | Matriz |
Facebook Messenger
| Bandera | Descripción | Tipo |
|---|---|---|
--facebook-messenger-id | ID de Facebook Messenger desde el que este usuario puede enviar/recibir mensajes | Matriz |
Eliminar un usuario
En vonage users delete <id> se puede utilizar para eliminar un usuario, donde <id> es el ID del usuario a eliminar.
Lista de usuarios
En vonage users list le permite listar todos los usuarios que ha creado. Dado que puede haber un gran número de usuarios, este comando le pedirá que continúe paginando a través de los usuarios. Puede utilizar los siguientes indicadores para controlar el número de usuarios que se muestran por página:
Buscapersonas
| Bandera | Descripción | Tipo |
|---|---|---|
--page-size | Número de usuarios a devolver por página | Numbers (Predeterminado: 100) |
--cursor | Cursor para la página siguiente | |
--sort | Ordenar usuarios por nombre en orden ascendente o descendente | Cadena (debe ser una de: "ASC", "DESC") |
Usuario
| Bandera | Descripción | Tipo |
|---|---|---|
--name | Filtrar por nombre de usuario | Cadena |
Mostrar un usuario
En vonage users show <id> se puede utilizar para mostrar los detalles de un usuario determinado.
Actualizar un usuario
En vonage users update <id> se puede utilizar para actualizar la configuración de un usuario determinado. Utiliza los mismos indicadores que crear un usuario.