Compartilhar via

Notification Messages Operations - Send

  • Referência
Serviço:
Communication
Versão da API:
2024-08-30

Envia uma mensagem de notificação da Empresa para o Usuário.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

uri

O recurso de comunicação, por exemplo, https://my-resource.communication.azure.com
api-version
 query True

string

A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Repeatability-Request-ID

string

Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.
Repeatability-First-Sent

string

date-time

Especifica a data e a hora em que a solicitação foi criada pela primeira vez.
x-ms-client-request-id

string

uuid

Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome Description
AudioNotificationContent

Uma solicitação para enviar uma notificação de áudio.
DocumentNotificationContent

Uma solicitação para enviar uma notificação de documento.
ImageNotificationContent

Uma solicitação para enviar uma notificação de imagem.
MediaNotificationContent

@deprecated uma solicitação para enviar uma notificação de imagem.
TemplateNotificationContent

Uma solicitação para enviar uma notificação de modelo.
TextNotificationContent

Uma solicitação para enviar uma notificação de texto.
VideoNotificationContent

Uma solicitação para enviar uma notificação por vídeo.

AudioNotificationContent

Uma solicitação para enviar uma notificação de áudio.

Nome Obrigatório Tipo Description
channelRegistrationId True

string

A ID de Registro de Canal para o Identificador de Negócios.
kind True string:

audio

O tipo discriminatório que descreve um tipo de notificação.
mediaUri True

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to True

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

DocumentNotificationContent

Uma solicitação para enviar uma notificação de documento.

Nome Obrigatório Tipo Description
channelRegistrationId True

string

A ID de Registro de Canal para o Identificador de Negócios.
kind True string:

document

O tipo discriminatório que descreve um tipo de notificação.
mediaUri True

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to True

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.
caption

string

Conteúdo de texto opcional.
fileName

string

Nome opcional para o arquivo.

ImageNotificationContent

Uma solicitação para enviar uma notificação de imagem.

Nome Obrigatório Tipo Description
channelRegistrationId True

string

A ID de Registro de Canal para o Identificador de Negócios.
kind True string:

image

O tipo discriminatório que descreve um tipo de notificação.
mediaUri True

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to True

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.
caption

string

Conteúdo de texto opcional.

MediaNotificationContent

@deprecated uma solicitação para enviar uma notificação de imagem.

Nome Obrigatório Tipo Description
channelRegistrationId True

string

A ID de Registro de Canal para o Identificador de Negócios.
kind True string:

image_v0

O tipo discriminatório que descreve um tipo de notificação.
mediaUri True

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to True

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.
content

string

Conteúdo de texto opcional.

TemplateNotificationContent

Uma solicitação para enviar uma notificação de modelo.

Nome Obrigatório Tipo Description
channelRegistrationId True

string

A ID de Registro de Canal para o Identificador de Negócios.
kind True string:

template

O tipo discriminatório que descreve um tipo de notificação.
template True

MessageTemplate

O objeto de modelo usado para criar modelos.
to True

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

TextNotificationContent

Uma solicitação para enviar uma notificação de texto.

Nome Obrigatório Tipo Description
channelRegistrationId True

string

A ID de Registro de Canal para o Identificador de Negócios.
content True

string

Conteúdo da mensagem.
kind True string:

text

O tipo discriminatório que descreve um tipo de notificação.
to True

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

VideoNotificationContent

Uma solicitação para enviar uma notificação por vídeo.

Nome Obrigatório Tipo Description
channelRegistrationId True

string

A ID de Registro de Canal para o Identificador de Negócios.
kind True string:

video

O tipo discriminatório que descreve um tipo de notificação.
mediaUri True

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to True

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.
caption

string

Conteúdo de texto opcional.

Respostas

Nome Tipo Description
202 Accepted

SendMessageResult

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Cabeçalhos

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

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

AadOauth2Auth

O fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Authorization

Tipo: apiKey
Em: header

Exemplos

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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
202 
{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - document

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
202 
{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - image

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
202 
{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - Template

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
202 
{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - text

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
202 
{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - video

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
202 
{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Definições

Nome Description
AudioNotificationContent

Uma solicitação para enviar uma notificação de áudio.
Azure.Core.Foundations.Error

O objeto de erro.
Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessageKind

O tipo de mensagem.
DocumentNotificationContent

Uma solicitação para enviar uma notificação de documento.
ImageNotificationContent

Uma solicitação para enviar uma notificação de imagem.
MediaNotificationContent

@deprecated uma solicitação para enviar uma notificação de imagem.
MessageReceipt

Recebimento da mensagem de envio.
MessageTemplate

O objeto de modelo usado para criar modelos.
MessageTemplateBindingsKind

O tipo do modelo de mensagem.
MessageTemplateDocument

As informações de valor do documento do modelo de mensagem.
MessageTemplateImage

As informações de valor de imagem do modelo de mensagem.
MessageTemplateLocation

Informações de valor de localização do modelo de mensagem.
MessageTemplateQuickAction

Informações de valor de ação rápida do modelo de mensagem.
MessageTemplateText

As informações de valor de texto do modelo de mensagem.
MessageTemplateValueKind

O tipo do parâmetro de modelo.
MessageTemplateVideo

As informações de valor de vídeo do modelo de mensagem.
SendMessageResult

Resultado da operação de envio de mensagem.
TemplateNotificationContent

Uma solicitação para enviar uma notificação de modelo.
TextNotificationContent

Uma solicitação para enviar uma notificação de texto.
VideoNotificationContent

Uma solicitação para enviar uma notificação por vídeo.
WhatsAppMessageButtonSubType

O subtipo do botão WhatsApp.
WhatsAppMessageTemplateBindings

As associações de modelo para WhatsApp
WhatsAppMessageTemplateBindingsButton

O botão de componente de associações de modelo para WhatsApp
WhatsAppMessageTemplateBindingsComponent

O componente de associações de modelo para WhatsApp

AudioNotificationContent

Uma solicitação para enviar uma notificação de áudio.

Nome Tipo Description
channelRegistrationId

string

A ID de Registro de Canal para o Identificador de Negócios.
kind string:

audio

O tipo discriminatório que descreve um tipo de notificação.
mediaUri

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

Azure.Core.Foundations.Error

O objeto de erro.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
details

Azure.Core.Foundations.Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível pelo ser humano do erro.
target

string

O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome Tipo Description
error

Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
innererror

Azure.Core.Foundations.InnerError

Erro interno.

CommunicationMessageKind

O tipo de mensagem.

Nome Tipo Description
audio

string

Tipo de mensagem de áudio.
document

string

Tipo de mensagem de documento.
image

string

Tipo de mensagem de imagem.
image_v0

string

Tipo de mensagem de imagem. Tipo de imagem herdado para MediaNotificationContent que está sendo preterido
template

string

Tipo de mensagem de modelo.
text

string

Tipo de mensagem de texto.
video

string

Tipo de mensagem de vídeo.

DocumentNotificationContent

Uma solicitação para enviar uma notificação de documento.

Nome Tipo Description
caption

string

Conteúdo de texto opcional.
channelRegistrationId

string

A ID de Registro de Canal para o Identificador de Negócios.
fileName

string

Nome opcional para o arquivo.
kind string:

document

O tipo discriminatório que descreve um tipo de notificação.
mediaUri

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

ImageNotificationContent

Uma solicitação para enviar uma notificação de imagem.

Nome Tipo Description
caption

string

Conteúdo de texto opcional.
channelRegistrationId

string

A ID de Registro de Canal para o Identificador de Negócios.
kind string:

image

O tipo discriminatório que descreve um tipo de notificação.
mediaUri

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

MediaNotificationContent

@deprecated uma solicitação para enviar uma notificação de imagem.

Nome Tipo Description
channelRegistrationId

string

A ID de Registro de Canal para o Identificador de Negócios.
content

string

Conteúdo de texto opcional.
kind string:

image_v0

O tipo discriminatório que descreve um tipo de notificação.
mediaUri

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

MessageReceipt

Recebimento da mensagem de envio.

Nome Tipo Description
messageId

string

A ID da mensagem.
to

string

O identificador de usuário da plataforma externa nativa do destinatário.

MessageTemplate

O objeto de modelo usado para criar modelos.

Nome Tipo Description
bindings MessageTemplateBindings:

WhatsAppMessageTemplateBindings

O objeto de associação para vincular valores aos locais específicos do modelo
language

string

O idioma do modelo, no formato ISO 639, consiste em um código de idioma de duas letras seguido por um código de país de duas letras opcional, por exemplo, 'en' ou 'en_US'.
name

string

Nome do modelo.
values MessageTemplateValue[]:

Os valores do modelo.

MessageTemplateBindingsKind

O tipo do modelo de mensagem.

Nome Tipo Description
whatsApp

string

O tipo de modelo do WhatsApp.

MessageTemplateDocument

As informações de valor do documento do modelo de mensagem.

Nome Tipo Description
caption

string

A legenda [opcional] do objeto de mídia.
fileName

string

O nome de arquivo [opcional] do arquivo de mídia.
kind string:

document

O tipo discriminatório que descreve um tipo de parâmetro de modelo.
name

string

Nome de referência de associação de modelo
url

string

A URL (pública) da mídia.

MessageTemplateImage

As informações de valor de imagem do modelo de mensagem.

Nome Tipo Description
caption

string

A legenda [opcional] do objeto de mídia.
fileName

string

O nome de arquivo [opcional] do arquivo de mídia.
kind string:

image

O tipo discriminatório que descreve um tipo de parâmetro de modelo.
name

string

Nome de referência de associação de modelo
url

string

A URL (pública) da mídia.

MessageTemplateLocation

Informações de valor de localização do modelo de mensagem.

Nome Tipo Description
address

string

O endereço [opcional] do local.
kind string:

location

O tipo discriminatório que descreve um tipo de parâmetro de modelo.
latitude

number

A latitude do local.
locationName

string

O nome [opcional] do local.
longitude

number

A longitude do local.
name

string

Nome de referência de associação de modelo

MessageTemplateQuickAction

Informações de valor de ação rápida do modelo de mensagem.

Nome Tipo Description
kind string:

quickAction

O tipo discriminatório que descreve um tipo de parâmetro de modelo.
name

string

Nome de referência de associação de modelo
payload

string

O conteúdo da ação rápida [opcional]
text

string

O texto de ação rápida [opcional]

MessageTemplateText

As informações de valor de texto do modelo de mensagem.

Nome Tipo Description
kind string:

text

O tipo discriminatório que descreve um tipo de parâmetro de modelo.
name

string

Nome de referência de associação de modelo
text

string

O valor do texto.

MessageTemplateValueKind

O tipo do parâmetro de modelo.

Nome Tipo Description
document

string

O tipo de parâmetro de modelo de documento.
image

string

O tipo de parâmetro de modelo de imagem.
location

string

O tipo de parâmetro de modelo de local.
quickAction

string

O tipo de parâmetro de modelo de ação rápida.
text

string

O tipo de parâmetro de modelo de texto.
video

string

O tipo de parâmetro de modelo de vídeo.

MessageTemplateVideo

As informações de valor de vídeo do modelo de mensagem.

Nome Tipo Description
caption

string

A legenda [opcional] do objeto de mídia.
fileName

string

O nome de arquivo [opcional] do arquivo de mídia.
kind string:

video

O tipo discriminatório que descreve um tipo de parâmetro de modelo.
name

string

Nome de referência de associação de modelo
url

string

A URL (pública) da mídia.

SendMessageResult

Resultado da operação de envio de mensagem.

Nome Tipo Description
receipts

MessageReceipt[]

Recibos da operação de envio de mensagens.

TemplateNotificationContent

Uma solicitação para enviar uma notificação de modelo.

Nome Tipo Description
channelRegistrationId

string

A ID de Registro de Canal para o Identificador de Negócios.
kind string:

template

O tipo discriminatório que descreve um tipo de notificação.
template

MessageTemplate

O objeto de modelo usado para criar modelos.
to

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

TextNotificationContent

Uma solicitação para enviar uma notificação de texto.

Nome Tipo Description
channelRegistrationId

string

A ID de Registro de Canal para o Identificador de Negócios.
content

string

Conteúdo da mensagem.
kind string:

text

O tipo discriminatório que descreve um tipo de notificação.
to

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

VideoNotificationContent

Uma solicitação para enviar uma notificação por vídeo.

Nome Tipo Description
caption

string

Conteúdo de texto opcional.
channelRegistrationId

string

A ID de Registro de Canal para o Identificador de Negócios.
kind string:

video

O tipo discriminatório que descreve um tipo de notificação.
mediaUri

string

Uma URL de mídia para o arquivo. Obrigatório se o tipo for um dos tipos de mídia com suporte, por exemplo, imagem
to

string[]

Os identificadores de usuário da plataforma externa nativa do destinatário.

WhatsAppMessageButtonSubType

O subtipo do botão WhatsApp.

Nome Tipo Description
quickReply

string

O subtipo do botão WhatsApp é uma resposta rápida.
url

string

O subtipo do botão WhatsApp é url.

WhatsAppMessageTemplateBindings

As associações de modelo para WhatsApp

Nome Tipo Description
body

WhatsAppMessageTemplateBindingsComponent[]

As associações de modelo de corpo
buttons

WhatsAppMessageTemplateBindingsButton[]

As associações de modelo de botão
footer

WhatsAppMessageTemplateBindingsComponent[]

As associações de modelo de rodapé
header

WhatsAppMessageTemplateBindingsComponent[]

As associações de modelo de cabeçalho
kind string:

whatsApp

O tipo discriminatório que descreve um tipo de associações de modelo.

WhatsAppMessageTemplateBindingsButton

O botão de componente de associações de modelo para WhatsApp

Nome Tipo Description
refValue

string

O nome do item referenciado nos valores de modelo.
subType

WhatsAppMessageButtonSubType

O subtipo do botão WhatsApp

WhatsAppMessageTemplateBindingsComponent

O componente de associações de modelo para WhatsApp

Nome Tipo Description
refValue

string

O nome do item referenciado nos valores de modelo.