Détails techniques

Une application API de Vonage contient les informations de sécurité et de configuration dont vous avez besoin pour vous connecter aux points d'extrémité de Vonage et utiliser les API de Vonage.

Chaque application Vonage créée peut prendre en charge plusieurs capacités - par exemple, vous pouvez créer une application qui prend en charge l'utilisation des API Voice, Messages et RTC.

Pour illustrer l'utilisation des applications Vonage, voici un bref résumé de la création et de l'utilisation d'une application vocale Vonage :

1. Créez une application Vonage à l'aide du CLI, du tableau de bord ou de l'API d'application.
2. Veillez à configurer les URL de votre webhook. Vonage rappellera sur ces URL avec des informations importantes.
3. Associez un numéro Vonage à votre application Vonage.
4. Rédigez votre application Web. Mettez en œuvre les points de terminaison du webhook que vous avez configurés à l'étape 2, en utilisant les API de Vonage si nécessaire.

Par exemple, si vous souhaitez créer une application qui transférer les appels entrants vers un téléphone de destination, vous devez suivre les étapes suivantes :

1. Vous créez une application Vonage dotée de capacités vocales.
2. Vous configurez les URL des webhooks de réponse et d'événement.
3. Vous associez un numéro Vonage à votre application Vonage.
4. Vous mettez en œuvre une application web qui répond aux rappels sur les URL des webhooks.
5. Lorsqu'un appel entrant est effectué au numéro Vonage associé à l'application Vonage, un BCN est renvoyée sur la page answer_url.

D'autres types d'applications, telles que celles dotées de fonctions de messagerie et de répartition, suivent un processus légèrement différent, qui est décrit dans les sections correspondantes du présent document. la documentation.

Les sections suivantes expliquent les applications Vonage plus en détail.

Structure

Chaque application présente les caractéristiques suivantes :

Capacités

Une application Vonage peut utiliser diverses API, notamment Voice, Messages et Dispatch, Conversation et Client SDK.

Lors de la création d'une application, vous pouvez spécifier les capacités que vous souhaitez que votre application prenne en charge. Pour chaque capacité, vous pouvez définir des webhooks en fonction des capacités que vous souhaitez, par exemple pour une application avec une fonction rtc vous pouvez spécifier une URL d'événement pour recevoir les événements RTC. Si votre application a également besoin d'utiliser la fonction voice vous pourriez également définir une URL de réponse pour recevoir un appel répondu par webhook, une URL de repli au cas où votre URL de réponse échouerait, et une autre URL d'événement pour recevoir les événements liés aux appels vocaux.

Un résumé des capacités est donné dans le tableau suivant :

Crochets Web

Les URL des webhooks que vous fournissez lors de la création d'une application dépendent des capacités requises pour l'application. Le tableau suivant résume les webhooks :

Types de webhook

Le tableau suivant décrit les webhooks disponibles par capacité :

Délais d'attente pour les webhooks

Pour les voice vous pouvez définir des délais d'attente pour les webhooks. Deux délais peuvent être spécifiés : connection_timeout et socket_timeout. Ces paramètres s'appliquent aux answer, eventet fallback et sont exprimées en millisecondes. Le tableau suivant fournit des informations complémentaires :

Lors de la création ou de la mise à jour d'une application, ces éléments peuvent être définis directement ou mis à jour en fonction des besoins, par exemple :

...
  "capabilities": {
    "voice": {
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        }
      }
    }
...

Si ces valeurs ne sont pas spécifiées lors de la création ou de la mise à jour de l'application, alors les valeurs par défaut sont appliquées. Les valeurs par défaut de ces délais dépendent du webhook concerné, comme le montre le tableau suivant :

Pour plus d'informations sur les délais d'attente des webhooks, voir la section documentation sur les webhooks.

Création d'applications

Il existe quatre façons principales de créer une application :

1. Dans le cadre du projet Vonage Tableau de bord. Les applications sont ensuite répertoriées dans la rubrique vos applications du tableau de bord.
2. L'utilisation de la CLI Vonage.
3. L'utilisation de la Application API.
4. En utilisant l'un des systèmes Vonage SDK de serveur.

Gérer les applications à l'aide du CLI

• Gestion des applications à l'aide de la CLI de Vonage

Extraits de code

• Application / Créer une application
• Application / Liste des Applications
• Application / Mise à jour de l'application
• Application / Obtenir une Applications
• Application / Supprimer une application
• User / Créer un utilisateur
• User / Liste des utilisateurs
• User / Mise à jour d'un utilisateur
• User / Obtenir un utilisateur
• User / Supprimer un utilisateur

Référence

• Application API