Chat Thread - Get Chat Message

Referencia

Servicio:: Communication

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

Obtiene un mensaje por identificador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
chatMessageId	path	True	string	Identificador del mensaje.
chatThreadId	path	True	string	Identificador de subproceso al que se envió 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).

Respuestas

Nombre	Tipo	Description
200 OK	ChatMessage	Solicitud correcta. La acción devuelve un recurso `Message`.
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

Get Message

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "id": "1591768249318",
  "sequenceId": "1",
  "type": "text",
  "version": "1599016601134",
  "content": {
    "message": "Let's head out for lunch in 15 minutes."
  },
  "senderDisplayName": "Jane",
  "createdOn": "2020-06-10T05:50:49.3180000Z",
  "senderCommunicationIdentifier": {
    "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
    "communicationUser": {
      "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
    }
  },
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

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
ChatAttachment	Datos adjuntos en un mensaje de chat.
ChatAttachmentType	Tipo de datos adjuntos.
ChatMessage	Mensaje de chat.
ChatMessageContent	Contenido de un mensaje de chat.
ChatMessageType	Tipo de mensaje de chat.
ChatParticipant	Participante del subproceso de chat.

ChatAttachment

Datos adjuntos en un mensaje de chat.

Nombre	Tipo	Description
attachmentType	ChatAttachmentType	Tipo de datos adjuntos.
id	string	Identificador de los datos adjuntos
name	string	Nombre del contenido adjunto.
previewUrl	string	Dirección URL donde se puede descargar la vista previa de los datos adjuntos
url	string	Dirección URL donde se pueden descargar los datos adjuntos

ChatAttachmentType

Tipo de datos adjuntos.

Nombre	Tipo	Description
file	string
image	string

ChatMessage

Mensaje de chat.

Nombre	Tipo	Description
content	ChatMessageContent	Contenido de un mensaje de chat.
createdOn	string	Marca de tiempo cuando el mensaje de chat llegó al servidor. La marca de tiempo está en formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Marca de tiempo (si procede) cuando se eliminó el mensaje. La marca de tiempo está en formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	La última marca de tiempo (si procede) cuando se editó el mensaje. La marca de tiempo está en formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	Identificador del mensaje de chat. Este identificador es el servidor generado.
metadata	object	Metadatos del mensaje.
senderCommunicationIdentifier	CommunicationIdentifierModel
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.
sequenceId	string	Secuencia del mensaje de chat en la conversación.
type	ChatMessageType	Tipo de mensaje de chat.
version	string	Versión del mensaje de chat.

ChatMessageContent

Contenido de un mensaje de chat.

Nombre	Tipo	Description
attachments	ChatAttachment[]	Lista de datos adjuntos para este mensaje
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Contenido del mensaje de chat para mensajes de tipos de texto o html.
participants	ChatParticipant[]	Contenido del mensaje de chat para mensajes de tipos participantesAdded o participantRemoved.
topic	string	Contenido del mensaje de chat para mensajes de tipo topicUpdated.

ChatMessageType

Tipo de mensaje de chat.

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

ChatParticipant

Participante del subproceso de chat.

Nombre	Tipo	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nombre para mostrar del participante del chat.
shareHistoryTime	string	Hora desde la que se comparte el historial de chat con el participante. La marca de tiempo está en formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Compartir a través de