Notification Messages Operations - Send

  • Riferimento
Servizio:
Communication
Versione API:
2024-02-01

Invia un messaggio di notifica da Business a User.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

uri

Risorsa di comunicazione, ad esempio https://my-resource.communication.azure.com
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Repeatability-Request-ID

string

Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.
Repeatability-First-Sent

string

date-time

Specifica la data e l'ora di creazione della richiesta.
x-ms-client-request-id

string

uuid

Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome Descrizione
MediaNotificationContent

Richiesta di invio di una notifica di immagine.
TemplateNotificationContent

Richiesta di invio di una notifica di modello.
TextNotificationContent

Richiesta di invio di una notifica di testo.

MediaNotificationContent

Richiesta di invio di una notifica di immagine.

Nome Necessario Tipo Descrizione
channelRegistrationId True

string

ID registrazione canale per l'identificatore di business.
kind True string:

image

Il discriminante del tipo che descrive un tipo di notifica.
mediaUri True

string

URL multimediale per il file. Obbligatorio se il tipo è uno dei tipi di supporti supportati, ad esempio l'immagine
to True

string[]

Identificatori utente della piattaforma esterna nativa del destinatario.
content

string

Contenuto di testo facoltativo.

TemplateNotificationContent

Richiesta di invio di una notifica di modello.

Nome Necessario Tipo Descrizione
channelRegistrationId True

string

ID registrazione canale per l'identificatore di business.
kind True string:

template

Il discriminante del tipo che descrive un tipo di notifica.
template True

MessageTemplate

Oggetto modello utilizzato per creare modelli.
to True

string[]

Identificatori utente della piattaforma esterna nativa del destinatario.

TextNotificationContent

Richiesta di invio di una notifica di testo.

Nome Necessario Tipo Descrizione
channelRegistrationId True

string

ID registrazione canale per l'identificatore di business.
content True

string

Contenuto del messaggio.
kind True string:

text

Il discriminante del tipo che descrive un tipo di notifica.
to True

string[]

Identificatori utente della piattaforma esterna nativa del destinatario.

Risposte

Nome Tipo Descrizione
202 Accepted

SendMessageResult

La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Intestazioni

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

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

AadOauth2Auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome Descrizione
https://communication.azure.com/.default

Authorization

Tipo: apiKey
In: header

Esempio

Sends a notification message - image
Sends a notification message - Template
Sends a notification message - text

Sends a notification message - image

Esempio di richiesta

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

Risposta di esempio

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

Sends a notification message - Template

Esempio di richiesta

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

Risposta di esempio

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

Sends a notification message - text

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.
Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessageKind

Tipo di messaggio.
MediaNotificationContent

Richiesta di invio di una notifica di immagine.
MessageReceipt

Ricezione dell'invio di un messaggio.
MessageTemplate

Oggetto modello utilizzato per creare modelli.
MessageTemplateBindingsKind

Tipo del modello di messaggio.
MessageTemplateDocument

Informazioni sul valore del documento del modello di messaggio.
MessageTemplateImage

Informazioni sul valore dell'immagine del modello di messaggio.
MessageTemplateLocation

Informazioni sul valore della posizione del modello di messaggio.
MessageTemplateQuickAction

Informazioni sul valore dell'azione rapida del modello di messaggio.
MessageTemplateText

Informazioni sul valore di testo del modello di messaggio.
MessageTemplateValueKind

Tipo del parametro del modello.
MessageTemplateVideo

Informazioni sul valore video del modello di messaggio.
SendMessageResult

Risultato dell'operazione di invio del messaggio.
TemplateNotificationContent

Richiesta di invio di una notifica di modello.
TextNotificationContent

Richiesta di invio di una notifica di testo.
WhatsAppMessageButtonSubType

Sottotipo del pulsante WhatsApp.
WhatsAppMessageTemplateBindings

Associazioni di modelli per WhatsApp
WhatsAppMessageTemplateBindingsButton

Pulsante del componente di binding del modello per WhatsApp
WhatsAppMessageTemplateBindingsComponent

Componente di binding del modello per WhatsApp

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
innererror

Azure.Core.Foundations.InnerError

Errore interno.

CommunicationMessageKind

Tipo di messaggio.

Nome Tipo Descrizione
image

string

Tipo di messaggio immagine.
template

string

Tipo di messaggio modello.
text

string

Tipo di messaggio di testo.

MediaNotificationContent

Richiesta di invio di una notifica di immagine.

Nome Tipo Descrizione
channelRegistrationId

string

ID registrazione canale per l'identificatore di business.
content

string

Contenuto di testo facoltativo.
kind string:

image

Il discriminante del tipo che descrive un tipo di notifica.
mediaUri

string

URL multimediale per il file. Obbligatorio se il tipo è uno dei tipi di supporti supportati, ad esempio l'immagine
to

string[]

Identificatori utente della piattaforma esterna nativa del destinatario.

MessageReceipt

Ricezione dell'invio di un messaggio.

Nome Tipo Descrizione
messageId

string

ID del messaggio.
to

string

Identificatore utente nativo della piattaforma esterna del destinatario.

MessageTemplate

Oggetto modello utilizzato per creare modelli.

Nome Tipo Descrizione
bindings MessageTemplateBindings:

WhatsAppMessageTemplateBindings

Oggetto di associazione per collegare i valori alle posizioni specifiche del modello
language

string

La lingua del modello, nel formato ISO 639, è costituita da un codice linguistico a due lettere seguito da un codice paese facoltativo a due lettere, ad esempio 'en' o 'en_US'.
name

string

Nome del modello.
values MessageTemplateValue[]:

Valori del modello.

MessageTemplateBindingsKind

Tipo del modello di messaggio.

Nome Tipo Descrizione
whatsApp

string

Tipo di modello WhatsApp.

MessageTemplateDocument

Informazioni sul valore del documento del modello di messaggio.

Nome Tipo Descrizione
caption

string

Didascalia [facoltativa] dell'oggetto multimediale.
fileName

string

Nome file [facoltativo] del file multimediale.
kind string:

document

Il discriminante del tipo che descrive un tipo di parametro di modello.
name

string

Nome di riferimento dell'associazione di modelli
url

string

URL (pubblico) del supporto.

MessageTemplateImage

Informazioni sul valore dell'immagine del modello di messaggio.

Nome Tipo Descrizione
caption

string

Didascalia [facoltativa] dell'oggetto multimediale.
fileName

string

Nome file [facoltativo] del file multimediale.
kind string:

image

Il discriminante del tipo che descrive un tipo di parametro di modello.
name

string

Nome di riferimento dell'associazione di modelli
url

string

URL (pubblico) del supporto.

MessageTemplateLocation

Informazioni sul valore della posizione del modello di messaggio.

Nome Tipo Descrizione
address

string

Indirizzo [Facoltativo] del percorso.
kind string:

location

Il discriminante del tipo che descrive un tipo di parametro di modello.
latitude

number

Latitudine della posizione.
locationName

string

Nome [Facoltativo] del percorso.
longitude

number

Longitudine della posizione.
name

string

Nome di riferimento dell'associazione di modelli

MessageTemplateQuickAction

Informazioni sul valore dell'azione rapida del modello di messaggio.

Nome Tipo Descrizione
kind string:

quickAction

Il discriminante del tipo che descrive un tipo di parametro di modello.
name

string

Nome di riferimento dell'associazione di modelli
payload

string

Payload dell'azione rapida [Facoltativo]
text

string

Testo dell'azione rapida [Facoltativo]

MessageTemplateText

Informazioni sul valore di testo del modello di messaggio.

Nome Tipo Descrizione
kind string:

text

Il discriminante del tipo che descrive un tipo di parametro di modello.
name

string

Nome di riferimento dell'associazione di modelli
text

string

Valore di testo.

MessageTemplateValueKind

Tipo del parametro del modello.

Nome Tipo Descrizione
document

string

Tipo di parametro del modello di documento.
image

string

Tipo di parametro del modello di immagine.
location

string

Tipo di parametro del modello di percorso.
quickAction

string

Tipo di parametro del modello di azione rapida.
text

string

Tipo di parametro del modello di testo.
video

string

Tipo di parametro del modello video.

MessageTemplateVideo

Informazioni sul valore video del modello di messaggio.

Nome Tipo Descrizione
caption

string

Didascalia [facoltativa] dell'oggetto multimediale.
fileName

string

Nome file [facoltativo] del file multimediale.
kind string:

video

Il discriminante del tipo che descrive un tipo di parametro di modello.
name

string

Nome di riferimento dell'associazione di modelli
url

string

URL (pubblico) del supporto.

SendMessageResult

Risultato dell'operazione di invio del messaggio.

Nome Tipo Descrizione
receipts

MessageReceipt[]

Ricevute dell'operazione di invio del messaggio.

TemplateNotificationContent

Richiesta di invio di una notifica di modello.

Nome Tipo Descrizione
channelRegistrationId

string

ID registrazione canale per l'identificatore di business.
kind string:

template

Il discriminante del tipo che descrive un tipo di notifica.
template

MessageTemplate

Oggetto modello utilizzato per creare modelli.
to

string[]

Identificatori utente della piattaforma esterna nativa del destinatario.

TextNotificationContent

Richiesta di invio di una notifica di testo.

Nome Tipo Descrizione
channelRegistrationId

string

ID registrazione canale per l'identificatore di business.
content

string

Contenuto del messaggio.
kind string:

text

Il discriminante del tipo che descrive un tipo di notifica.
to

string[]

Identificatori utente della piattaforma esterna nativa del destinatario.

WhatsAppMessageButtonSubType

Sottotipo del pulsante WhatsApp.

Nome Tipo Descrizione
quickReply

string

Il sottotipo del pulsante WhatsApp è una risposta rapida.
url

string

Il sottotipo del pulsante WhatsApp è URL.

WhatsAppMessageTemplateBindings

Associazioni di modelli per WhatsApp

Nome Tipo Descrizione
body

WhatsAppMessageTemplateBindingsComponent[]

Associazioni di modelli del corpo
buttons

WhatsAppMessageTemplateBindingsButton[]

Associazioni di modelli di pulsante
footer

WhatsAppMessageTemplateBindingsComponent[]

Associazioni di modelli di piè di pagina
header

WhatsAppMessageTemplateBindingsComponent[]

Associazioni di modelli di intestazione
kind string:

whatsApp

Il discriminante del tipo che descrive un tipo di associazioni di modelli.

WhatsAppMessageTemplateBindingsButton

Pulsante del componente di binding del modello per WhatsApp

Nome Tipo Descrizione
refValue

string

Nome dell'elemento a cui si fa riferimento nei valori del modello.
subType

WhatsAppMessageButtonSubType

Sottotipo del pulsante WhatsApp

WhatsAppMessageTemplateBindingsComponent

Componente di binding del modello per WhatsApp

Nome Tipo Descrizione
refValue

string

Nome dell'elemento a cui si fa riferimento nei valori del modello.