Notification Messages Operations - Send

Référence

Service:: Communication

Version d'API:: 2024-08-30

Envoie un message de notification de l’entreprise à l’utilisateur.

POST {endpoint}/messages/notifications:send?api-version=2024-08-30

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string uri	Ressource de communication, par exemple https://my-resource.communication.azure.com
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Type	Description
Repeatability-Request-ID	string	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.
Repeatability-First-Sent	string date-time	Spécifie la date et l’heure à laquelle la demande a été créée pour la première fois.
x-ms-client-request-id	string uuid	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
AudioNotificationContent	Demande d’envoi d’une notification audio.
DocumentNotificationContent	Demande d’envoi d’une notification de document.
ImageNotificationContent	Demande d’envoi d’une notification d’image.
MediaNotificationContent	@deprecated Demande d’envoi d’une notification d’image.
TemplateNotificationContent	Demande d’envoi d’une notification de modèle.
TextNotificationContent	Demande d’envoi d’une notification texte.
VideoNotificationContent	Demande d’envoi d’une notification vidéo.

AudioNotificationContent

Demande d’envoi d’une notification audio.

Nom	Obligatoire	Type	Description
channelRegistrationId	True	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	True	string: audio	Discriminateur de type décrivant un type de notification.
mediaUri	True	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	True	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

DocumentNotificationContent

Demande d’envoi d’une notification de document.

Nom	Obligatoire	Type	Description
channelRegistrationId	True	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	True	string: document	Discriminateur de type décrivant un type de notification.
mediaUri	True	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	True	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.
caption		string	Contenu texte facultatif.
fileName		string	Nom facultatif du fichier.

ImageNotificationContent

Demande d’envoi d’une notification d’image.

Nom	Obligatoire	Type	Description
channelRegistrationId	True	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	True	string: image	Discriminateur de type décrivant un type de notification.
mediaUri	True	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	True	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.
caption		string	Contenu texte facultatif.

MediaNotificationContent

@deprecated Demande d’envoi d’une notification d’image.

Nom	Obligatoire	Type	Description
channelRegistrationId	True	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	True	string: image_v0	Discriminateur de type décrivant un type de notification.
mediaUri	True	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	True	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.
content		string	Contenu texte facultatif.

TemplateNotificationContent

Demande d’envoi d’une notification de modèle.

Nom	Obligatoire	Type	Description
channelRegistrationId	True	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	True	string: template	Discriminateur de type décrivant un type de notification.
template	True	MessageTemplate	Objet de modèle utilisé pour créer des modèles.
to	True	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

TextNotificationContent

Demande d’envoi d’une notification texte.

Nom	Obligatoire	Type	Description
channelRegistrationId	True	string	ID d’inscription de canal pour l’identificateur d’entreprise.
content	True	string	Contenu du message.
kind	True	string: text	Discriminateur de type décrivant un type de notification.
to	True	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

VideoNotificationContent

Demande d’envoi d’une notification vidéo.

Nom	Obligatoire	Type	Description
channelRegistrationId	True	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	True	string: video	Discriminateur de type décrivant un type de notification.
mediaUri	True	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	True	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.
caption		string	Contenu texte facultatif.

Réponses

Nom	Type	Description
202 Accepted	SendMessageResult	La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé. En-têtes Repeatability-Result: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

202 Accepted

SendMessageResult

La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé.

En-têtes

Repeatability-Result: string
x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

AadOauth2Auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom	Description
https://communication.azure.com/.default

Authorization

Type: apiKey
Dans: header

Exemples

Sends a notification message - audio

Sends a notification message - document

Sends a notification message - image

Sends a notification message - Template

Sends a notification message - text

Sends a notification message - video

Sends a notification message - audio

Exemple de requête

HTTP

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "audio",
  "mediaUri": "https://example.com/audio.mp3"
}

Exemple de réponse

Code d’état:: 202

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - document

Exemple de requête

HTTP

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "document",
  "mediaUri": "https://example.com/document.pdf",
  "caption": "check out this document!",
  "fileName": "fileName.pdf"
}

Exemple de réponse

Code d’état:: 202

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - image

Exemple de requête

HTTP

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "image",
  "mediaUri": "https://example.com/image.jpg",
  "caption": "check out this image!"
}

Exemple de réponse

Code d’état:: 202

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - Template

Exemple de requête

HTTP

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "template",
  "template": {
    "name": "example",
    "language": "en",
    "values": [
      {
        "name": "userName",
        "kind": "text",
        "text": "John Doe"
      },
      {
        "name": "orderNumber",
        "kind": "text",
        "text": "12345"
      }
    ],
    "bindings": {
      "body": [
        {
          "refValue": "userName"
        },
        {
          "refValue": "orderNumber"
        }
      ],
      "kind": "whatsApp"
    }
  }
}

Exemple de réponse

Code d’état:: 202

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - text

Exemple de requête

HTTP

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "text",
  "content": "Text message through CPM"
}

Exemple de réponse

Code d’état:: 202

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - video

Exemple de requête

HTTP

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "video",
  "mediaUri": "https://example.com/video.mp4",
  "caption": "check out this video!"
}

Exemple de réponse

Code d’état:: 202

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Définitions

Nom	Description
AudioNotificationContent	Demande d’envoi d’une notification audio.
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessageKind	Type de message.
DocumentNotificationContent	Demande d’envoi d’une notification de document.
ImageNotificationContent	Demande d’envoi d’une notification d’image.
MediaNotificationContent	@deprecated Demande d’envoi d’une notification d’image.
MessageReceipt	Réception de l’envoi d’un message.
MessageTemplate	Objet de modèle utilisé pour créer des modèles.
MessageTemplateBindingsKind	Type du modèle de message.
MessageTemplateDocument	Informations sur la valeur du document du modèle de message.
MessageTemplateImage	Informations sur la valeur de l’image du modèle de message.
MessageTemplateLocation	Informations sur la valeur d’emplacement du modèle de message.
MessageTemplateQuickAction	Informations sur la valeur d’action rapide du modèle de message.
MessageTemplateText	Informations sur la valeur de texte du modèle de message.
MessageTemplateValueKind	Type du paramètre de modèle.
MessageTemplateVideo	Informations sur la valeur vidéo du modèle de message.
SendMessageResult	Résultat de l’opération d’envoi de message.
TemplateNotificationContent	Demande d’envoi d’une notification de modèle.
TextNotificationContent	Demande d’envoi d’une notification texte.
VideoNotificationContent	Demande d’envoi d’une notification vidéo.
WhatsAppMessageButtonSubType	Sous-type de bouton WhatsApp.
WhatsAppMessageTemplateBindings	Liaisons de modèle pour WhatsApp
WhatsAppMessageTemplateBindingsButton	Bouton du composant liaisons de modèle pour WhatsApp
WhatsAppMessageTemplateBindingsComponent	Composant liaisons de modèle pour WhatsApp

AudioNotificationContent

Demande d’envoi d’une notification audio.

Nom	Type	Description
channelRegistrationId	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	string: audio	Discriminateur de type décrivant un type de notification.
mediaUri	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

Azure.Core.Foundations.Error

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

CommunicationMessageKind

Type de message.

Nom	Type	Description
audio	string	Type de message audio.
document	string	Type de message de document.
image	string	Type de message image.
image_v0	string	Type de message image. Type d’image hérité pour `MediaNotificationContent` qui est déconseillé
template	string	Type de message de modèle.
text	string	Type de message texte.
video	string	Type de message vidéo.

DocumentNotificationContent

Demande d’envoi d’une notification de document.

Nom	Type	Description
caption	string	Contenu texte facultatif.
channelRegistrationId	string	ID d’inscription de canal pour l’identificateur d’entreprise.
fileName	string	Nom facultatif du fichier.
kind	string: document	Discriminateur de type décrivant un type de notification.
mediaUri	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

ImageNotificationContent

Demande d’envoi d’une notification d’image.

Nom	Type	Description
caption	string	Contenu texte facultatif.
channelRegistrationId	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	string: image	Discriminateur de type décrivant un type de notification.
mediaUri	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

MediaNotificationContent

@deprecated Demande d’envoi d’une notification d’image.

Nom	Type	Description
channelRegistrationId	string	ID d’inscription de canal pour l’identificateur d’entreprise.
content	string	Contenu texte facultatif.
kind	string: image_v0	Discriminateur de type décrivant un type de notification.
mediaUri	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

MessageReceipt

Réception de l’envoi d’un message.

Nom	Type	Description
messageId	string	ID du message.
to	string	Identificateur d’utilisateur de la plateforme externe native du destinataire.

MessageTemplate

Objet de modèle utilisé pour créer des modèles.

Nom	Type	Description
bindings	MessageTemplateBindings: WhatsAppMessageTemplateBindings	Objet de liaison pour lier des valeurs à des emplacements spécifiques au modèle
language	string	La langue du modèle, au format ISO 639, se compose d’un code de langue à deux lettres suivi d’un code de pays à deux lettres facultatif, par exemple « en » ou « en_US ».
name	string	Nom du modèle.
values	MessageTemplateValue[]: MessageTemplateDocument[] MessageTemplateImage[] MessageTemplateLocation[] MessageTemplateQuickAction[] MessageTemplateText[] MessageTemplateVideo[]	Valeurs du modèle.

MessageTemplateBindingsKind

Type du modèle de message.

Nom	Type	Description
whatsApp	string	Type de modèle WhatsApp.

MessageTemplateDocument

Informations sur la valeur du document du modèle de message.

Nom	Type	Description
caption	string	Légende [facultatif] de l’objet multimédia.
fileName	string	Nom de fichier [facultatif] du fichier multimédia.
kind	string: document	Discriminateur de type décrivant un type de paramètre de modèle.
name	string	Nom de référence de liaison de modèle
url	string	URL (publique) du média.

MessageTemplateImage

Informations sur la valeur de l’image du modèle de message.

Nom	Type	Description
caption	string	Légende [facultatif] de l’objet multimédia.
fileName	string	Nom de fichier [facultatif] du fichier multimédia.
kind	string: image	Discriminateur de type décrivant un type de paramètre de modèle.
name	string	Nom de référence de liaison de modèle
url	string	URL (publique) du média.

MessageTemplateLocation

Informations sur la valeur d’emplacement du modèle de message.

Nom	Type	Description
address	string	Adresse [Facultative] de l’emplacement.
kind	string: location	Discriminateur de type décrivant un type de paramètre de modèle.
latitude	number	Latitude de l’emplacement.
locationName	string	Nom [Facultatif] de l’emplacement.
longitude	number	Longitude de l’emplacement.
name	string	Nom de référence de liaison de modèle

MessageTemplateQuickAction

Informations sur la valeur d’action rapide du modèle de message.

Nom	Type	Description
kind	string: quickAction	Discriminateur de type décrivant un type de paramètre de modèle.
name	string	Nom de référence de liaison de modèle
payload	string	Charge utile d’action rapide [Facultatif]
text	string	Texte d’action rapide [Facultatif]

MessageTemplateText

Informations sur la valeur de texte du modèle de message.

Nom	Type	Description
kind	string: text	Discriminateur de type décrivant un type de paramètre de modèle.
name	string	Nom de référence de liaison de modèle
text	string	Valeur du texte.

MessageTemplateValueKind

Type du paramètre de modèle.

Nom	Type	Description
document	string	Type de paramètre de modèle de document.
image	string	Type de paramètre de modèle d’image.
location	string	Type de paramètre de modèle d’emplacement.
quickAction	string	Type de paramètre de modèle d’action rapide.
text	string	Type de paramètre de modèle de texte.
video	string	Type de paramètre de modèle vidéo.

MessageTemplateVideo

Informations sur la valeur vidéo du modèle de message.

Nom	Type	Description
caption	string	Légende [facultatif] de l’objet multimédia.
fileName	string	Nom de fichier [facultatif] du fichier multimédia.
kind	string: video	Discriminateur de type décrivant un type de paramètre de modèle.
name	string	Nom de référence de liaison de modèle
url	string	URL (publique) du média.

SendMessageResult

Résultat de l’opération d’envoi de message.

Nom	Type	Description
receipts	MessageReceipt[]	Reçus de l’opération d’envoi de message.

TemplateNotificationContent

Demande d’envoi d’une notification de modèle.

Nom	Type	Description
channelRegistrationId	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	string: template	Discriminateur de type décrivant un type de notification.
template	MessageTemplate	Objet de modèle utilisé pour créer des modèles.
to	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

TextNotificationContent

Demande d’envoi d’une notification texte.

Nom	Type	Description
channelRegistrationId	string	ID d’inscription de canal pour l’identificateur d’entreprise.
content	string	Contenu du message.
kind	string: text	Discriminateur de type décrivant un type de notification.
to	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

VideoNotificationContent

Demande d’envoi d’une notification vidéo.

Nom	Type	Description
caption	string	Contenu texte facultatif.
channelRegistrationId	string	ID d’inscription de canal pour l’identificateur d’entreprise.
kind	string: video	Discriminateur de type décrivant un type de notification.
mediaUri	string	URL du média pour le fichier. Obligatoire si le type est l’un des types multimédias pris en charge, par exemple image
to	string[]	Identificateurs utilisateur de la plateforme externe native du destinataire.

WhatsAppMessageButtonSubType

Sous-type de bouton WhatsApp.

Nom	Type	Description
quickReply	string	Le sous-type de bouton WhatsApp est une réponse rapide.
url	string	Le sous-type de bouton WhatsApp est url.

WhatsAppMessageTemplateBindings

Liaisons de modèle pour WhatsApp

Nom	Type	Description
body	WhatsAppMessageTemplateBindingsComponent[]	Liaisons de modèle de corps
buttons	WhatsAppMessageTemplateBindingsButton[]	Liaisons de modèle de bouton
footer	WhatsAppMessageTemplateBindingsComponent[]	Liaisons de modèle de pied de page
header	WhatsAppMessageTemplateBindingsComponent[]	Liaisons de modèle d’en-tête
kind	string: whatsApp	Discriminateur de type décrivant un type de liaisons de modèle.

WhatsAppMessageTemplateBindingsButton

Bouton du composant liaisons de modèle pour WhatsApp

Nom	Type	Description
refValue	string	Nom de l’élément référencé dans les valeurs du modèle.
subType	WhatsAppMessageButtonSubType	Sous-type de bouton WhatsApp

WhatsAppMessageTemplateBindingsComponent

Composant liaisons de modèle pour WhatsApp

Nom	Type	Description
refValue	string	Nom de l’élément référencé dans les valeurs du modèle.

Partager via

Notification Messages Operations - Send

Paramètres URI

En-tête de la demande

Corps de la demande

AudioNotificationContent

DocumentNotificationContent

ImageNotificationContent

MediaNotificationContent

TemplateNotificationContent

TextNotificationContent

VideoNotificationContent

Réponses

Sécurité

AadOauth2Auth

Étendues

Authorization

Exemples

Sends a notification message - audio

Exemple de requête

Exemple de réponse

Sends a notification message - document

Exemple de requête

Exemple de réponse

Sends a notification message - image

Exemple de requête

Exemple de réponse

Sends a notification message - Template

Exemple de requête

Exemple de réponse

Sends a notification message - text

Exemple de requête

Exemple de réponse

Sends a notification message - video

Exemple de requête

Exemple de réponse

Définitions

AudioNotificationContent

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CommunicationMessageKind

DocumentNotificationContent

ImageNotificationContent

MediaNotificationContent

MessageReceipt

MessageTemplate

MessageTemplateBindingsKind

MessageTemplateDocument

MessageTemplateImage

MessageTemplateLocation

MessageTemplateQuickAction

MessageTemplateText

MessageTemplateValueKind

MessageTemplateVideo

SendMessageResult

TemplateNotificationContent

TextNotificationContent

VideoNotificationContent

WhatsAppMessageButtonSubType

WhatsAppMessageTemplateBindings

WhatsAppMessageTemplateBindingsButton

WhatsAppMessageTemplateBindingsComponent

Ressources supplémentaires