Technische Details

Eine Vonage API-Anwendung enthält die Sicherheits- und Konfigurationsinformationen, die Sie benötigen, um sich mit Vonage Endpunkten zu verbinden und die Vonage APIs zu nutzen.

Jede von Vonage erstellte Anwendung kann mehrere Funktionen unterstützen - so können Sie beispielsweise eine Anwendung erstellen, die die Nutzung der Voice-, Messages- und RTC-APIs unterstützt.

Zur Veranschaulichung der Verwendung von Vonage Applications wird hier eine kurze Zusammenfassung zur Erstellung und Verwendung einer Vonage Sprachanwendung gegeben:

1. Erstellen Sie eine Vonage-Applikation über die CLI, das Dashboard oder die Application API.
2. Stellen Sie sicher, dass Sie Ihre Webhook-URLs konfigurieren. Vonage wird Sie unter diesen URLs mit wichtigen Informationen zurückrufen.
3. Verknüpfen Sie eine Vonage-Nummer mit Ihrer Vonage-Anwendung.
4. Schreiben Sie Ihre Webanwendung. Implementieren Sie die Webhook-Endpunkte, die Sie in Schritt 2 konfiguriert haben, und verwenden Sie die Vonage-APIs wie erforderlich.

Wenn Sie zum Beispiel eine Anwendung erstellen möchten, die leitet eingehende Anrufe weiter auf ein Zieltelefon zu übertragen, führen Sie die folgenden Schritte aus:

1. Sie erstellen eine Vonage-Anwendung, die über Sprachfunktionen verfügt.
2. Sie konfigurieren die Antwort- und Ereignis-Webhook-URLs.
3. Sie verknüpfen eine Vonage-Nummer mit Ihrer Vonage-Anwendung.
4. Sie implementieren eine Webanwendung, die auf Rückrufe über die Webhook-URLs reagiert.
5. Wenn ein eingehender Anruf an die der Vonage-Anwendung zugeordnete Vonage-Nummer getätigt wird, wird ein NCCO wird auf der Seite answer_url.

Andere Arten von Applikationen, wie z. B. solche mit Nachrichten- und Versandfunktionen, haben einen etwas anderen Prozess, der in den entsprechenden Abschnitten dieses Dokuments beschrieben wird. Dokumentation.

In den folgenden Abschnitten werden die Applications von Vonage näher erläutert.

Struktur

Jede Anwendung hat die folgenden Merkmale:

Fähigkeiten

Eine Vonage-Anwendung kann verschiedene APIs nutzen, darunter Voice, Messages und Dispatch, Conversation und Client SDK.

Bei der Erstellung einer Anwendung können Sie angeben, welche Funktionen Ihre Anwendung unterstützen soll. Für jede Fähigkeit können Sie Webhooks festlegen, je nachdem, welche Fähigkeiten Sie wünschen, z. B. für eine Anwendung mit einer rtc Fähigkeit können Sie eine Ereignis-URL angeben, um RTC-Ereignisse zu empfangen. Wenn Ihre Anwendung auch die voice können Sie auch eine Antwort-URL für den Empfang eines beantworteten Anrufs, eine Fallback-URL für den Fall, dass Ihre Antwort-URL ausfällt, und eine weitere Ereignis-URL für den Empfang von Ereignissen im Zusammenhang mit Sprachanrufen festlegen.

Eine Zusammenfassung der Fähigkeiten ist in der folgenden Tabelle enthalten:

Webhaken

Die Webhook-URLs, die Sie beim Erstellen einer Anwendung angeben, hängen von den erforderlichen Anwendungsfunktionen ab. In der folgenden Tabelle sind die Webhooks zusammengefasst:

Webhook-Typen

Die folgende Tabelle beschreibt die verfügbaren Webhooks pro Fähigkeit:

Webhook-Zeitüberschreitungen

Für die voice können Sie Zeitüberschreitungen für Webhooks festlegen. Es gibt zwei Zeitüberschreitungen, die festgelegt werden können: connection_timeout und socket_timeout. Diese Parameter gelten für die answer, eventund fallback Webhooks, und werden in Millisekunden angegeben. Die folgende Tabelle enthält weitere Informationen:

Bei der Erstellung oder Aktualisierung einer Applikation können diese direkt eingestellt oder nach Bedarf aktualisiert werden, zum Beispiel:

...
  "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
        }
      }
    }
...

Wenn diese Werte beim Erstellen oder Aktualisieren der Anwendung nicht angegeben werden, werden Standardwerte verwendet. Die Standardwerte für diese Timeouts hängen von dem jeweiligen Webhook ab, wie in der folgenden Tabelle dargestellt:

Weitere Erläuterungen zu Webhook-Zeitüberschreitungen finden Sie in der Webhook-Dokumentation.

Erstellen von Applications

Es gibt im Wesentlichen vier Möglichkeiten, eine Anwendung zu erstellen:

1. In der Vonage Dashboard. Die Applications werden dann in der Liste Ihre Applikationen Abschnitt des Dashboards.
2. Die Verwendung des Vonage CLI.
3. Die Verwendung des Application API.
4. Mit einem der Vonage Server-SDKs.

Verwaltung von Applications mit der CLI

• Verwalten von Applikationen mit der Vonage CLI

Code-Schnipsel

• Application / Anwendung aktualisieren
• Application / Bewerbung anfordern
• Application / Erstellen einer Applikation
• Application / Liste Applications
• Application / Löschen einer Applikation
• User / Benutzer aktualisieren
• User / Benutzer auflisten
• User / Benutzer erhalten
• User / Einen Benutzer erstellen
• User / Einen Benutzer löschen

Referenz

• Application API