Notification Messages Operations - Send

Referenz

Dienst:: Communication

API-Version:: 2024-02-01

Sendet eine Benachrichtigungsnachricht von Business an den Benutzer.

POST {endpoint}/messages/notifications:send?api-version=2024-02-01

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	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Typ	Beschreibung
Repeatability-Request-ID	string	Ein undurchsichtiger, global eindeutiger, vom Client generierter Zeichenfolgenbezeichner für die Anforderung.
Repeatability-First-Sent	string date-time	Gibt das Datum und die Uhrzeit an, an dem die Anforderung zum ersten Mal erstellt wurde.
x-ms-client-request-id	string uuid	Ein undurchsichtiger, global eindeutiger, vom Client generierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

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

Name	Beschreibung
MediaNotificationContent	Eine Anforderung zum Senden einer Medienbenachrichtigung.
TemplateNotificationContent	Eine Anforderung zum Senden einer Vorlagenbenachrichtigung.
TextNotificationContent	Eine Anforderung zum Senden einer Textbenachrichtigung.

MediaNotificationContent

Eine Anforderung zum Senden einer Medienbenachrichtigung.

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. Image
to	True	string[]	Die nativen Benutzerbezeichner der 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 nativen Benutzerbezeichner der 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 nativen Benutzerbezeichner der externen Plattform des Empfängers.

Antworten

Name	Typ	Beschreibung
202 Accepted	SendMessageResult	Die Anforderung wurde für die 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	Eine unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

202 Accepted

SendMessageResult

Die Anforderung wurde für die 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

Eine unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Flow

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 - image

Sends a notification message - Template

Sends a notification message - text

Sends a notification message - image

Beispielanforderung

HTTP

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

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "image",
  "mediaUri": "https://example.com/image.jpg",
  "content": "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

HTTP

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

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

HTTP

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

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

Definitionen

Name	Beschreibung
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 Typ der Meldung. Unterstützt Text, Bild, Vorlage.
MediaNotificationContent	Eine Anforderung zum Senden einer Medienbenachrichtigung.
MessageReceipt	Empfang der gesendeten 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 Schnellaktionswertinformationen der Nachrichtenvorlage.
MessageTemplateText	Die Textwertinformationen der Nachrichtenvorlage.
MessageTemplateValueKind	Der Typ des Vorlagenparameters.
MessageTemplateVideo	Die Videowertinformationen der Nachrichtenvorlage.
SendMessageResult	Ergebnis des Vorgangs "Nachricht senden".
TemplateNotificationContent	Eine Anforderung zum Senden einer Vorlagenbenachrichtigung.
TextNotificationContent	Eine Anforderung zum Senden einer Textbenachrichtigung.
WhatsAppMessageButtonSubType	Der Untertyp der WhatsApp-Schaltfläche.
WhatsAppMessageTemplateBindings	Vorlagenbindungen für WhatsApp
WhatsAppMessageTemplateBindingsButton	Die Schaltfläche "Vorlagenbindungskomponente" für WhatsApp
WhatsAppMessageTemplateBindingsComponent	Die Vorlagenbindungskomponente für WhatsApp

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten 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 für Menschen 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	Einer der vom Server definierten Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

CommunicationMessageKind

Der Typ der Meldung. Unterstützt Text, Bild, Vorlage.

Name	Typ	Beschreibung
image	string	Bildnachrichtentyp.
template	string	Vorlagennachrichtentyp.
text	string	Textnachrichtentyp.

MediaNotificationContent

Eine Anforderung zum Senden einer Medienbenachrichtigung.

Name	Typ	Beschreibung
channelRegistrationId	string	Die Kanalregistrierungs-ID für den Geschäftsbezeichner.
content	string	Optionaler Textinhalt.
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. Image
to	string[]	Die nativen Benutzerbezeichner der externen Plattform des Empfängers.

MessageReceipt

Empfang der gesendeten Nachricht.

Name	Typ	Beschreibung
messageId	string	Die Nachrichten-ID.
to	string	Der native Benutzerbezeichner für die externe 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 Zweibuchstaben-Sprachcode gefolgt von einem optionalen Zweibuchstaben-Ländercode, z. B. "en" oder "en_US".
name	string	Der Name der Vorlage.
values	MessageTemplateValue[]: MessageTemplateDocument[] MessageTemplateImage[] MessageTemplateLocation[] MessageTemplateQuickAction[] MessageTemplateText[] MessageTemplateVideo[]	Die Vorlagenwerte.

MessageTemplateBindingsKind

Der Typ der Nachrichtenvorlage.

Name	Typ	Beschreibung
whatsApp	string	Der WhatsApp-Vorlagentyp.

MessageTemplateDocument

Die Dokumentwertinformationen der Nachrichtenvorlage.

Name	Typ	Beschreibung
caption	string	Die [optional] Untertitel des Medienobjekts.
fileName	string	Der Dateiname [optional] 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] Untertitel des Medienobjekts.
fileName	string	Der Dateiname [optional] 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 Standorts.
kind	string: location	Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
latitude	number	Die Breitenkoordinate der Position.
locationName	string	Der [Optional]-Name des Speicherorts.
longitude	number	Die Längenkoordinate der Position.
name	string	Vorlagenbindungsreferenzname

MessageTemplateQuickAction

Die Schnellaktionswertinformationen der Nachrichtenvorlage.

Name	Typ	Beschreibung
kind	string: quickAction	Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
name	string	Vorlagenbindungsreferenzname
payload	string	Die [Optional]-Schnellaktionsnutzlast
text	string	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 Dokumentvorlagenparametertyp.
image	string	Der Parametertyp der Bildvorlage.
location	string	Der Parametertyp der Standortvorlage.
quickAction	string	Der Schnellaktionsvorlagenparametertyp.
text	string	Der Textvorlagenparametertyp.
video	string	Der Videovorlagenparametertyp.

MessageTemplateVideo

Die Videowertinformationen der Nachrichtenvorlage.

Name	Typ	Beschreibung
caption	string	Die [optional] Untertitel des Medienobjekts.
fileName	string	Der Dateiname [optional] der Mediendatei.
kind	string: video	Der Typdiskriminator, der einen Vorlagenparametertyp beschreibt.
name	string	Vorlagenbindungsreferenzname
url	string	Die (öffentliche) URL der Medien.

SendMessageResult

Ergebnis des Vorgangs "Nachricht senden".

Name	Typ	Beschreibung
receipts	MessageReceipt[]	Empfangsbestätigungen des Vorgangs zum Senden von Nachrichten.

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 nativen Benutzerbezeichner der 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 nativen Benutzerbezeichner der externen Plattform des Empfängers.

WhatsAppMessageButtonSubType

Der Untertyp der WhatsApp-Schaltfläche.

Name	Typ	Beschreibung
quickReply	string	Der Untertyp der WhatsApp-Schaltfläche ist eine schnelle Antwort.
url	string	Der Untertyp der WhatsApp-Schaltfläche ist URL.

WhatsAppMessageTemplateBindings

Vorlagenbindungen für WhatsApp

Name	Typ	Beschreibung
body	WhatsAppMessageTemplateBindingsComponent[]	Textvorlagenbindungen
buttons	WhatsAppMessageTemplateBindingsButton[]	Schaltflächenvorlagenbindungen
footer	WhatsAppMessageTemplateBindingsComponent[]	Die Fußzeilenvorlagenbindungen
header	WhatsAppMessageTemplateBindingsComponent[]	Die Headervorlagenbindungen
kind	string: whatsApp	Der Typdiskriminator, der einen Vorlagenbindungstyp beschreibt.

WhatsAppMessageTemplateBindingsButton

Die Schaltfläche "Vorlagenbindungskomponente" für WhatsApp

Name	Typ	Beschreibung
refValue	string	Der Name des Elements, auf das in den Vorlagenwerten verwiesen wird.
subType	WhatsAppMessageButtonSubType	Der Untertyp der WhatsApp-Schaltfläche

WhatsAppMessageTemplateBindingsComponent

Die Vorlagenbindungskomponente für WhatsApp

Name	Typ	Beschreibung
refValue	string	Der Name des Elements, auf das in den Vorlagenwerten verwiesen wird.

Freigeben über

Notification Messages Operations - Send

URI-Parameter

Anforderungsheader

Anforderungstext

MediaNotificationContent

TemplateNotificationContent

TextNotificationContent

Antworten

Sicherheit

AadOauth2Auth

Bereiche

Authorization

Beispiele

Sends a notification message - image

Beispielanforderung

Beispiel für eine Antwort

Sends a notification message - Template

Beispielanforderung

Beispiel für eine Antwort

Sends a notification message - text

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CommunicationMessageKind

MediaNotificationContent

MessageReceipt

MessageTemplate

MessageTemplateBindingsKind

MessageTemplateDocument

MessageTemplateImage

MessageTemplateLocation

MessageTemplateQuickAction

MessageTemplateText

MessageTemplateValueKind

MessageTemplateVideo

SendMessageResult

TemplateNotificationContent

TextNotificationContent

WhatsAppMessageButtonSubType

WhatsAppMessageTemplateBindings

WhatsAppMessageTemplateBindingsButton

WhatsAppMessageTemplateBindingsComponent

Zusätzliche Ressourcen