Conversation Thread Operations - Send Message

Referencia

Servicio:: Communication

Versión de la API:: 2025-04-01-preview

Envía un mensaje de conversación de Business a User.

POST {endpoint}/messages/conversations/{conversationId}/messages:send?api-version=2025-04-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
conversationId	path	True	string	Identificador de conversación.
endpoint	path	True	string (uri)	Recurso de comunicación, por ejemplo, https://my-resource.communication.azure.com
api-version	query	True	string minLength: 1	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

Nombre	Requerido	Tipo	Description
request	True	ConversationMessageContent: AudioConversationMessageContent DocumentConversationMessageContent ImageConversationMessageContent TemplateConversationMessageContent TextConversationMessageContent VideoConversationMessageContent	Detalles de una solicitud de mensaje de conversación de envío.
outboundDeliveryStrategy		OutboundDeliveryStrategyKind	Las opciones de la estrategia de entrega saliente para los mensajes enviados por los participantes en una conversación. Admite internalOnly, allChannels.

Respuestas

Nombre	Tipo	Description
200 OK	SendConversationMessageResult	La solicitud se ha realizado correctamente. Encabezados Repeatability-Result: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

SendConversationMessageResult

La solicitud se ha realizado correctamente.

Encabezados

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

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una 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 conversation message from Business to User

Solicitud de ejemplo

HTTP

POST https://my-resource.communication.azure.com/messages/conversations/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/messages:send?api-version=2025-04-01-preview

{
  "request": {
    "kind": "text",
    "content": "I need help"
  },
  "outboundDeliveryStrategy": "allParticipants"
}

Respuesta de muestra

status code:: 200

{
  "messageId": "1593107077690"
}

Definiciones

Nombre	Description
AudioConversationMessageContent	Solicitud para enviar un mensaje de conversación de audio.
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	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/azure/Guidelines.md#handling-errors.
CommunicationMessageKind	Tipo de mensaje.
DocumentConversationMessageContent	Solicitud para enviar un mensaje de conversación de documento.
ImageConversationMessageContent	Solicitud para enviar un mensaje de conversación de imagen.
MessageTemplate	Objeto de plantilla usado 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 de 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 de valor de vídeo de la plantilla de mensaje.
OutboundDeliveryStrategyKind	Las opciones de la estrategia de entrega saliente para los mensajes enviados por los participantes en una conversación.
SendConversationMessageOptions	Solicitar carga para enviar un mensaje de conversación.
SendConversationMessageResult	Resultado de la operación enviar mensaje de conversación.
TemplateConversationMessageContent	Solicitud para enviar un mensaje de conversación de plantilla.
TextConversationMessageContent	Solicitud para enviar un mensaje de conversación de texto.
VideoConversationMessageContent	Solicitud para enviar un mensaje de conversación de vídeo.
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

AudioConversationMessageContent

Object

Solicitud para enviar un mensaje de conversación de audio.

Nombre	Tipo	Description
kind	string: audio	El discriminador de tipo que describe un tipo de mensaje.
mediaUri	string (uri)	Dirección URL multimedia del archivo. Obligatorio si el tipo es uno de los tipos de medios admitidos, por ejemplo, imagen

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
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

Object

Respuesta que contiene los detalles del error.

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

Azure.Core.Foundations.InnerError

Object

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/azure/Guidelines.md#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

CommunicationMessageKind

Enumeración

Tipo de mensaje.

Valor	Description
audio	Tipo de mensaje de audio.
document	Tipo de mensaje de documento.
image	Tipo de mensaje de imagen.
image_v0	Tipo de mensaje de imagen. Tipo de imagen heredado para `MediaNotificationContent` que está en desuso
interactive	Tipo de mensaje accionable interactivo.
reaction	Tipo de mensaje de reacción.
sticker	Tipo de mensaje de pegatina.
template	Tipo de mensaje de plantilla.
text	Tipo de mensaje de texto.
video	Tipo de mensaje de vídeo.

DocumentConversationMessageContent

Object

Solicitud para enviar un mensaje de conversación de documento.

Nombre	Tipo	Description
caption	string	Contenido de texto opcional.
fileName	string	Nombre opcional para el archivo.
kind	string: document	El discriminador de tipo que describe un tipo de mensaje.
mediaUri	string (uri)	Dirección URL multimedia del archivo. Obligatorio si el tipo es uno de los tipos de medios admitidos, por ejemplo, imagen

ImageConversationMessageContent

Object

Solicitud para enviar un mensaje de conversación de imagen.

Nombre	Tipo	Description
caption	string	Contenido de texto opcional.
kind	string: image	El discriminador de tipo que describe un tipo de mensaje.
mediaUri	string (uri)	Dirección URL multimedia del archivo. Obligatorio si el tipo es uno de los tipos de medios admitidos, por ejemplo, imagen

MessageTemplate

Object

Objeto de plantilla usado 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

Enumeración

Tipo de la plantilla de mensaje.

Valor	Description
whatsApp	Tipo de plantilla WhatsApp.

MessageTemplateDocument

Object

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

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

MessageTemplateImage

Object

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

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

MessageTemplateLocation

Object

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 tipo que describe un tipo de parámetro de plantilla.
latitude	number (double)	Latitud de la ubicación.
locationName	string	Nombre [Opcional] de la ubicación.
longitude	number (double)	Longitud de la ubicación.
name	string	Nombre de referencia de enlace de plantilla

MessageTemplateQuickAction

Object

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

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

MessageTemplateText

Object

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

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

MessageTemplateValueKind

Enumeración

Tipo del parámetro de plantilla.

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

MessageTemplateVideo

Object

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

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

OutboundDeliveryStrategyKind

Enumeración

Las opciones de la estrategia de entrega saliente para los mensajes enviados por los participantes en una conversación.

Valor	Description
allParticipants	Estrategia de entrega para todos los participantes.
internalOnly	Estrategia de entrega solo para internamente.

SendConversationMessageOptions

Object

Solicitar carga para enviar un mensaje de conversación.

Nombre	Tipo	Description
outboundDeliveryStrategy	OutboundDeliveryStrategyKind	Las opciones de la estrategia de entrega saliente para los mensajes enviados por los participantes en una conversación. Admite internalOnly, allChannels.
request	ConversationMessageContent: AudioConversationMessageContent DocumentConversationMessageContent ImageConversationMessageContent TemplateConversationMessageContent TextConversationMessageContent VideoConversationMessageContent	Detalles de una solicitud de mensaje de conversación de envío.

SendConversationMessageResult

Object

Resultado de la operación enviar mensaje de conversación.

Nombre	Tipo	Description
messageId	string	Identificador de mensaje de conversación de mensajería avanzada generado por el servidor.

TemplateConversationMessageContent

Object

Solicitud para enviar un mensaje de conversación de plantilla.

Nombre	Tipo	Description
kind	string: template	El discriminador de tipo que describe un tipo de mensaje.
template	MessageTemplate	Objeto de plantilla usado para crear plantillas.

TextConversationMessageContent

Object

Solicitud para enviar un mensaje de conversación de texto.

Nombre	Tipo	Description
content	string	Contenido del mensaje.
kind	string: text	El discriminador de tipo que describe un tipo de mensaje.

VideoConversationMessageContent

Object

Solicitud para enviar un mensaje de conversación de vídeo.

Nombre	Tipo	Description
caption	string	Contenido de texto opcional.
kind	string: video	El discriminador de tipo que describe un tipo de mensaje.
mediaUri	string (uri)	Dirección URL multimedia del archivo. Obligatorio si el tipo es uno de los tipos de medios admitidos, por ejemplo, imagen

WhatsAppMessageButtonSubType

Enumeración

Subtipo del botón WhatsApp.

Valor	Description
quickReply	El subtipo del botón WhatsApp es respuesta rápida.
url	El subtipo del botón WhatsApp es url.

WhatsAppMessageTemplateBindings

Object

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 tipo que describe un tipo de enlace de plantilla.

WhatsAppMessageTemplateBindingsButton

Object

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

Object

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

Conversation Thread Operations - Send Message

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

AadOauth2Auth

Ámbitos

Authorization

Ejemplos

Sends a conversation message from Business to User

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AudioConversationMessageContent

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CommunicationMessageKind

DocumentConversationMessageContent

ImageConversationMessageContent

MessageTemplate

MessageTemplateBindingsKind

MessageTemplateDocument

MessageTemplateImage

MessageTemplateLocation

MessageTemplateQuickAction

MessageTemplateText

MessageTemplateValueKind

MessageTemplateVideo

OutboundDeliveryStrategyKind

SendConversationMessageOptions

SendConversationMessageResult

TemplateConversationMessageContent

TextConversationMessageContent

VideoConversationMessageContent

WhatsAppMessageButtonSubType

WhatsAppMessageTemplateBindings

WhatsAppMessageTemplateBindingsButton

WhatsAppMessageTemplateBindingsComponent