ユーザーの管理
Vonage CLI は、Vonage アプリケーションのコンテキストで一意の Vonage ユーザを識別するオブジェクトであるユーザの作成と管理に使用できます。詳しくは 会話 そして ユーザー Conversation API ドキュメントを参照してください。
ユーザーの作成
について vonage users create コマンドでユーザーを作成できます。以下のフラグを使用して、ユーザーの詳細とチャンネル固有の設定を行うことができます:
ユーザー
| フラッグ | 説明 | タイプ |
|---|---|---|
--name | 内部ユーザー名。一意でなければならない。提供されない場合、ランダムに生成された名前が使用されます。 | ストリング |
--display-name | ユーザーの一般公開名。 | ストリング |
--image-url | ユーザーに関連付ける画像へのURL。 | ストリング |
--custom-data | ユーザーに関連付けるカスタムデータ(JSONとして)。 | ストリング |
--ttl | 退出までの時間。何秒後に空のユーザーが削除されるか。 | Numbers |
PSTN
| フラッグ | 説明 | タイプ |
|---|---|---|
--pstn-number | ユーザーと関連付ける電話番号 | 配列 |
シップ
| フラッグ | 説明 | タイプ |
|---|---|---|
--sip-url | ユーザーに関連付けるSIP URL | 配列 |
--sip-username | ユーザに関連付けるSIPユーザ名 | 配列 |
--sip-password | ユーザーに関連付けるSIPパスワード | 配列 |
ウェブソケット
| フラッグ | 説明 | タイプ |
|---|---|---|
--websocket-url | ユーザーに関連付けるウェブソケットURL | 配列 |
--websocket-content-type | ユーザーに関連付けるWebsocketコンテンツ・タイプ | 配列 |
--websocket-headers | ユーザーに関連付けるWebsocketヘッダー(JSONとして入力 | 配列 |
ショートメール
| フラッグ | 説明 | タイプ |
|---|---|---|
--sms-number | このユーザーがSMSを送受信できる電話番号 | 配列 |
MMS
| フラッグ | 説明 | タイプ |
|---|---|---|
--mms-number | このユーザーがMMSを送受信できる電話番号 | 配列 |
| フラッグ | 説明 | タイプ |
|---|---|---|
--whats-app-number | このユーザーがWhatsAppメッセージを送受信できる電話番号 | 配列 |
バイバー
| フラッグ | 説明 | タイプ |
|---|---|---|
--viber-number | このユーザーがViberメッセージを送受信できる電話番号 | 配列 |
フェイスブックメッセンジャー
| フラッグ | 説明 | タイプ |
|---|---|---|
--facebook-messenger-id | このユーザーがメッセージを送受信できるFacebook Messenger ID | 配列 |
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
ユーザーの削除
について vonage users delete <id> コマンドを使ってユーザーを削除することができます。 <id> は削除するユーザーのIDである。
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
ユーザー一覧
について vonage users list コマンドを使用すると、作成したすべてのユーザーをリストすることができます。多数のユーザが存在する可能性があるため、このコマンドはユーザのページングを続行するよう促します。以下のフラグを使用して、ページごとに返されるユーザの数を制御することができます:
ページング
| フラッグ | 説明 | タイプ |
|---|---|---|
--page-size | ページごとに返すユーザー数 | Numbers(デフォルト:100) |
--cursor | 次のページへのカーソル | |
--sort | ユーザーの名前を昇順または降順に並べ替える | 文字列(以下のいずれかでなければならない: "ASC", "DESC") |
ユーザー
| フラッグ | 説明 | タイプ |
|---|---|---|
--name | ユーザー名によるフィルタリング | ストリング |
vonage users ✅ Fetching Users User ID Name Display Name ---------------------------------------- ---------------------------------------- ------------ USR- 00000000-0000-0000-0000-000000000000 Alice
ユーザーを表示する
について vonage users show <id> コマンドを使うと、指定したユーザーの詳細を表示することができる。
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
ユーザーの更新
について vonage users update <id> コマンドは、指定したユーザーのコンフィギュレーションを更新するために使用できる。このコマンドは ユーザー作成.
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