Chat Thread - Send Chat Message

Referencia

Servicio:: Communication

Versión de la API:: 2024-03-07

Envía un mensaje a un subproceso.

POST {endpoint}/chat/threads/{chatThreadId}/messages?api-version=2024-03-07

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
chatThreadId	path	True	string	Identificador del subproceso al que se va a enviar el mensaje.
endpoint	path	True	string	Punto de conexión del recurso de Comunicación de Azure.
api-version	query	True	string	Versión de la API que se va a invocar.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Un token de acceso de usuario de ACS (Azure Communication Services).

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
content	True	string	Contenido del mensaje de chat.
metadata		object	Metadatos del mensaje.
senderDisplayName		string	Nombre para mostrar del remitente del mensaje de chat. Esta propiedad se usa para rellenar el nombre del remitente para las notificaciones push.
type		ChatMessageType	Tipo de mensaje de chat.

Respuestas

Nombre	Tipo	Description
201 Created	SendChatMessageResult	Mensaje enviado, el encabezado `Location` contiene la dirección URL del mensaje recién enviado.
401 Unauthorized	CommunicationErrorResponse	Desautorizado.
403 Forbidden	CommunicationErrorResponse	Prohibido.
429 Too Many Requests	CommunicationErrorResponse	Demasiadas solicitudes.
Other Status Codes	CommunicationErrorResponse	Servicio no disponible.

Seguridad

Authorization

Un token de acceso de usuario de ACS (Azure Communication Services).

Tipo: apiKey
En: header

Ejemplos

Send Message

Solicitud de ejemplo

HTTP

POST https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages?api-version=2024-03-07

{
  "content": "Let's head out for lunch in 15 minutes.",
  "senderDisplayName": "Jane",
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

Respuesta de muestra

status code:: 201

Location: https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708

{
  "id": "1593072104708"
}

status code:: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

status code:: 403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

status code:: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

status code:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definiciones

Nombre	Description
ChatMessageType	Tipo de mensaje de chat.
SendChatMessageRequest	Detalles del mensaje que se va a enviar.
SendChatMessageResult	Resultado de la operación de envío de mensajes.

ChatMessageType

Tipo de mensaje de chat.

Nombre	Tipo	Description
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

SendChatMessageRequest

Detalles del mensaje que se va a enviar.

Nombre	Tipo	Description
content	string	Contenido del mensaje de chat.
metadata	object	Metadatos del mensaje.
senderDisplayName	string	Nombre para mostrar del remitente del mensaje de chat. Esta propiedad se usa para rellenar el nombre del remitente para las notificaciones push.
type	ChatMessageType	Tipo de mensaje de chat.

SendChatMessageResult

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

Nombre	Tipo	Description
id	string	Identificador de mensaje generado por el servidor.

Compartir a través de