Configurez vos conditions préalables

Vous pouvez créer un compte Vonage via le site Web de Tableau de bord.

Dans le tableau de bord, vous pouvez créer des Applications et acheter des numéros Vonage. Vous pouvez également effectuer ces tâches à l'aide de la fonction CLI Vonage.

Si vous souhaitez effectuer des tâches telles que la création d'applications, l'achat de numéros Vonage, etc., vous devez installer le CLI de Vonage. Comme le CLI de Vonage nécessite node.js vous devrez installer node.js d'abord.

Pour s'assurer que node.js est installé, veuillez exécuter la commande suivante dans le terminal :

Suivez les étapes décrites sur la page Démarrer avec l'interface de programmation de Vonage pour installer et configurer la ligne de commande.

Si vous prévoyez d'utiliser JavaScript pour développer votre application, vous devrez installer (ou mettre à jour) le SDK Vonage Node Server.

Installation

Le SDK Node Server peut être installé en utilisant :

Si vous avez déjà installé le SDK serveur, la commande ci-dessus mettra à jour votre SDK serveur vers la dernière version.

Utilisation

Si vous décidez d'utiliser le SDK serveur, vous aurez besoin des informations suivantes :

Ces variables peuvent ensuite être remplacées par des valeurs réelles dans le code d'exemple du SDK serveur.

Créez votre application

Il existe deux méthodes alternatives pour créer une application Messages et Dispatch :

1. Utilisation de la CLI de Vonage
2. Utilisation du tableau de bord

Chacune de ces méthodes est décrite dans les sections suivantes.

Comment créer une application Messages and Dispatch à l'aide de la CLI de Vonage

Pour créer votre application à l'aide de la CLI de Vonage, entrez la commande suivante dans l'interpréteur de commandes :

Cela permet de créer une application Vonage avec des messages capacitéavec les URL des webhooks configurés comme spécifié, et générer un fichier de clé privée my_messages_app.key et crée/met à jour vonage_app.json.

Comment créer une application Messages et Dispatch à l'aide du tableau de bord

Vous pouvez créer des applications Messages et Dispatch dans l'application Tableau de bord.

Pour créer votre application à l'aide du tableau de bord :

1. Sous Applications dans le tableau de bord, cliquez sur le bouton Créer une nouvelle application bouton.

2. Sous Nom, saisissez le nom de l'Applications. Choisissez un nom pour faciliter les références futures.

3. Cliquez sur le bouton Générer une clé publique et une clé privée. Cela créera une paire de clés publique/privée et la clé privée sera téléchargée par votre navigateur.

4. Sous Capacités sélectionner le Messages bouton.

5. Dans le cadre de la URL entrant entrez l'URL de votre webhook de messages entrants, par exemple, https://example.com/webhooks/inbound-message.

6. Dans le cadre de la URL de l'état entrez l'URL de votre webhook sur l'état des messages, par exemple, https://example.com/webhooks/message-status.

7. Cliquez sur le bouton Générer une nouvelle application bouton. Vous passez à l'étape suivante de la procédure de création d'une application, où vous pouvez associer un numéro Vonage à l'application, et lier des comptes externes tels que Facebook à cette application.

8. S'il existe un Account externe auquel vous souhaitez lier cette application, cliquez sur le bouton Comptes externes liés et cliquez sur l'onglet correspondant Lien pour le compte auquel vous voulez vous relier.

Vous avez maintenant créé votre application.

Vous devez configurer au moins deux webhooks :

• Message Status webhook
• Message entrant webhook

Lorsque des mises à jour de l'état des messages sont générées, telles que delivered, rejected ou acceptedles rappels seront reçus sur la page Statut du message URL du webhook.

Lorsqu'un message entrant est reçu, un rappel avec la charge utile du message est invoqué sur le serveur Message entrant URL du webhook.

Pour configurer les URL des webhooks

Dans le cadre de la Tableau de bord, se rendre sur le site Messages et envoi.

Saisissez les URL de vos Webhooks dans les champs intitulés URL de l'état et URL entrant.

Les valeurs que vous saisissez pour les URL de webhook dépendent de l'emplacement de votre serveur de webhook, par exemple :

Webhooks SMS entrants

File d'attente Webhook

Veuillez noter que les webhooks émanant de Vonage, tels que ceux de l'URL du webhook de l'état des messages et de l'URL des messages entrants, sont mis en file d'attente par Vonage sur la base de chaque message.

Veuillez vous assurer que toutes les Applications reconnaissent les webhooks avec une réponse 200.

Crochets web signés

Afin de valider l'origine de vos webhooks, vous pouvez valider la signature des webhooks, voir les instructions. ici

Dans cet extrait de code, vous apprendrez comment gérer un message entrant.

Exemple

Veillez à ce que votre message entrant le webhook est activé dans le tableau de bord. Votre gestionnaire doit au minimum renvoyer un code d'état 200 afin d'éviter toute mise en file d'attente inutile des rappels. Assurez-vous que votre serveur webhook fonctionne avant de tester votre application Messages.

from pprint import pprint

from fastapi import FastAPI, Request, status

app = FastAPI()


@app.post('/webhooks/message-status', status_code=status.HTTP_200_OK)
async def message_status(request: Request):
    data = await request.json()
    pprint(data)


@app.post('/webhooks/inbound-message')
async def inbound_message(request: Request):
    data = await request.json()
    pprint(data)

Si vous souhaitez tester votre application localement, vous pouvez utiliser Ngrok.

Voir nos informations sur Utiliser Ngrok pour le développement local

Si vous utilisez Ngrok de cette manière, vous devez utiliser les URL de Ngrok pour les URL de vos webhooks :

• https://abcdef1.ngrok.io/webhooks/inbound-message
• https://abcdef1.ngrok.io/webhooks/message-status