Notification Messages Operations - Send

Service:

Communication

API-versie:

2024-08-30

Hiermee wordt een meldingsbericht verzonden van Business to User.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	De communicatieresource, bijvoorbeeld https://my-resource.communication.azure.com
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Repeatability-Request-ID		string	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.
Repeatability-First-Sent		string date-time	Hiermee geeft u de datum en tijd op waarop de aanvraag voor het eerst is gemaakt.
x-ms-client-request-id		string uuid	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
AudioNotificationContent	Een aanvraag om een audiomelding te verzenden.
DocumentNotificationContent	Een aanvraag om een documentmelding te verzenden.
ImageNotificationContent	Een aanvraag voor het verzenden van een afbeeldingsmelding.
MediaNotificationContent	@deprecated Een aanvraag voor het verzenden van een afbeeldingsmelding.
TemplateNotificationContent	Een aanvraag voor het verzenden van een sjabloonmelding.
TextNotificationContent	Een verzoek om een sms-melding te verzenden.
VideoNotificationContent	Een aanvraag voor het verzenden van een videomelding.

AudioNotificationContent

Een aanvraag om een audiomelding te verzenden.

Name	Vereist	Type	Description
channelRegistrationId	True	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	True	string: audio	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	True	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	True	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

DocumentNotificationContent

Een aanvraag om een documentmelding te verzenden.

Name	Vereist	Type	Description
channelRegistrationId	True	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	True	string: document	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	True	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	True	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.
caption		string	Optionele tekstinhoud.
fileName		string	Optionele naam voor het bestand.

ImageNotificationContent

Een aanvraag voor het verzenden van een afbeeldingsmelding.

Name	Vereist	Type	Description
channelRegistrationId	True	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	True	string: image	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	True	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	True	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.
caption		string	Optionele tekstinhoud.

MediaNotificationContent

@deprecated Een aanvraag voor het verzenden van een afbeeldingsmelding.

Name	Vereist	Type	Description
channelRegistrationId	True	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	True	string: image_v0	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	True	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	True	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.
content		string	Optionele tekstinhoud.

TemplateNotificationContent

Een aanvraag voor het verzenden van een sjabloonmelding.

Name	Vereist	Type	Description
channelRegistrationId	True	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	True	string: template	Het typediscriminator dat een meldingstype beschrijft.
template	True	MessageTemplate	Het sjabloonobject dat wordt gebruikt om sjablonen te maken.
to	True	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

TextNotificationContent

Een verzoek om een sms-melding te verzenden.

Name	Vereist	Type	Description
channelRegistrationId	True	string	De kanaalregistratie-id voor de bedrijfs-id.
content	True	string	Berichtinhoud.
kind	True	string: text	Het typediscriminator dat een meldingstype beschrijft.
to	True	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

VideoNotificationContent

Een aanvraag voor het verzenden van een videomelding.

Name	Vereist	Type	Description
channelRegistrationId	True	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	True	string: video	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	True	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	True	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.
caption		string	Optionele tekstinhoud.

Antwoorden

Name	Type	Description
202 Accepted	SendMessageResult	De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Repeatability-Result: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

AadOauth2Auth

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Authorization

Type: apiKey
In: header

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Sends a notification message - document

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Sends a notification message - image

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Sends a notification message - Template

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Sends a notification message - text

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Sends a notification message - video

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
AudioNotificationContent	Een aanvraag om een audiomelding te verzenden.
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessageKind	Het type bericht.
DocumentNotificationContent	Een aanvraag om een documentmelding te verzenden.
ImageNotificationContent	Een aanvraag voor het verzenden van een afbeeldingsmelding.
MediaNotificationContent	@deprecated Een aanvraag voor het verzenden van een afbeeldingsmelding.
MessageReceipt	Ontvangst van het verzenden van één bericht.
MessageTemplate	Het sjabloonobject dat wordt gebruikt om sjablonen te maken.
MessageTemplateBindingsKind	Het type berichtsjabloon.
MessageTemplateDocument	De documentwaardegegevens van de berichtsjabloon.
MessageTemplateImage	De waardegegevens van de afbeeldingswaarde van de berichtsjabloon.
MessageTemplateLocation	De locatiewaardegegevens van de berichtsjabloon.
MessageTemplateQuickAction	De informatie over de snelle actiewaarde van de berichtsjabloon.
MessageTemplateText	De tekstwaardegegevens van de berichtsjabloon.
MessageTemplateValueKind	Het type sjabloonparameter.
MessageTemplateVideo	De informatie over de videowaarde van de berichtsjabloon.
SendMessageResult	Resultaat van de verzendberichtbewerking.
TemplateNotificationContent	Een aanvraag voor het verzenden van een sjabloonmelding.
TextNotificationContent	Een verzoek om een sms-melding te verzenden.
VideoNotificationContent	Een aanvraag voor het verzenden van een videomelding.
WhatsAppMessageButtonSubType	Het subtype WhatsApp-knop.
WhatsAppMessageTemplateBindings	De sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateBindingsButton	De componentknop sjabloonbindingen voor WhatsApp
WhatsAppMessageTemplateBindingsComponent	Het component sjabloonbindingen voor WhatsApp

AudioNotificationContent

Een aanvraag om een audiomelding te verzenden.

Name	Type	Description
channelRegistrationId	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	string: audio	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

Azure.Core.Foundations.Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

CommunicationMessageKind

Het type bericht.

Name	Type	Description
audio	string	Type audiobericht.
document	string	Type documentbericht.
image	string	Type afbeeldingsbericht.
image_v0	string	Type afbeeldingsbericht. Verouderd afbeeldingstype voor MediaNotificationContent die wordt afgeschaft
template	string	Type sjabloonbericht.
text	string	Type tekstbericht.
video	string	Type videobericht.

DocumentNotificationContent

Een aanvraag om een documentmelding te verzenden.

Name	Type	Description
caption	string	Optionele tekstinhoud.
channelRegistrationId	string	De kanaalregistratie-id voor de bedrijfs-id.
fileName	string	Optionele naam voor het bestand.
kind	string: document	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

ImageNotificationContent

Een aanvraag voor het verzenden van een afbeeldingsmelding.

Name	Type	Description
caption	string	Optionele tekstinhoud.
channelRegistrationId	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	string: image	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

MediaNotificationContent

@deprecated Een aanvraag voor het verzenden van een afbeeldingsmelding.

Name	Type	Description
channelRegistrationId	string	De kanaalregistratie-id voor de bedrijfs-id.
content	string	Optionele tekstinhoud.
kind	string: image_v0	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

MessageReceipt

Ontvangst van het verzenden van één bericht.

Name	Type	Description
messageId	string	De bericht-id.
to	string	De systeemeigen externe platformgebruikers-id van de ontvanger.

MessageTemplate

Het sjabloonobject dat wordt gebruikt om sjablonen te maken.

Name	Type	Description
bindings	MessageTemplateBindings: WhatsAppMessageTemplateBindings	Het bindingsobject om waarden te koppelen aan de sjabloonspecifieke locaties
language	string	De taal van de sjabloon, in de ISO 639-indeling, bestaat uit een taalcode van twee letters, gevolgd door een optionele landcode van twee letters, bijvoorbeeld 'en' of 'en_US'.
name	string	Naam van de sjabloon.
values	MessageTemplateValue[]: MessageTemplateDocument[] MessageTemplateImage[] MessageTemplateLocation[] MessageTemplateQuickAction[] MessageTemplateText[] MessageTemplateVideo[]	De sjabloonwaarden.

MessageTemplateBindingsKind

Het type berichtsjabloon.

Name	Type	Description
whatsApp	string	Het type WhatsApp-sjabloon.

MessageTemplateDocument

De documentwaardegegevens van de berichtsjabloon.

Name	Type	Description
caption	string	Het bijschrift [optioneel] van het mediaobject.
fileName	string	De bestandsnaam [optioneel] van het mediabestand.
kind	string: document	Het typediscriminator dat een sjabloonparametertype beschrijft.
name	string	Referentienaam voor sjabloonbinding
url	string	De (openbare) URL van de media.

MessageTemplateImage

De waardegegevens van de afbeeldingswaarde van de berichtsjabloon.

Name	Type	Description
caption	string	Het bijschrift [optioneel] van het mediaobject.
fileName	string	De bestandsnaam [optioneel] van het mediabestand.
kind	string: image	Het typediscriminator dat een sjabloonparametertype beschrijft.
name	string	Referentienaam voor sjabloonbinding
url	string	De (openbare) URL van de media.

MessageTemplateLocation

De locatiewaardegegevens van de berichtsjabloon.

Name	Type	Description
address	string	Het [optionele] adres van de locatie.
kind	string: location	Het typediscriminator dat een sjabloonparametertype beschrijft.
latitude	number	De breedtegraad van de locatie.
locationName	string	De [optionele] naam van de locatie.
longitude	number	De lengtegraad van de locatie.
name	string	Referentienaam voor sjabloonbinding

MessageTemplateQuickAction

De informatie over de snelle actiewaarde van de berichtsjabloon.

Name	Type	Description
kind	string: quickAction	Het typediscriminator dat een sjabloonparametertype beschrijft.
name	string	Referentienaam voor sjabloonbinding
payload	string	De nettolading voor snelle actie [Optioneel]
text	string	De tekst voor snelle actie [Optioneel]

MessageTemplateText

De tekstwaardegegevens van de berichtsjabloon.

Name	Type	Description
kind	string: text	Het typediscriminator dat een sjabloonparametertype beschrijft.
name	string	Referentienaam voor sjabloonbinding
text	string	De tekstwaarde.

MessageTemplateValueKind

Het type sjabloonparameter.

Name	Type	Description
document	string	Het parametertype documentsjabloon.
image	string	Het parametertype van de afbeeldingssjabloon.
location	string	Het parametertype voor de locatiesjabloon.
quickAction	string	Het parametertype snelle actiesjabloon.
text	string	Het parametertype voor de tekstsjabloon.
video	string	Het parametertype videosjabloon.

MessageTemplateVideo

De informatie over de videowaarde van de berichtsjabloon.

Name	Type	Description
caption	string	Het bijschrift [optioneel] van het mediaobject.
fileName	string	De bestandsnaam [optioneel] van het mediabestand.
kind	string: video	Het typediscriminator dat een sjabloonparametertype beschrijft.
name	string	Referentienaam voor sjabloonbinding
url	string	De (openbare) URL van de media.

SendMessageResult

Resultaat van de verzendberichtbewerking.

Name	Type	Description
receipts	MessageReceipt[]	Ontvangstbevestigingen van de verzendberichtbewerking.

TemplateNotificationContent

Een aanvraag voor het verzenden van een sjabloonmelding.

Name	Type	Description
channelRegistrationId	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	string: template	Het typediscriminator dat een meldingstype beschrijft.
template	MessageTemplate	Het sjabloonobject dat wordt gebruikt om sjablonen te maken.
to	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

TextNotificationContent

Een verzoek om een sms-melding te verzenden.

Name	Type	Description
channelRegistrationId	string	De kanaalregistratie-id voor de bedrijfs-id.
content	string	Berichtinhoud.
kind	string: text	Het typediscriminator dat een meldingstype beschrijft.
to	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

VideoNotificationContent

Een aanvraag voor het verzenden van een videomelding.

Name	Type	Description
caption	string	Optionele tekstinhoud.
channelRegistrationId	string	De kanaalregistratie-id voor de bedrijfs-id.
kind	string: video	Het typediscriminator dat een meldingstype beschrijft.
mediaUri	string	Een media-URL voor het bestand. Vereist als het type een van de ondersteunde mediatypen is, bijvoorbeeld afbeelding
to	string[]	De systeemeigen externe platformgebruikers-id's van de ontvanger.

WhatsAppMessageButtonSubType

Het subtype WhatsApp-knop.

Name	Type	Description
quickReply	string	Het subtype WhatsApp-knop is snel beantwoorden.
url	string	Het subtype WhatsApp-knop is url.

WhatsAppMessageTemplateBindings

De sjabloonbindingen voor WhatsApp

Name	Type	Description
body	WhatsAppMessageTemplateBindingsComponent[]	De hoofdtekstsjabloonbindingen
buttons	WhatsAppMessageTemplateBindingsButton[]	De knopsjabloonbindingen
footer	WhatsAppMessageTemplateBindingsComponent[]	De voettekstsjabloonbindingen
header	WhatsAppMessageTemplateBindingsComponent[]	De headersjabloonbindingen
kind	string: whatsApp	Het typediscriminator dat een sjabloonbindingstype beschrijft.

WhatsAppMessageTemplateBindingsButton

De componentknop sjabloonbindingen voor WhatsApp

Name	Type	Description
refValue	string	De naam van het item waarnaar wordt verwezen in de sjabloonwaarden.
subType	WhatsAppMessageButtonSubType	Het subtype WhatsApp-knop

WhatsAppMessageTemplateBindingsComponent

Het component sjabloonbindingen voor WhatsApp

Name	Type	Description
refValue	string	De naam van het item waarnaar wordt verwezen in de sjabloonwaarden.