Qualité à la demande API Webhooks

Crochets Web font partie intégrante de l'API QoD de Vonage. Vonage enverra à votre application des mises à jour concernant la session QoD sans que votre application n'ait à poser de questions. Ce type de webhook est également appelé "callback".

Réception de webhooks

Pour permettre aux serveurs Vonage d'envoyer des données à votre application via des webhooks, vous devez configurer une application dans le répertoire Tableau de bord des clients de Vonage avec l'URL de votre serveur web vers lequel vous souhaitez que les données soient envoyées.

Rappels

Lorsque vous envoyez une requête à l'API QoD, vous recevez une réponse qui ressemble à celle-ci :

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

La réception de cette réponse ne signifie pas que la session QoD a été créée. Si le statut est PENDING, cela signifie que la demande a été acceptée par les serveurs de Vonage. Les rappels sont utilisés pour fournir des mises à jour sur l'état d'une session QoD. Vous pouvez également recevoir une réponse d'erreur, par exemple si la demande ne respecte pas les spécifications de l'API ou si l'authentification n'est pas valide.

La création (ou l'échec) de la session QoD sera signalée dans un rappel utilisant la fonction status domaine :

  • PENDING: La session QoD n'a pas encore été traitée par le réseau sous-jacent.
  • ACTIVE: La session QoD a été créée et le profil QoD sélectionné est appliqué au flux réseau.
  • COMPLETED: La session QoD s'est achevée avec succès.
  • CANCELLING: La session de CdQ est en cours d'annulation, mais n'a pas encore atteint l'état terminal.
  • FAILED: La session de CdQ s'est achevée mais en raison d'un échec ; plus de détails peuvent être trouvés dans la section reason domaine.

Un exemple de rappel est donné ci-dessous :

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

Lorsque la session est acceptée par le réseau :

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

Lorsque la durée de la session se termine :

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

Lorsqu'une session s'est achevée, mais qu'en raison d'un échec (voir la rubrique reason pour plus d'informations) :

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

Pour en savoir plus