Benutzer verwalten

Die Vonage CLI kann zum Erstellen und Verwalten von Benutzern verwendet werden, einem Objekt, das einen eindeutigen Vonage Benutzer im Kontext einer Vonage Applikation identifiziert. Sie können mehr lesen über Unterhaltungen und Benutzer in der Conversation API-Dokumentation.

Einen Benutzer erstellen

Die vonage users create können Sie einen Benutzer erstellen. Mit den nachstehenden Flags können Sie Details und kanalspezifische Konfigurationen festlegen:

Benutzer

Flagge Beschreibung Typ
--name Ihr interner Nutzername. Muss eindeutig sein. Wenn Sie keinen Namen angeben, wird ein zufällig generierter Name verwendet. Zeichenfolge
--display-name Der öffentlich sichtbare Name des Benutzers. Zeichenfolge
--image-url Eine URL zu einem Bild, das mit dem Benutzer verknüpft werden soll. Zeichenfolge
--custom-data Benutzerdefinierte Daten (als JSON), die mit dem Benutzer verknüpft werden sollen. Zeichenfolge
--ttl Zeit bis zum Verlassen. Nach wie vielen Sekunden wird ein leerer Benutzer gelöscht. Numbers

PSTN

Flagge Beschreibung Typ
--pstn-number Telefonnummer, die mit dem Benutzer verknüpft werden soll Array

SIP

Flagge Beschreibung Typ
--sip-url SIP-URL, die mit dem Benutzer verknüpft werden soll Array
--sip-username SIP-Benutzername, der mit dem Benutzer verknüpft werden soll Array
--sip-password SIP-Passwort, das mit dem Benutzer verknüpft werden soll Array

WebSocket

Flagge Beschreibung Typ
--websocket-url Websocket-URL, die mit dem Benutzer verknüpft werden soll Array
--websocket-content-type Websocket-Inhaltstyp, der mit dem Benutzer verknüpft werden soll Array
--websocket-headers Websocket-Header (Eingabe als JSON), um sie mit dem Benutzer zu verknüpfen Array

SMS

Flagge Beschreibung Typ
--sms-number Telefonnummer, von der dieser Benutzer SMS senden/empfangen kann Array

MMS

Flagge Beschreibung Typ
--mms-number Rufnummer, von der dieser Benutzer MMS senden/empfangen kann Array

WhatsApp

Flagge Beschreibung Typ
--whats-app-number Telefonnummer, von der dieser Benutzer WhatsApp-Nachrichten senden/empfangen kann Array

Viber

Flagge Beschreibung Typ
--viber-number Rufnummer, von der dieser Benutzer Viber-Nachrichten senden/empfangen kann Array

Facebook Messenger

Flagge Beschreibung Typ
--facebook-messenger-id Facebook Messenger ID, von der dieser Benutzer Nachrichten senden/empfangen kann Array
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

Einen Benutzer löschen

Die vonage users delete <id> Befehl kann zum Löschen eines Benutzers verwendet werden, wobei <id> ist die ID des zu löschenden Benutzers.

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

Benutzer auflisten

Die vonage users list können Sie alle Benutzer auflisten, die Sie erstellt haben. Da es eine große Anzahl von Benutzern geben kann, werden Sie mit diesem Befehl aufgefordert, die Benutzer weiter durchzublättern. Mit den nachstehenden Flags können Sie die Anzahl der pro Seite angezeigten Benutzer steuern:

Paging

Flagge Beschreibung Typ
--page-size Numbers der Benutzer, die pro Seite zurückkehren Numbers (Standard: 100)
--cursor Cursor für die nächste Seite
--sort Benutzer nach Namen in aufsteigender oder absteigender Reihenfolge sortieren String (muss einer der folgenden sein: "ASC", "DESC")

Benutzer

Flagge Beschreibung Typ
--name Nach Benutzernamen filtern Zeichenfolge
vonage users 

✅ Fetching Users

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

Benutzer anzeigen

Die vonage users show <id> kann verwendet werden, um die Details eines bestimmten Benutzers anzuzeigen.

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

Benutzer aktualisieren

Die vonage users update <id> kann verwendet werden, um die Konfiguration eines bestimmten Benutzers zu aktualisieren. Er verwendet die gleichen Flags wie Erstellen eines Benutzers.

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