Bevor Sie beginnen
Was sind Code Snippets?
Code-Snippets sind kurze Codestücke, die Sie in Ihren eigenen Applications wiederverwenden können. Die Code-Snippets verwenden Code aus Beispiel-Repositories.
Bitte lesen Sie diese Informationen sorgfältig, damit Sie die Codeschnipsel optimal nutzen können.
Voraussetzungen
Bevor Sie fortfahren, müssen Sie Vonage Account erstellen um Applications und Numbers zu verwalten.
Erstellen einer Applikation
Gehen Sie zum ApplikationSeite auf dem Dashboard, und definieren Sie eine Name für Ihre Bewerbung.
Achten Sie darauf, dass Sie auf das Öffentlichen und privaten Schlüssel generieren und behalten Sie die Datei private.key herum.
Aktivieren Sie dann die Stimme Fähigkeit. Lassen Sie vorerst alles in der Standardeinstellung.
Klicken Sie schließlich auf Neue Anwendung generieren am Ende der Seite.
Auschecken Erste Schritte mit Vonage CLI für weitere Informationen über die Installation und Konfiguration der CLI.
Verwenden Sie den folgenden Befehl, um eine Vonage-Anwendung zu erstellen:
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
Sobald Sie die Anwendung haben, müssen Sie die voice Fähigkeiten; stellen Sie sicher, dass Sie die Webhook-URLs durch Ihre eigenen ersetzen:
vonage apps capabilities update 00000000-0000-0000-0000-000000000000 voice `
--voice-answer-url='https://example.com/webhooks/voice/answer' `
--voice-event-url='https://example.com/webhooks/voice/event' `
--voice-fallback-url='https://example.com/webhooks/voice/fallback'
✅ Fetching Application
✅ Adding voice capability to application 00000000-0000-0000-0000-000000000000
Name: Your application
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: [POST] https://example.com/webhooks/voice/event
Answer URL: [POST] https://example.com/webhooks/voice/answer
Fallback URL: [POST] https://example.com/webhooks/voice/fallback
vonage apps capabilities update 00000000-0000-0000-0000-000000000000 voice ^
--voice-answer-url='https://example.com/webhooks/voice/answer' ^
--voice-event-url='https://example.com/webhooks/voice/event' ^
--voice-fallback-url='https://example.com/webhooks/voice/fallback'
✅ Fetching Application
✅ Adding voice capability to application 00000000-0000-0000-0000-000000000000
Name: Your application
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: [POST] https://example.com/webhooks/voice/event
Answer URL: [POST] https://example.com/webhooks/voice/answer
Fallback URL: [POST] https://example.com/webhooks/voice/fallback
Die Anwendung wird dann erstellt und verfügt über die erforderlichen Funktionen. Das Erstellen einer Anwendung und das Hinzufügen von Anwendungsfähigkeiten wird im Detail in der Dokumentation der Applications.
Numbers mieten
Gehen Sie im Dashboard auf die Seite Numbers kaufen Seite. Vergewissern Sie sich, dass Sie Folgendes ankreuzen Stimme im Suchfilter, und wählen Sie das Land aus, in dem Sie eine Nummer kaufen möchten. In einigen Ländern müssen Sie möglicherweise eine Nummer beantragen, da zusätzliche Dokumente erforderlich sein können.
Sie können dann auf die Schaltfläche Kaufen neben der gewünschten Nummer, und bestätigen Sie Ihren Kauf.
Herzlichen Glückwunsch! Ihre virtuelle Nummer ist jetzt in der Liste Ihre Numbers.
Sie können eine Nummer über die Vonage CLI mieten. Der folgende Befehl sucht nach einer verfügbaren Nummer in den Vereinigten Staaten:
vonage numbers search US
✅ Searching for numbers
There is 1 number available for purchase in United States
Number Type Features Monthly Cost Setup Cost
----------- ------ --------------- ------------ ----------
16127779311 Mobile MMS, SMS, VOICE €0.90 €0.00
Use vonage numbers buy to purchase.
vonage numbers search US
✅ Searching for numbers
There is 1 number available for purchase in United States
Number Type Features Monthly Cost Setup Cost
----------- ------ --------------- ------------ ----------
16127779311 Mobile MMS, SMS, VOICE €0.90 €0.00
Use vonage numbers buy to purchase.
Verwenden Sie diesen Befehl, um eine Nummer zu kaufen:
vonage numbers buy US 16127779311
✅ Searching for numbers
Are you sure you want to purchase the number 16127779311 for €0.90? [y/n] y
✅ Purchasing number
Number 16127779311 purchased
Number: 16127779311
Country: 🇺🇸 United States
Type: Mobile
Features: MMS, SMS, VOICE
Monthly Cost: €0.90
Setup Cost: €0.00
Linked Application ID: Not linked to any application
Voice Callback: Not Set
Voice Callback Value: Not Set
Voice Status Callback: Not Set
vonage numbers buy US 16127779311
✅ Searching for numbers
Are you sure you want to purchase the number 16127779311 for €0.90? [y/n] y
✅ Purchasing number
Number 16127779311 purchased
Number: 16127779311
Country: 🇺🇸 United States
Type: Mobile
Features: MMS, SMS, VOICE
Monthly Cost: €0.90
Setup Cost: €0.00
Linked Application ID: Not linked to any application
Voice Callback: Not Set
Voice Callback Value: Not Set
Voice Status Callback: Not Set
Geben Sie an. einen alternativen zweistelligen Ländercode für den Kauf einer Nummer in einem anderen Land.
Verknüpfung einer Number
Da Sie nun sowohl einen Antrag als auch eine Nummer haben, müssen Sie diese miteinander verknüpfen.
Gehen Sie zum Applikation und klicken Sie auf die Anwendung, die Sie zuvor erstellt haben.
In der Stimme Abschnitt, klicken Sie auf den Link neben der Nummer, die Sie verknüpfen möchten.
Da Sie nun sowohl einen Antrag als auch eine Nummer haben, müssen Sie diese miteinander verknüpfen.
vonage apps numbers link 00000000-0000-0000-0000-000000000000 16127779311
✅ Fetching Application
Fetching Owned numbers [===============================================] 1/1 100%
Number linked
Number: 16127779311
Country: 🇺🇸 United States
Type: Toll-free
Features: MMS, SMS, VOICE
Monthly Cost: Not Set
Setup Cost: Not Set
Linked Application ID: 00000000-0000-0000-0000-000000000000
Voice Callback: app
Voice Callback Value: 00000000-0000-0000-0000-000000000000
Voice Status Callback: Not Set
vonage apps numbers link 00000000-0000-0000-0000-000000000000 16127779311
✅ Fetching Application
Fetching Owned numbers [===============================================] 1/1 100%
Number linked
Number: 16127779311
Country: 🇺🇸 United States
Type: Toll-free
Features: MMS, SMS, VOICE
Monthly Cost: Not Set
Setup Cost: Not Set
Linked Application ID: 00000000-0000-0000-0000-000000000000
Voice Callback: app
Voice Callback Value: 00000000-0000-0000-0000-000000000000
Voice Status Callback: Not Set
Andere Ressourcen:
Ersetzbare Variablen
Generisch austauschbar
Die folgenden austauschbaren Informationen hängen von der Bibliothek und dem jeweiligen Aufruf ab:
| Schlüssel | Beschreibung |
|---|---|
VONAGE_API_KEY | Your Vonage API key (see it on your dashboard). |
VONAGE_API_SECRET | Your Vonage API secret (also available on your dashboard). |
VONAGE_APPLICATION_PRIVATE_KEY_PATH | Private key path. |
VONAGE_APPLICATION_PRIVATE_KEY | Private key. |
VONAGE_APPLICATION_ID | The Vonage Application ID. |
JWT | Used to authenticate your request. See Authentication for more information, including how to generate a JWT. |
Numbers
Alle Telefonnummern sind im E.164-Format.
| Schlüssel | Beschreibung |
|---|---|
VONAGE_VIRTUAL_NUMBER | Your Vonage Number. E.g. |
VOICE_TO_NUMBER | The recipient number to call, e.g. |
UUIDs
UUIDs werden normalerweise in den Codeschnipseln verwendet, um einen bestimmten Aufruf zu identifizieren.
| Schlüssel | Beschreibung |
|---|---|
VOICE_CALL_ID | The UUID of the call leg. |
Spezifisch ersetzbar/Variablen
Einige Codeschnipsel haben speziellere Variablen, die durch tatsächliche Werte ersetzt werden müssen. durch aktuelle Werte ersetzt werden müssen. Diese können für jeden Codeausschnitt einzeln festgelegt werden.
Authentifizierung
Voice API erfordert eine Authentifizierung mit JWTs. Sie können ein JWT mit der Funktion Vonage CLI oder die Online-Tool.
Webhaken
Die wichtigsten, die Sie hier treffen werden, sind:
/webhooks/answer- Vonage stellt hier eine GET-Anfrage, wenn Sie einen eingehenden Anruf erhalten. Sie antworten mit einem NCCO./webhooks/event- Vonage stellt hier POST-Anfragen, wenn ein Ereignis eintritt. Sie erhalten ein JSON-Ereignis./webhooks/recordings- Vonage stellt hier eine POST-Anfrage, wenn die Aufzeichnung verfügbar ist. Sie erhalten ein JSON-Objekt mit Aufzeichnungsdetails./webhooks/dtmf- Vonage POSTet hier die DTMF-Eingabe des Benutzers in einem JSON-Objekt.
Wenn Sie Ngrok verwenden, setzen Sie Ihre Webhook-URLs im Vonage Application-Objekt auf etwas wie:
https://demo.ngrok.io/webhooks/answerhttps://demo.ngrok.io/webhooks/eventhttps://demo.ngrok.io/webhooks/recordingshttps://demo.ngrok.io/webhooks/dtmf
Ändern Sie demo mit dem, was in Ihrem Fall zutrifft.