Notification Messages - Send Message

Serviço:

Communication

Versão da API:

2023-08-24-preview

POST {endpoint}/messages/notifications/:send?api-version=2023-08-24-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (url)	O recurso de comunicação, por exemplo, https://my-resource.communication.azure.com
api-version	query	True	string	Versão da API a ser invocada.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
channelRegistrationId	True	string	A ID de Registro de Canal para o Identificador de Negócios.
to	True	string[]	Os identificadores de usuário da plataforma externa nativa do destinatário.
type	True	CommunicationMessageType	O tipo de mensagem. Dá suporte a texto, imagem, modelo.
content		string	Conteúdo da mensagem.
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
template		MessageTemplate	O objeto de modelo usado para criar modelos.

Respostas

Nome	Tipo	Description
202 Accepted	SendMessageResult	Aceitado
Other Status Codes	CommunicationErrorResponse	Resposta de erro de comunicação

Exemplos

Send a notification message

Solicitação de exemplo

HTTP

POST https://my-resource.communication.azure.com/messages/notifications/:send?api-version=2023-08-24-preview

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "type": "text",
  "content": "Text message through CPM"
}

Resposta de exemplo

Código de status:

202

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

Definições

Nome	Description
CommunicationMessageType	O tipo de mensagem. Dá suporte a texto, imagem, modelo.
MessageReceipt	Recebimento da mensagem de envio.
MessageTemplate	O objeto de modelo usado para criar modelos.
MessageTemplateBindings	O objeto de associação para vincular valores aos locais específicos do modelo
MessageTemplateBindingsWhatsApp	As associações de modelo para WhatsApp
MessageTemplateBindingsWhatsAppButton	O botão de componente de associações de modelo para WhatsApp
MessageTemplateBindingsWhatsAppComponent	O componente de associações de modelo para WhatsApp
MessageTemplateParameterLocation	Informações de valor de localização do modelo de mensagem.
MessageTemplateValue	A classe descreve um parâmetro de um modelo.
MessageTemplateValueKind	O tipo de valor de modelo.
MessageTemplateValueMedia	As informações de valor de mídia do modelo de mensagem. Pode ser uma imagem, documento ou vídeo.
MessageTemplateValueQuickAction	Informações de valor de ação rápida do modelo de mensagem.
MessageTemplateValueText	As informações de valor de texto do modelo de mensagem.
MessageTemplateValueWhatsAppSubType	O subtipo do botão WhatsApp
SendMessageResult	Resultado da operação de envio de mensagem.
SendNotificationRequest	Detalhes da mensagem a ser enviada.

CommunicationMessageType

Enumeração

O tipo de mensagem. Dá suporte a texto, imagem, modelo.

Valor	Description
text
image
template

MessageReceipt

Objeto

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

Objeto

O objeto de modelo usado para criar modelos.

Nome	Tipo	Description
bindings	MessageTemplateBindings	O objeto de associação para vincular valores aos locais específicos do modelo
language	string	Os códigos dos idiomas com suporte para modelos.
name	string	Nome do modelo.
values	<string,  MessageTemplateValue>	Os valores do modelo.

MessageTemplateBindings

Objeto

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

Nome	Tipo	Description
whatsApp	MessageTemplateBindingsWhatsApp	As associações de modelo para WhatsApp

MessageTemplateBindingsWhatsApp

Objeto

As associações de modelo para WhatsApp

Nome	Tipo	Description
body	MessageTemplateBindingsWhatsAppComponent[]	O componente de associações de modelo para WhatsApp
button	MessageTemplateBindingsWhatsAppButton[]	O botão de componente de associações de modelo para WhatsApp
footer	MessageTemplateBindingsWhatsAppComponent[]	O componente de associações de modelo para WhatsApp
header	MessageTemplateBindingsWhatsAppComponent[]	O componente de associações de modelo para WhatsApp

MessageTemplateBindingsWhatsAppButton

Objeto

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

Nome	Tipo	Description
refValue	string	A referência ao valor no dicionário Microsoft.Azure.Communication.CrossPlatformMessages.Contract.Model.Notifications.V1.Requests.MessageTemplate.Values.
subType	MessageTemplateValueWhatsAppSubType	O subtipo do botão WhatsApp

MessageTemplateBindingsWhatsAppComponent

Objeto

O componente de associações de modelo para WhatsApp

Nome	Tipo	Description
refValue	string	A referência ao valor no dicionário Microsoft.Azure.Communication.CrossPlatformMessages.Contract.Model.Notifications.V1.Requests.MessageTemplate.Values.

MessageTemplateParameterLocation

Objeto

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

Nome	Tipo	Description
address	string	O endereço [opcional] do local.
latitude	number (double)	A latitude do local.
longitude	number (double)	A longitude do local.
name	string	O nome [opcional] do local.

MessageTemplateValue

Objeto

A classe descreve um parâmetro de um modelo.

Nome	Tipo	Description
document	MessageTemplateValueMedia	As informações de valor de mídia do modelo de mensagem. Pode ser uma imagem, documento ou vídeo.
image	MessageTemplateValueMedia	As informações de valor de mídia do modelo de mensagem. Pode ser uma imagem, documento ou vídeo.
kind	MessageTemplateValueKind	O tipo de valor de modelo.
location	MessageTemplateParameterLocation	Informações de valor de localização do modelo de mensagem.
quickAction	MessageTemplateValueQuickAction	Informações de valor de ação rápida do modelo de mensagem.
text	MessageTemplateValueText	As informações de valor de texto do modelo de mensagem.
video	MessageTemplateValueMedia	As informações de valor de mídia do modelo de mensagem. Pode ser uma imagem, documento ou vídeo.

MessageTemplateValueKind

Enumeração

O tipo de valor de modelo.

Valor	Description
text
image
document
video
location
quick_action

MessageTemplateValueMedia

Objeto

As informações de valor de mídia do modelo de mensagem. Pode ser uma imagem, documento ou vídeo.

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.
url	string (uri)	A URL (pública) da mídia.

MessageTemplateValueQuickAction

Objeto

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

Nome	Tipo	Description
payload	string	O conteúdo da ação rápida [opcional]
text	string	O texto de ação rápida [opcional]

MessageTemplateValueText

Objeto

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

Nome	Tipo	Description
text	string	O valor do texto.

MessageTemplateValueWhatsAppSubType

Enumeração

O subtipo do botão WhatsApp

Valor	Description
quickReply
url

SendMessageResult

Objeto

Resultado da operação de envio de mensagem.

Nome	Tipo	Description
receipts	MessageReceipt[]	Recibos da operação de envio de mensagens.

SendNotificationRequest

Objeto

Detalhes da mensagem a ser enviada.

Nome	Tipo	Description
channelRegistrationId	string	A ID de Registro de Canal para o Identificador de Negócios.
content	string	Conteúdo da mensagem.
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
template	MessageTemplate	O objeto de modelo usado para criar modelos.
to	string[]	Os identificadores de usuário da plataforma externa nativa do destinatário.
type	CommunicationMessageType	O tipo de mensagem. Dá suporte a texto, imagem, modelo.