Avant de commencer

Cette rubrique fournit des informations générales sur l'utilisation des extraits de code.

Qu'est-ce qu'un extrait de code ?

Les extraits de code sont de courts morceaux de code que vous pouvez réutiliser dans vos propres Applications.

Les extraits de code utilisent le code de l'application Extraits de code du nœud Vonage et Extraits de code de Vonage Curl des référentiels.

Veuillez lire attentivement ces informations afin d'utiliser au mieux les extraits de code.

Conditions préalables

  1. Créer un Account API Vonage
  2. Installer Node JS - nécessaire pour utiliser l'interface de ligne de commande (CLI) de Vonage.
  3. Installer le CLI de Vonage
  4. Installer le SDK du serveur Node - uniquement nécessaire si vous utilisez Node.
  5. Configurer les webhooks.
  6. Savoir écrire un serveur webhook
  7. Savoir comment tester votre serveur webhook localement

Variables remplaçables

Générique remplaçable

Les informations remplaçables suivantes dépendent de la bibliothèque et de l'appel spécifique :

CléDescription
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

Tous les numéros de téléphone sont au format E.164.

CléDescription
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

Remplaçables/variables spécifiques

Certains extraits de code contiennent des variables plus spécialisées, telles que les identifiants des pages Facebook, qui devront être remplacées par des valeurs réelles. Le cas échéant, ces valeurs sont spécifiées pour chaque extrait de code.

Crochets Web

Les principaux sont ceux que vous rencontrerez ici :

  • /webhooks/messages/inbound - Vous recevrez un rappel ici lorsque Vonage recevra un message.
  • /webhooks/messages/status - Vous recevrez un rappel ici lorsque Vonage recevra une mise à jour de l'état d'un message.

Si vous effectuez des tests locaux en utilisant Ngrok vous définirez les URL de votre webhook dans l'objet Vonage Application en utilisant un format similaire aux exemples suivants :

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

Changer demo dans le texte ci-dessus avec ce que Ngrok génère pour vous, sauf si vous avez payé pour une URL réutilisable.

NOTE : Assurez-vous que vos URL de webhooks sont configurées et que votre serveur de webhooks fonctionne avant de tester votre application.

TIP : Cette étape n'est nécessaire que si vous testez avec Curl, car les SDK Client et Serveur génèrent les JWT nécessaires.

Une fois que vous avez créé une Application API Vonage, vous pouvez utiliser l'ID de l'Application et le fichier de clé privée, private.key, pour générer un JWT.

Pour créer un jeton JWT à l'aide de la fonction CLI VonageUtilisez la commande suivante

# 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

Vous pouvez également utiliser notre Application web JWT pour générer un JWT.

TIP : Vous pouvez tester le JWT généré à l'adresse suivante jwt.io