Verwalten von Applications
Eine Vonage API-Anwendung enthält die Sicherheits- und Konfigurationsinformationen, die Sie benötigen, um sich mit Vonage Endpunkten zu verbinden und die Vonage APIs zu nutzen. Jede von Vonage erstellte Anwendung kann mehrere Funktionen unterstützen. Sie können zum Beispiel eine Application erstellen, die die Nutzung der Voice-, Messages- und RTC-APIs unterstützt.
Sie können die Vonage CLI verwenden, um Ihre Applications zu erstellen und zu verwalten, neue Funktionen hinzuzufügen und Ihre Webhook-Konfigurationsinformationen zu aktualisieren.
Erstellen einer Applikation
Die vonage apps create <name> können Sie eine Anwendung erstellen. Sie müssen einen Anwendungsnamen angeben, da die Befehlszeilenschnittstelle keinen Namen für Sie generiert.
Der Befehl hat die folgenden Flags:
Hinweis: Wenn Sie keinen eigenen Schlüssel zur Verfügung stellen, wird Vonage einen für Sie erstellen. Wenn Sie jedoch den Schlüssel bei der Erstellung der Anwendung nicht speichern, können Sie nicht mehr darauf zugreifen. Sie müssen den Schlüssel neu generieren, wenn Sie ihn verlieren.
Kopieren
vonage apps create 'Your application'
✅ Creating Application
Saving private key ... Done!
Application created
Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Capabilities:
None Enabled
Kopieren
vonage apps create 'Your application'
✅ Creating Application
Saving private key ... Done!
Application created
Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Capabilities:
None Enabled
vonage apps create 'Your application'
✅ Creating Application
Saving private key ... Done!
Application created
Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Capabilities:
None Enabled
Auflistung Ihrer Applications
Standardmäßig wird bei der Ausführung von vonage apps wird derselbe Sub-Befehl ausgeführt wie vonage apps list. Es gibt eine Reihe von Flaggen
die Sie übergeben können, um Ihre Suche zu verfeinern:
Kopieren
vonage apps
✅ Loading applications... Done
App ID Name Capabilities
------------------------------------ ----------------- ------------------------------------------------------
00000000-0000-0000-0000-000000000000 Application None
00000000-0000-0000-0000-000000000000 voice Application Messages, Voice
00000000-0000-0000-0000-000000000000 All enabled Messages, Network APIs, RTC, VBC, Verify, Video, Voice
Kopieren
vonage apps
✅ Loading applications... Done
App ID Name Capabilities
------------------------------------ ----------------- ------------------------------------------------------
00000000-0000-0000-0000-000000000000 Application None
00000000-0000-0000-0000-000000000000 voice Application Messages, Voice
00000000-0000-0000-0000-000000000000 All enabled Messages, Network APIs, RTC, VBC, Verify, Video, Voice
vonage apps
✅ Loading applications... Done
App ID Name Capabilities
------------------------------------ ------------------ ------------------------------------------------------
00000000-0000-0000-0000-000000000000 Application None
00000000-0000-0000-0000-000000000000 voice Application Messages, Voice
00000000-0000-0000-0000-000000000000 All enabled Messages, Network APIs, RTC, VBC, Verify, Video, Voice
Anwendungsdetails anzeigen
Die show sub können Sie die Details einer bestimmten Anwendung abrufen. Das Format des Befehls ist
vonage apps show <id>, wobei <id> ist die UUID der Anwendung.
Hinweis: Dadurch wird der öffentliche Schlüssel nicht angezeigt. Wenn Sie den öffentlichen Schlüssel sehen möchten, können Sie die Funktion --show-all, --json, oder --yaml Flaggen,
wodurch keine Informationen geschwärzt werden.
Kopieren
vonage apps show 00000000-0000-0000-0000-000000000000
✅ Fetching application
Name: All enabled
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Capabilities:
VOICE:
Uses Signed callbacks: On
Conversation TTL: 41 hours
Leg Persistence Time: 6 days
Event URL: [GET] https://example.com/voice/event
Answer URL: [GET] https://example.com/voice/answer
Fallback URL: [GET] https://example.com/voice/fallback
MESSAGES:
Authenticate Inbound Media: On
Webhook Version: v1
Status URL: [POST] https://example.com/meetings/status
Inbound URL: [POST] https://example.com/meetings/inbound
VERIFY:
Webhook Version: v2
Status URL: [POST] https://example.com/verify2/status
RTC:
Event URL: [POST] https://example.com/rtc/event
Uses Signed callbacks: On
VIDEO:
Archive Status URL: [POST] https://example.com/video/archive-status
Archive Status Signature Secret: archive status
Broadcast Status URL: [POST] https://example.com/video/broadcast-status
Broadcast Status Signature Secret: broadcast status
Caption Status URL: [POST] https://example.com/video/caption-status
Caption Status Signature Secret: caption-status
Connection Created URL: [POST] https://example.com/video/connected-created
Connection Created Signature Secret: connection created
Connection Destroyed URL: [POST] https://example.com/video/connection-destroyed
Connection Destroyed Signature Secret: connection destroyed
Render Status URL: [POST] https://example.com/video/render-status
Render Status Signature Secret: render status
SIP Call Created URL: [POST] https://example.com/video/sip1
SIP Call Created Signature Secret: Off
SIP Call Destroyed URL: [POST] https://example.com/video/sip3
SIP Call Destroyed Signature Secret: Off
SIP Call Mute Forced URL: [POST] https://example.com/video/sip4
SIP Call Mute Forced Signature Secret: Off
SIP Call Updated URL: [POST] https://example.com/video/sip2
SIP Call Updated Signature Secret: Off
Stream Created URL: [POST] https://example.com/video/stream-created
Stream Created Signature Secret: stream created
Stream Destroyed URL: [POST] https://example.com/video/stream-destroyed
Stream Destroyed Signature Secret: stream destroyed
RECORDINGS STORAGE:
Cloud Storage: On
Storage Type: AmazonS3
Credential: manchuck_aws_bucket
End to End Encryption: On
Server Side Encryption: On
NETWORK APIS:
Redirect URL: [GET] https://example.com/gnp/redirect
NB: VBC capabilities is not supported through the command line.
Kopieren
vonage apps show 00000000-0000-0000-0000-000000000000
✅ Fetching application
Name: All enabled
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Capabilities:
VOICE:
Uses Signed callbacks: On
Conversation TTL: 41 hours
Leg Persistence Time: 6 days
Event URL: [GET] https://example.com/voice/event
Answer URL: [GET] https://example.com/voice/answer
Fallback URL: [GET] https://example.com/voice/fallback
MESSAGES:
Authenticate Inbound Media: On
Webhook Version: v1
Status URL: [POST] https://example.com/meetings/status
Inbound URL: [POST] https://example.com/meetings/inbound
VERIFY:
Webhook Version: v2
Status URL: [POST] https://example.com/verify2/status
RTC:
Event URL: [POST] https://example.com/rtc/event
Uses Signed callbacks: On
VIDEO:
Archive Status URL: [POST] https://example.com/video/archive-status
Archive Status Signature Secret: archive status
Broadcast Status URL: [POST] https://example.com/video/broadcast-status
Broadcast Status Signature Secret: broadcast status
Caption Status URL: [POST] https://example.com/video/caption-status
Caption Status Signature Secret: caption-status
Connection Created URL: [POST] https://example.com/video/connected-created
Connection Created Signature Secret: connection created
Connection Destroyed URL: [POST] https://example.com/video/connection-destroyed
Connection Destroyed Signature Secret: connection destroyed
Render Status URL: [POST] https://example.com/video/render-status
Render Status Signature Secret: render status
SIP Call Created URL: [POST] https://example.com/video/sip1
SIP Call Created Signature Secret: Off
SIP Call Destroyed URL: [POST] https://example.com/video/sip3
SIP Call Destroyed Signature Secret: Off
SIP Call Mute Forced URL: [POST] https://example.com/video/sip4
SIP Call Mute Forced Signature Secret: Off
SIP Call Updated URL: [POST] https://example.com/video/sip2
SIP Call Updated Signature Secret: Off
Stream Created URL: [POST] https://example.com/video/stream-created
Stream Created Signature Secret: stream created
Stream Destroyed URL: [POST] https://example.com/video/stream-destroyed
Stream Destroyed Signature Secret: stream destroyed
RECORDINGS STORAGE:
Cloud Storage: On
Storage Type: AmazonS3
Credential: manchuck_aws_bucket
End to End Encryption: On
Server Side Encryption: On
NETWORK APIS:
Redirect URL: [GET] https://example.com/gnp/redirect
NB: VBC capabilities is not supported through the command line.
vonage apps show 00000000-0000-0000-0000-000000000000
✅ Fetching application
Name: All enabled
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Capabilities:
VOICE:
Uses Signed callbacks: On
Conversation TTL: 41 hours
Leg Persistence Time: 6 days
Event URL: [GET] https://example.com/voice/event
Answer URL: [GET] https://example.com/voice/answer
Fallback URL: [GET] https://example.com/voice/fallback
MESSAGES:
Authenticate Inbound Media: On
Webhook Version: v1
Status URL: [POST] https://example.com/meetings/status
Inbound URL: [POST] https://example.com/meetings/inbound
VERIFY:
Webhook Version: v2
Status URL: [POST] https://example.com/verify2/status
RTC:
Event URL: [POST] https://example.com/rtc/event
Uses Signed callbacks: On
VIDEO:
Archive Status URL: [POST] https://example.com/video/archive-status
Archive Status Signature Secret: archive status
Broadcast Status URL: [POST] https://example.com/video/broadcast-status
Broadcast Status Signature Secret: broadcast status
Caption Status URL: [POST] https://example.com/video/caption-status
Caption Status Signature Secret: caption-status
Connection Created URL: [POST] https://example.com/video/connected-created
Connection Created Signature Secret: connection created
Connection Destroyed URL: [POST] https://example.com/video/connection-destroyed
Connection Destroyed Signature Secret: connection destroyed
Render Status URL: [POST] https://example.com/video/render-status
Render Status Signature Secret: render status
SIP Call Created URL: [POST] https://example.com/video/sip1
SIP Call Created Signature Secret: Off
SIP Call Destroyed URL: [POST] https://example.com/video/sip3
SIP Call Destroyed Signature Secret: Off
SIP Call Mute Forced URL: [POST] https://example.com/video/sip4
SIP Call Mute Forced Signature Secret: Off
SIP Call Updated URL: [POST] https://example.com/video/sip2
SIP Call Updated Signature Secret: Off
Stream Created URL: [POST] https://example.com/video/stream-created
Stream Created Signature Secret: stream created
Stream Destroyed URL: [POST] https://example.com/video/stream-destroyed
Stream Destroyed Signature Secret: stream destroyed
RECORDINGS STORAGE:
Cloud Storage: On
Storage Type: AmazonS3
Credential: manchuck_aws_bucket
End to End Encryption: On
Server Side Encryption: On
NETWORK APIS:
Redirect URL: [GET] https://example.com/gnp/redirect
NB: VBC capabilities is not supported through the command line.
Aktualisieren einer Applikation
vonage apps update <id> können Sie den Namen einer bestehenden Anwendung aktualisieren, die Einstellung "Improve AI" ändern oder einen neuen öffentlichen Schlüssel festlegen:
Kopieren
vonage apps update 00000000-0000-0000-0000-000000000000 `
--name="New Application Name"
✅ Fetching Application
✅ Updating Application
Name: New Application Name
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Kopieren
vonage apps update 00000000-0000-0000-0000-000000000000 ^
--name="New Application Name"
✅ Fetching Application
✅ Updating Application
Name: New Application Name
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
vonage apps update 00000000-0000-0000-0000-000000000000 \
--name="New Application Name"
✅ Fetching Application
✅ Updating Application
Name: New Application Name
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set
Löschen einer Applikation
Sie können eine Anwendung mit dem Befehl vonage apps delete <id>, wobei id ist die UUID der Anwendung:
Kopieren
vonage apps delete 00000000-0000-0000-0000-000000000000
✅ Fetching application
Delete application New Name (7d7133ab-de4e-4b7a-8e1e-376670077c71)? [y/n]
✅ Deleting application
Kopieren
vonage apps delete 00000000-0000-0000-0000-000000000000
✅ Fetching application
Delete application New Name (7d7133ab-de4e-4b7a-8e1e-376670077c71)? [y/n]
✅ Deleting application
vonage apps delete 00000000-0000-0000-0000-000000000000
✅ Fetching application
Delete application New Name (7d7133ab-de4e-4b7a-8e1e-376670077c71)? [y/n]
✅ Deleting application