Qualität auf Abruf API Webhooks

Webhaken sind ein integraler Bestandteil der Vonage QoD API. Vonage sendet Ihrer Anwendung Updates über die QoD-Sitzung, ohne dass Ihre Anwendung eine Anfrage stellen muss. Diese Art von Webhook wird auch als "Callback" bezeichnet.

Empfangen von Webhooks

Damit die Vonage-Server Daten über Webhooks an Ihre Anwendung senden können, müssen Sie eine Anwendung in der Vonage Kunden-Dashboard mit der URL Ihres Webservers, an den die Daten gesendet werden sollen.

Rückrufe

Wenn Sie eine Anfrage an die QoD-API senden, erhalten Sie eine Antwort, die wie folgt aussieht:

{
   "channels" : [
  	{
     	"destination" : {
        	"cidr" : "127.0.0.1/64",
        	"port" : 1
     	},
     	"qod_profile" : "LOW_LATENCY",
     	"source" : {
        	"port" : 1
     	},
     	"statuses" : [
        	{
           	"reason" : "Requested via API",
           	"status" : "PENDING",
           	"updated" : "2024-11-26T09:59:14.299364304"
        	}
     	]
  	}
   ],
   "duration" : 120,
   "id" : "b1c33ed6-5f0d-40db-85f7-91e32594d45c",
   "msisdn" : "99021223344",
   "source_ip" : "127.0.1.1"
}

Der Erhalt dieser Antwort bedeutet nicht, dass die QoD-Sitzung erstellt wurde. Wenn der Statuswert PENDING lautet, bedeutet dies, dass die Anfrage von den Vonage-Servern angenommen wurde. Rückrufe werden verwendet, um Aktualisierungen des Status einer QoD-Sitzung zu liefern. Sie können auch eine Fehlerantwort erhalten, z.B. wenn die Anfrage nicht der API-Spezifikation entspricht oder wenn die Authentifizierung ungültig ist.

Die Erstellung (oder das Scheitern) einer QoD-Sitzung wird in einem Callback mit der status Feld:

  • PENDING: Die QoD-Sitzung wurde vom zugrundeliegenden Netz noch nicht verarbeitet.
  • ACTIVE: Die QoD-Sitzung wurde erstellt, und das ausgewählte QoD-Profil wird auf den Netzwerkfluss angewendet.
  • COMPLETED: Die QoD-Sitzung wurde erfolgreich abgeschlossen.
  • CANCELLING: Die QoD-Sitzung wird gerade abgebrochen, hat aber noch nicht den Endzustand erreicht.
  • FAILED: Die QoD-Sitzung wurde beendet, aber aufgrund eines Fehlers; weitere Einzelheiten finden Sie in der reason Feld.

Nachstehend finden Sie ein Beispiel für einen Rückruf:

{
   "id" : "9921de97-dc3d-4fe9-a13a-748468c3aedd",
   "projected_end_time" : "2024-10-30T08:42:24",
   "update" : {
  	"status" : "PENDING",
  	"updated" : "2024-10-30T08:39:03.730508321"
   }
}

Wenn die Sitzung vom Netz akzeptiert wird:

{
   "id" : "9921de97-dc3d-4fe9-a13a-748468c3aedd",
   "projected_end_time" : "2024-10-30T08:42:24",
   "update" : {
  	"status" : "ACTIVE",
  	"updated" : "2024-10-30T08:39:04.206222636"
   }
}

Wenn die Sitzungsdauer abgelaufen ist:

{
   "id" : "9921de97-dc3d-4fe9-a13a-748468c3aedd",
   "update" : {
  	"status" : "COMPLETED",
  	"updated" : "2024-10-30T08:42:24.996248114"
   }
}

Wenn eine Sitzung abgeschlossen wurde, aber aufgrund eines Fehlers (siehe die reason Feld für weitere Informationen):

{
   "id" : "b2cadfa8-29d7-4290-a1d3-9e3ea8c38a02",
   "update" : {
      "reason" : "Invalid QoD profile",
      "status" : "FAILED",
      "updated" : "2025-01-28T08:29:15.157706777"
   }
}

Weitere Lektüre