Freigeben über

Notification Messages Operations - Send

  • Referenz
Dienst:
Communication
API-Version:
2024-08-30

Sendet eine Benachrichtigung von Business an Benutzer.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string

uri

Die Kommunikationsressource, z. B. https://my-resource.communication.azure.com
api-version
 query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Repeatability-Request-ID

string

Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.
Repeatability-First-Sent

string

date-time

Gibt das Datum und die Uhrzeit an, zu dem die Anforderung zuerst erstellt wurde.
x-ms-client-request-id

string

uuid

Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name Beschreibung
AudioNotificationContent

Eine Anforderung zum Senden einer Audiobenachrichtigung.
DocumentNotificationContent

Eine Anforderung zum Senden einer Dokumentbenachrichtigung.
ImageNotificationContent

Eine Anforderung zum Senden einer Bildbenachrichtigung.
MediaNotificationContent

@deprecated Eine Anforderung zum Senden einer Bildbenachrichtigung.
TemplateNotificationContent

Eine Anforderung zum Senden einer Vorlagenbenachrichtigung.
TextNotificationContent

Eine Anforderung zum Senden einer Textbenachrichtigung.
VideoNotificationContent

Eine Anforderung zum Senden einer Videobenachrichtigung.

AudioNotificationContent

Eine Anforderung zum Senden einer Audiobenachrichtigung.

Name Erforderlich Typ Beschreibung
channelRegistrationId True

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind True string:

audio

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri True

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to True

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

DocumentNotificationContent

Eine Anforderung zum Senden einer Dokumentbenachrichtigung.

Name Erforderlich Typ Beschreibung
channelRegistrationId True

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind True string:

document

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri True

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to True

string[]

Die bezeichner der nativen externen Plattform des Empfängers.
caption

string

Optionaler Textinhalt.
fileName

string

Optionaler Name für die Datei.

ImageNotificationContent

Eine Anforderung zum Senden einer Bildbenachrichtigung.

Name Erforderlich Typ Beschreibung
channelRegistrationId True

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind True string:

image

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri True

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to True

string[]

Die bezeichner der nativen externen Plattform des Empfängers.
caption

string

Optionaler Textinhalt.

MediaNotificationContent

@deprecated Eine Anforderung zum Senden einer Bildbenachrichtigung.

Name Erforderlich Typ Beschreibung
channelRegistrationId True

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind True string:

image_v0

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri True

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to True

string[]

Die bezeichner der nativen externen Plattform des Empfängers.
content

string

Optionaler Textinhalt.

TemplateNotificationContent

Eine Anforderung zum Senden einer Vorlagenbenachrichtigung.

Name Erforderlich Typ Beschreibung
channelRegistrationId True

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind True string:

template

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
template True

MessageTemplate

Das Vorlagenobjekt, das zum Erstellen von Vorlagen verwendet wird.
to True

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

TextNotificationContent

Eine Anforderung zum Senden einer Textbenachrichtigung.

Name Erforderlich Typ Beschreibung
channelRegistrationId True

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
content True

string

Nachrichteninhalt.
kind True string:

text

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
to True

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

VideoNotificationContent

Eine Anforderung zum Senden einer Videobenachrichtigung.

Name Erforderlich Typ Beschreibung
channelRegistrationId True

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind True string:

video

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri True

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to True

string[]

Die bezeichner der nativen externen Plattform des Empfängers.
caption

string

Optionaler Textinhalt.

Antworten

Name Typ Beschreibung
202 Accepted

SendMessageResult

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

  • Repeatability-Result: string
  • x-ms-client-request-id: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Authorization

Typ: apiKey
In: header

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Sends a notification message - document

Beispielanforderung

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

Beispiel für eine Antwort

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

Sends a notification message - image

Beispielanforderung

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

Beispiel für eine Antwort

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

Sends a notification message - Template

Beispielanforderung

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

Beispiel für eine Antwort

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

Sends a notification message - text

Beispielanforderung

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

Beispiel für eine Antwort

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

Sends a notification message - video

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AudioNotificationContent

Eine Anforderung zum Senden einer Audiobenachrichtigung.
Azure.Core.Foundations.Error

Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessageKind

Der Nachrichtentyp.
DocumentNotificationContent

Eine Anforderung zum Senden einer Dokumentbenachrichtigung.
ImageNotificationContent

Eine Anforderung zum Senden einer Bildbenachrichtigung.
MediaNotificationContent

@deprecated Eine Anforderung zum Senden einer Bildbenachrichtigung.
MessageReceipt

Bestätigung des Sendens einer Nachricht.
MessageTemplate

Das Vorlagenobjekt, das zum Erstellen von Vorlagen verwendet wird.
MessageTemplateBindingsKind

Der Typ der Nachrichtenvorlage.
MessageTemplateDocument

Die Dokumentwertinformationen der Nachrichtenvorlage.
MessageTemplateImage

Die Bildwertinformationen der Nachrichtenvorlage.
MessageTemplateLocation

Die Standortwertinformationen der Nachrichtenvorlage.
MessageTemplateQuickAction

Die Quick Action Value-Informationen der Nachrichtenvorlage.
MessageTemplateText

Die Textwertinformationen der Nachrichtenvorlage.
MessageTemplateValueKind

Der Typ des Vorlagenparameters.
MessageTemplateVideo

Die Videowertinformationen der Nachrichtenvorlage.
SendMessageResult

Ergebnis des Sendenachrichtenvorgangs.
TemplateNotificationContent

Eine Anforderung zum Senden einer Vorlagenbenachrichtigung.
TextNotificationContent

Eine Anforderung zum Senden einer Textbenachrichtigung.
VideoNotificationContent

Eine Anforderung zum Senden einer Videobenachrichtigung.
WhatsAppMessageButtonSubType

Der Untertyp der WhatsApp-Schaltfläche.
WhatsAppMessageTemplateBindings

Die Vorlagenbindungen für WhatsApp
WhatsAppMessageTemplateBindingsButton

Die Vorlagenbindungskomponentesschaltfläche für WhatsApp
WhatsAppMessageTemplateBindingsComponent

Die Vorlagenbindungskomponente für WhatsApp

AudioNotificationContent

Eine Anforderung zum Senden einer Audiobenachrichtigung.

Name Typ Beschreibung
channelRegistrationId

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind string:

audio

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
details

Azure.Core.Foundations.Error[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message

string

Eine lesbare Darstellung des Fehlers.
target

string

Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name Typ Beschreibung
error

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
innererror

Azure.Core.Foundations.InnerError

Innerer Fehler.

CommunicationMessageKind

Der Nachrichtentyp.

Name Typ Beschreibung
audio

string

Audionachrichtentyp.
document

string

Dokumentnachrichtentyp.
image

string

Bildnachrichtentyp.
image_v0

string

Bildnachrichtentyp. Legacybildtyp für MediaNotificationContent, der veraltet ist
template

string

Nachrichtentyp der Vorlage.
text

string

Textnachrichtentyp.
video

string

Videonachrichtentyp.

DocumentNotificationContent

Eine Anforderung zum Senden einer Dokumentbenachrichtigung.

Name Typ Beschreibung
caption

string

Optionaler Textinhalt.
channelRegistrationId

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
fileName

string

Optionaler Name für die Datei.
kind string:

document

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

ImageNotificationContent

Eine Anforderung zum Senden einer Bildbenachrichtigung.

Name Typ Beschreibung
caption

string

Optionaler Textinhalt.
channelRegistrationId

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind string:

image

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

MediaNotificationContent

@deprecated Eine Anforderung zum Senden einer Bildbenachrichtigung.

Name Typ Beschreibung
channelRegistrationId

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
content

string

Optionaler Textinhalt.
kind string:

image_v0

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

MessageReceipt

Bestätigung des Sendens einer Nachricht.

Name Typ Beschreibung
messageId

string

Die Nachrichten-ID.
to

string

Die bezeichner der systemeigenen externen Plattform des Empfängers.

MessageTemplate

Das Vorlagenobjekt, das zum Erstellen von Vorlagen verwendet wird.

Name Typ Beschreibung
bindings MessageTemplateBindings:

WhatsAppMessageTemplateBindings

Das Bindungsobjekt zum Verknüpfen von Werten mit den vorlagenspezifischen Speicherorten
language

string

Die Sprache der Vorlage im ISO 639-Format besteht aus einem Zwei-Buchstaben-Sprachcode gefolgt von einem optionalen Ländercode aus zwei Buchstaben, z. B. "en" oder "en_US".
name

string

Name der Vorlage.
values MessageTemplateValue[]:

Die Vorlagenwerte.

MessageTemplateBindingsKind

Der Typ der Nachrichtenvorlage.

Name Typ Beschreibung
whatsApp

string

Der Vorlagentyp "WhatsApp".

MessageTemplateDocument

Die Dokumentwertinformationen der Nachrichtenvorlage.

Name Typ Beschreibung
caption

string

Die [optional] Beschriftung des Medienobjekts.
fileName

string

Der [optionale] Dateiname der Mediendatei.
kind string:

document

Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
name

string

Vorlagenbindungsreferenzname
url

string

Die (öffentliche) URL der Medien.

MessageTemplateImage

Die Bildwertinformationen der Nachrichtenvorlage.

Name Typ Beschreibung
caption

string

Die [optional] Beschriftung des Medienobjekts.
fileName

string

Der [optionale] Dateiname der Mediendatei.
kind string:

image

Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
name

string

Vorlagenbindungsreferenzname
url

string

Die (öffentliche) URL der Medien.

MessageTemplateLocation

Die Standortwertinformationen der Nachrichtenvorlage.

Name Typ Beschreibung
address

string

Die [Optional]-Adresse des Speicherorts.
kind string:

location

Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
latitude

number

Der Breitengrad des Standorts.
locationName

string

Der [Optional]-Name des Speicherorts.
longitude

number

Der Längengrad des Standorts.
name

string

Vorlagenbindungsreferenzname

MessageTemplateQuickAction

Die Quick Action Value-Informationen der Nachrichtenvorlage.

Name Typ Beschreibung
kind string:

quickAction

Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
name

string

Vorlagenbindungsreferenzname
payload

string

Die Nutzlast für schnelle Aktionen [Optional]
text

string

Der Schnellaktionstext [Optional]

MessageTemplateText

Die Textwertinformationen der Nachrichtenvorlage.

Name Typ Beschreibung
kind string:

text

Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
name

string

Vorlagenbindungsreferenzname
text

string

Der Textwert.

MessageTemplateValueKind

Der Typ des Vorlagenparameters.

Name Typ Beschreibung
document

string

Der Parametertyp der Dokumentvorlage.
image

string

Der Parametertyp der Bildvorlage.
location

string

Der Parametertyp der Speicherortvorlage.
quickAction

string

Der Parametertyp der Schnellaktionsvorlage.
text

string

Der Parametertyp der Textvorlage.
video

string

Der Parametertyp der Videovorlage.

MessageTemplateVideo

Die Videowertinformationen der Nachrichtenvorlage.

Name Typ Beschreibung
caption

string

Die [optional] Beschriftung des Medienobjekts.
fileName

string

Der [optionale] Dateiname der Mediendatei.
kind string:

video

Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
name

string

Vorlagenbindungsreferenzname
url

string

Die (öffentliche) URL der Medien.

SendMessageResult

Ergebnis des Sendenachrichtenvorgangs.

Name Typ Beschreibung
receipts

MessageReceipt[]

Bestätigungen des Sendenachrichtenvorgangs.

TemplateNotificationContent

Eine Anforderung zum Senden einer Vorlagenbenachrichtigung.

Name Typ Beschreibung
channelRegistrationId

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind string:

template

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
template

MessageTemplate

Das Vorlagenobjekt, das zum Erstellen von Vorlagen verwendet wird.
to

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

TextNotificationContent

Eine Anforderung zum Senden einer Textbenachrichtigung.

Name Typ Beschreibung
channelRegistrationId

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
content

string

Nachrichteninhalt.
kind string:

text

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
to

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

VideoNotificationContent

Eine Anforderung zum Senden einer Videobenachrichtigung.

Name Typ Beschreibung
caption

string

Optionaler Textinhalt.
channelRegistrationId

string

Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
kind string:

video

Der Typdiskriminator, der einen Benachrichtigungstyp beschreibt.
mediaUri

string

Eine Medien-URL für die Datei. Erforderlich, wenn der Typ einer der unterstützten Medientypen ist, z. B. Bild
to

string[]

Die bezeichner der nativen externen Plattform des Empfängers.

WhatsAppMessageButtonSubType

Der Untertyp der WhatsApp-Schaltfläche.

Name Typ Beschreibung
quickReply

string

Der Untertyp der Schaltfläche "WhatsApp" ist eine schnelle Antwort.
url

string

Der Untertyp der Schaltfläche "WhatsApp" ist "URL".

WhatsAppMessageTemplateBindings

Die Vorlagenbindungen für WhatsApp

Name Typ Beschreibung
body

WhatsAppMessageTemplateBindingsComponent[]

Die Textvorlagenbindungen
buttons

WhatsAppMessageTemplateBindingsButton[]

Die Schaltflächenvorlagenbindungen
footer

WhatsAppMessageTemplateBindingsComponent[]

Die Fußzeilenvorlagenbindungen
header

WhatsAppMessageTemplateBindingsComponent[]

Die Kopfzeilenvorlagenbindungen
kind string:

whatsApp

Der Typdiskriminator, der einen Vorlagenbindungstyp beschreibt.

WhatsAppMessageTemplateBindingsButton

Die Vorlagenbindungskomponentesschaltfläche für WhatsApp

Name Typ Beschreibung
refValue

string

Der Name des Elements, auf das in den Vorlagenwerten verwiesen wird.
subType

WhatsAppMessageButtonSubType

Untertyp der Schaltfläche "WhatsApp"

WhatsAppMessageTemplateBindingsComponent

Die Vorlagenbindungskomponente für WhatsApp

Name Typ Beschreibung
refValue

string

Der Name des Elements, auf das in den Vorlagenwerten verwiesen wird.