Notification Messages Operations - Send

Referencia

Servicio:: Communication

Versión de la API:: 2024-02-01

Envía un mensaje de notificación de Empresa a Usuario.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string uri	El recurso de comunicación, por ejemplo. https://my-resource.communication.azure.com
api-version	query	True	string	Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre	Tipo	Description
Repeatability-Request-ID	string	Identificador de cadena globalmente único y generado por el cliente para la solicitud.
Repeatability-First-Sent	string date-time	Especifica la fecha y hora en que se creó la solicitud por primera vez.
x-ms-client-request-id	string uuid	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre	Description
MediaNotificationContent	Una solicitud para enviar una notificación multimedia.
TemplateNotificationContent	Una solicitud para enviar una notificación de plantilla.
TextNotificationContent	Una solicitud para enviar una notificación de texto.

MediaNotificationContent

Una solicitud para enviar una notificación multimedia.

Nombre	Requerido	Tipo	Description
channelRegistrationId	True	string	Identificador de registro de canal para el identificador de negocio.
kind	True	string: image	Discriminador de tipos que describe un tipo de notificación.
mediaUri	True	string	Dirección URL multimedia del archivo. Obligatorio si el tipo es uno de los tipos de medios admitidos, por ejemplo, imagen
to	True	string[]	Identificadores de usuario nativos de la plataforma externa del destinatario.
content		string	Contenido de texto opcional.

TemplateNotificationContent

Una solicitud para enviar una notificación de plantilla.

Nombre	Requerido	Tipo	Description
channelRegistrationId	True	string	Identificador de registro de canal para el identificador de negocio.
kind	True	string: template	Discriminador de tipos que describe un tipo de notificación.
template	True	MessageTemplate	Objeto de plantilla utilizado para crear plantillas.
to	True	string[]	Identificadores de usuario nativos de la plataforma externa del destinatario.

TextNotificationContent

Una solicitud para enviar una notificación de texto.

Nombre	Requerido	Tipo	Description
channelRegistrationId	True	string	Identificador de registro de canal para el identificador de negocio.
content	True	string	Contenido del mensaje.
kind	True	string: text	Discriminador de tipos que describe un tipo de notificación.
to	True	string[]	Identificadores de usuario nativos de la plataforma externa del destinatario.

Respuestas

Nombre	Tipo	Description
202 Accepted	SendMessageResult	La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Repeatability-Result: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

202 Accepted

SendMessageResult

La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Encabezados

Repeatability-Result: string
x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Authorization

Tipo: apiKey
En: header

Ejemplos

Sends a notification message - image

Sends a notification message - Template

Sends a notification message - text

Sends a notification message - image

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 202

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

Sends a notification message - Template

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 202

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

Sends a notification message - text

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 202

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

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Una respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessageKind	El tipo de mensaje. Admite texto, imagen, plantilla.
MediaNotificationContent	Una solicitud para enviar una notificación multimedia.
MessageReceipt	Recepción del envío de un mensaje.
MessageTemplate	Objeto de plantilla utilizado para crear plantillas.
MessageTemplateBindingsKind	Tipo de la plantilla de mensaje.
MessageTemplateDocument	Información del valor del documento de la plantilla de mensaje.
MessageTemplateImage	Información del valor de imagen de la plantilla de mensaje.
MessageTemplateLocation	Información del valor de ubicación de la plantilla de mensaje.
MessageTemplateQuickAction	Información de valor de acción rápida de la plantilla de mensaje.
MessageTemplateText	Información del valor de texto de la plantilla de mensaje.
MessageTemplateValueKind	Tipo del parámetro de plantilla.
MessageTemplateVideo	Información del valor de vídeo de la plantilla de mensaje.
SendMessageResult	Resultado de la operación de envío de mensajes.
TemplateNotificationContent	Una solicitud para enviar una notificación de plantilla.
TextNotificationContent	Una solicitud para enviar una notificación de texto.
WhatsAppMessageButtonSubType	Subtipo del botón WhatsApp.
WhatsAppMessageTemplateBindings	Enlaces de plantilla para WhatsApp
WhatsAppMessageTemplateBindingsButton	Botón del componente enlaces de plantilla para WhatsApp
WhatsAppMessageTemplateBindingsComponent	Componente de enlaces de plantilla para WhatsApp

Azure.Core.Foundations.Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Una respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
innererror	Azure.Core.Foundations.InnerError	Error interno.

CommunicationMessageKind

El tipo de mensaje. Admite texto, imagen, plantilla.

Nombre	Tipo	Description
image	string	Tipo de mensaje de imagen.
template	string	Tipo de mensaje de plantilla.
text	string	Tipo de mensaje de texto.

MediaNotificationContent

Una solicitud para enviar una notificación multimedia.

Nombre	Tipo	Description
channelRegistrationId	string	Identificador de registro de canal para el identificador de negocio.
content	string	Contenido de texto opcional.
kind	string: image	Discriminador de tipos que describe un tipo de notificación.
mediaUri	string	Dirección URL multimedia del archivo. Obligatorio si el tipo es uno de los tipos de medios admitidos, por ejemplo, imagen
to	string[]	Identificadores de usuario nativos de la plataforma externa del destinatario.

MessageReceipt

Recepción del envío de un mensaje.

Nombre	Tipo	Description
messageId	string	Identificador del mensaje.
to	string	Identificador de usuario de plataforma externa nativa del destinatario.

MessageTemplate

Objeto de plantilla utilizado para crear plantillas.

Nombre	Tipo	Description
bindings	MessageTemplateBindings: WhatsAppMessageTemplateBindings	Objeto de enlace para vincular valores a las ubicaciones específicas de la plantilla
language	string	El idioma de la plantilla, en el formato ISO 639, consta de un código de idioma de dos letras seguido de un código de país opcional de dos letras, por ejemplo, "en" o "en_US".
name	string	Nombre de la plantilla.
values	MessageTemplateValue[]: MessageTemplateDocument[] MessageTemplateImage[] MessageTemplateLocation[] MessageTemplateQuickAction[] MessageTemplateText[] MessageTemplateVideo[]	Valores de plantilla.

MessageTemplateBindingsKind

Tipo de la plantilla de mensaje.

Nombre	Tipo	Description
whatsApp	string	Tipo de plantilla whatsApp.

MessageTemplateDocument

Información del valor del documento de la plantilla de mensaje.

Nombre	Tipo	Description
caption	string	El subtítulo [opcional] del objeto multimedia.
fileName	string	El nombre de archivo [opcional] del archivo multimedia.
kind	string: document	El discriminador de tipos que describe un tipo de parámetro de plantilla.
name	string	Nombre de referencia del enlace de plantilla
url	string	Dirección URL (pública) del medio.

MessageTemplateImage

Información del valor de imagen de la plantilla de mensaje.

Nombre	Tipo	Description
caption	string	El subtítulo [opcional] del objeto multimedia.
fileName	string	El nombre de archivo [opcional] del archivo multimedia.
kind	string: image	El discriminador de tipos que describe un tipo de parámetro de plantilla.
name	string	Nombre de referencia del enlace de plantilla
url	string	Dirección URL (pública) del medio.

MessageTemplateLocation

Información del valor de ubicación de la plantilla de mensaje.

Nombre	Tipo	Description
address	string	Dirección [Opcional] de la ubicación.
kind	string: location	El discriminador de tipos que describe un tipo de parámetro de plantilla.
latitude	number	Latitud de la ubicación.
locationName	string	Nombre [Opcional] de la ubicación.
longitude	number	Longitud de la ubicación.
name	string	Nombre de referencia del enlace de plantilla

MessageTemplateQuickAction

Información de valor de acción rápida de la plantilla de mensaje.

Nombre	Tipo	Description
kind	string: quickAction	El discriminador de tipos que describe un tipo de parámetro de plantilla.
name	string	Nombre de referencia del enlace de plantilla
payload	string	Carga de acción rápida [Opcional]
text	string	Texto de acción rápida [Opcional]

MessageTemplateText

Información del valor de texto de la plantilla de mensaje.

Nombre	Tipo	Description
kind	string: text	El discriminador de tipos que describe un tipo de parámetro de plantilla.
name	string	Nombre de referencia del enlace de plantilla
text	string	Valor de texto.

MessageTemplateValueKind

Tipo del parámetro de plantilla.

Nombre	Tipo	Description
document	string	Tipo de parámetro de plantilla de documento.
image	string	Tipo de parámetro de plantilla de imagen.
location	string	Tipo de parámetro de plantilla de ubicación.
quickAction	string	Tipo de parámetro de plantilla de acción rápida.
text	string	Tipo de parámetro de plantilla de texto.
video	string	Tipo de parámetro de plantilla de vídeo.

MessageTemplateVideo

Información del valor de vídeo de la plantilla de mensaje.

Nombre	Tipo	Description
caption	string	El subtítulo [opcional] del objeto multimedia.
fileName	string	El nombre de archivo [opcional] del archivo multimedia.
kind	string: video	El discriminador de tipos que describe un tipo de parámetro de plantilla.
name	string	Nombre de referencia del enlace de plantilla
url	string	Dirección URL (pública) del medio.

SendMessageResult

Resultado de la operación de envío de mensajes.

Nombre	Tipo	Description
receipts	MessageReceipt[]	Recibos de la operación de envío de mensajes.

TemplateNotificationContent

Una solicitud para enviar una notificación de plantilla.

Nombre	Tipo	Description
channelRegistrationId	string	Identificador de registro de canal para el identificador de negocio.
kind	string: template	Discriminador de tipos que describe un tipo de notificación.
template	MessageTemplate	Objeto de plantilla utilizado para crear plantillas.
to	string[]	Identificadores de usuario nativos de la plataforma externa del destinatario.

TextNotificationContent

Una solicitud para enviar una notificación de texto.

Nombre	Tipo	Description
channelRegistrationId	string	Identificador de registro de canal para el identificador de negocio.
content	string	Contenido del mensaje.
kind	string: text	Discriminador de tipos que describe un tipo de notificación.
to	string[]	Identificadores de usuario nativos de la plataforma externa del destinatario.

WhatsAppMessageButtonSubType

Subtipo del botón WhatsApp.

Nombre	Tipo	Description
quickReply	string	El subtipo del botón WhatsApp es una respuesta rápida.
url	string	El subtipo del botón WhatsApp es url.

WhatsAppMessageTemplateBindings

Enlaces de plantilla para WhatsApp

Nombre	Tipo	Description
body	WhatsAppMessageTemplateBindingsComponent[]	Enlaces de plantilla de cuerpo
buttons	WhatsAppMessageTemplateBindingsButton[]	Enlaces de plantilla de botón
footer	WhatsAppMessageTemplateBindingsComponent[]	Enlaces de plantilla de pie de página
header	WhatsAppMessageTemplateBindingsComponent[]	Enlaces de plantilla de encabezado
kind	string: whatsApp	El discriminador de tipos que describe un tipo de enlace de plantilla.

WhatsAppMessageTemplateBindingsButton

Botón del componente enlaces de plantilla para WhatsApp

Nombre	Tipo	Description
refValue	string	Nombre del elemento al que se hace referencia en los valores de plantilla.
subType	WhatsAppMessageButtonSubType	Subtipo del botón WhatsApp

WhatsAppMessageTemplateBindingsComponent

Componente de enlaces de plantilla para WhatsApp

Nombre	Tipo	Description
refValue	string	Nombre del elemento al que se hace referencia en los valores de plantilla.

Compartir a través de

Notification Messages Operations - Send

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

MediaNotificationContent

TemplateNotificationContent

TextNotificationContent

Respuestas

Seguridad

AadOauth2Auth

Ámbitos

Authorization

Ejemplos

Sends a notification message - image

Solicitud de ejemplo

Respuesta de muestra

Sends a notification message - Template

Solicitud de ejemplo

Respuesta de muestra

Sends a notification message - text

Solicitud de ejemplo

Respuesta de muestra

Definiciones

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

Recursos adicionales