Bevor Sie beginnen

Dieses Thema enthält einige Hintergrundinformationen zur Verwendung der Codeschnipsel.

Was sind Code Snippets?

Code-Snippets sind kurze Codestücke, die Sie in Ihren eigenen Applikationen wiederverwenden können.

Die Codeschnipsel verwenden den Code aus dem Vonage Node Code-Schnipsel und Vonage Curl Code-Schnipsel Repositories.

Bitte lesen Sie diese Informationen sorgfältig, damit Sie die Codeschnipsel optimal nutzen können.

Voraussetzungen

  1. Erstellen eines Vonage API Accounts
  2. Node JS installieren - die für die Verwendung der Vonage-Befehlszeilenschnittstelle (CLI) erforderlich sind.
  3. Installieren Sie die Vonage CLI
  4. Installieren Sie das Node Server SDK - nur erforderlich bei Verwendung von Node.
  5. Webhooks konfigurieren.
  6. Wissen, wie man einen Webhook-Server schreibt
  7. Wissen, wie Sie Ihren Webhook-Server lokal testen können

Ersetzbare Variablen

Generisch austauschbar

Die folgenden austauschbaren Informationen hängen von der Bibliothek und dem jeweiligen Aufruf ab:

SchlüsselBeschreibung
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.

Numbers

Alle Telefonnummern sind im E.164-Format.

SchlüsselBeschreibung
VONAGE_NUMBER

Your Vonage Number. E.g. 447700900000

FROM_NUMBER

Replace with number you are sending from. E.g. 447700900002

TO_NUMBER

Replace with the number you are sending to. E.g. 447700900001

Spezifisch ersetzbar/Variablen

Einige Code-Snippets haben speziellere Variablen, wie z. B. Facebook-Seiten-IDs, die durch tatsächliche Werte ersetzt werden müssen. Falls erforderlich, werden diese für jedes Codefragment einzeln angegeben.

Webhaken

Die wichtigsten, die Sie hier treffen werden, sind:

  • /webhooks/messages/inbound - Hier erhalten Sie einen Rückruf, wenn Vonage eine Nachricht erhält.
  • /webhooks/messages/status - Sie erhalten hier einen Rückruf, wenn Vonage eine Statusaktualisierung einer Nachricht erhält.

Wenn Sie lokal testen, indem Sie Ngrok setzen Sie Ihre Webhook-URLs im Vonage Application-Objekt in einem ähnlichen Format wie in den folgenden Beispielen:

  • https://demo.ngrok.io/webhooks/messages/inbound
  • https://demo.ngrok.io/webhooks/messages/status

Ändern Sie demo mit dem, was Ngrok für Sie generiert, es sei denn, Sie haben für eine wiederverwendbare URL bezahlt.

HINWEIS: Stellen Sie sicher, dass Ihre Webhook-URLs konfiguriert sind und Ihr Webhooks-Server läuft, bevor Sie Ihre Anwendung testen.

TIPP: Sie müssen diesen Schritt nur durchführen, wenn Sie mit Curl testen, da die Client- und Server-SDKs JWTs nach Bedarf für Sie generieren.

Sobald Sie eine Vonage API Application erstellt haben, können Sie die Application ID und die private Schlüsseldatei verwenden, private.key, um ein JWT zu erzeugen.

Um ein JWT-Token zu erstellen, verwenden Sie die Vonage CLIverwenden Sie diesen Befehl

# A command with parameters
vonage jwt create `
--app-id='00000000-0000-0000-0000-000000000000' `
--private-key=./private.key

# Will produce a token
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MzYyODE5NDYsImp0aSI6IjBmZjcwZDNmLTAzN2EtNGY4MC04ODZjLWI3MmM3MmQyMWNmMiIsImlhdCI6MTczNjI4MTA0NiwiYXBwbGljYXRpb25faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAifQ.gA7jClpqaZ2OoS0iri-zGCbda4jO7C0M8mka0EnSyjlds1EeY8fNoBEx3FTXHfkkzzrj0TskrWc_dcs1wuM8Kx55c5rLQ7taVpDAYopKSc_CeeOaad8S6aWnRkTUTNeduO4aIn-0CbyRTluBYsH1RBqYBQvobuQIDEwbFw8xBgx0UfREMMN6DAWknR57eiVXN9x_oD6CGQJ1yV3025nGboeMsP9YgX4Nwc-rE2r8c1ZGwCLO81x8i19Qil3Nwu5q1nzouyavQjIw00B_TZkushnI1ufdi_GNqk-h5q2HvGkg7Pj9bVkZHFdVTO8im03JYNyJmcV83vnpjOLuCFRzxQ

Alternativ können Sie auch unser JWT-Webanwendung um ein JWT zu erzeugen.

TIPP: Sie können Ihr generiertes JWT testen unter jwt.io