Azure Communication Services - Événements de messagerie avancée

Article
03/06/2024

Cet article décrit les propriétés et le schéma des événements de messagerie avancée Communication Services. Pour une présentation des schémas d’événements, consultez Schéma d’événements Azure Event Grid.

Types d’événement

Azure Communication Services émet les types d’événements de messagerie avancée suivants :

Type d'événement	Description
Microsoft.Communication.AdvancedMessageReceived	Publié lorsque Communication Services reçoit un message WhatsApp.
Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated	Publié lorsque WhatsApp envoie l’état de la notification de message comme étant envoyé/lu/en échec.

Réponses aux événements

Quand un événement est déclenché, le service Event Grid envoie les données relatives à cet événement aux points de terminaison d’abonnement.

Cette section contient un exemple de ce à quoi ces données ressembleraient pour chaque événement.

Événement Microsoft.Communication.AdvancedMessageReceived

[{
  "id": "fdc64eca-390d-4974-abd6-1a13ccbe3160",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/acsxplatmsg-test",
  "subject": "advancedMessage/sender/{sender@id}/recipient/00000000-0000-0000-0000-000000000000",
  "data": {
    "content": "Hello",
    "channelType": "whatsapp",
    "from": "{sender@id}",
    "to": "00000000-0000-0000-0000-000000000000",
    "receivedTimestamp": "2023-07-06T18:30:19+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:30:22.1921716Z"
}]

Événement Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated

[{
  "id": "48cd6446-01dd-479f-939c-171c86c46700",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/acsxplatmsg-test",
  "subject": "advancedMessage/00000000-0000-0000-0000-000000000000/status/Failed",
  "data": {
    "messageId": "00000000-0000-0000-0000-000000000000",
    "status": "Sent",
    "channelType": "whatsapp",
    "from": "{sender@id}",
    "to": "{receiver@id}",
    "receivedTimestamp": "2023-07-06T18:42:28+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:42:28.8454662Z"
}]

[{
  "id": "48cd6446-01dd-479f-939c-171c86c46700",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/acsxplatmsg-test",
  "subject": "advancedMessage/00000000-0000-0000-0000-000000000000/status/Failed",
  "data": {
    "messageId": "00000000-0000-0000-0000-000000000000",
    "status": "Failed",
    "channelType": "whatsapp",
    "from": "{sender@id}",
    "to": "{receiver@id}",
    "receivedTimestamp": "2023-07-06T18:42:28+00:00",
    "error": {
      "channelCode": "131026",
      "channelMessage": "Message Undeliverable."
    }
  },
  "eventType": "Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:42:28.8454662Z"
}]

Remarque

Les valeurs possibles pour Status sont Sent, Delivered, Read et Failed.

Démarrage rapide

Pour obtenir un guide de démarrage rapide qui montre comment s’abonner aux événements de messagerie avancée à l’aide de webhooks, consultez Démarrage rapide : Gérer les événements de messagerie avancée.

Partager via