Chat Thread - Get Chat Message

Referência

Serviço:: Communication

Versão da API:: 2024-03-07

Obtém uma mensagem por id.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
chatMessageId	path	True	string	O ID da mensagem.
chatThreadId	path	True	string	O ID do thread para o qual a mensagem foi enviada.
endpoint	path	True	string	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a invocar.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Respostas

Name	Tipo	Description
200 OK	ChatMessage	Pedido bem-sucedido. A ação retorna um recurso `Message`.
401 Unauthorized	CommunicationErrorResponse	Não autorizado.
403 Forbidden	CommunicationErrorResponse	Proibido.
429 Too Many Requests	CommunicationErrorResponse	Demasiados pedidos.
Other Status Codes	CommunicationErrorResponse	Serviço indisponível.

Segurança

Authorization

Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Tipo: apiKey
Em: header

Exemplos

Get Message

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 401

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

Código de estado:: 403

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

Código de estado:: 429

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

Código de estado:: 503

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

Definições

Name	Description
ChatAttachment	Um anexo numa mensagem de chat.
ChatAttachmentType	O tipo de anexo.
ChatMessage	Mensagem de chat.
ChatMessageContent	Conteúdo de uma mensagem de chat.
ChatMessageType	O tipo de mensagem de chat.
ChatParticipant	Um participante do tópico de bate-papo.

ChatAttachment

Um anexo numa mensagem de chat.

Name	Tipo	Description
attachmentType	ChatAttachmentType	O tipo de anexo.
id	string	ID do anexo
name	string	O nome do conteúdo do anexo.
previewUrl	string	O URL onde a pré-visualização do anexo pode ser transferida
url	string	O URL onde o anexo pode ser transferido

ChatAttachmentType

O tipo de anexo.

Name	Tipo	Description
file	string
image	string

ChatMessage

Mensagem de chat.

Name	Tipo	Description
content	ChatMessageContent	Conteúdo de uma mensagem de chat.
createdOn	string	O carimbo de data/hora quando a mensagem de chat chegou ao servidor. O carimbo de data/hora está no formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	O carimbo de data/hora (se aplicável) quando a mensagem foi excluída. O carimbo de data/hora está no formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	O último carimbo de data/hora (se aplicável) quando a mensagem foi editada. O carimbo de data/hora está no formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	O id da mensagem de chat. Este id é gerado pelo servidor.
metadata	object	Metadados da mensagem.
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	O nome para exibição do remetente da mensagem de chat. Essa propriedade é usada para preencher o nome do remetente para notificações por push.
sequenceId	string	Sequência da mensagem de chat na conversa.
type	ChatMessageType	O tipo de mensagem de chat.
version	string	Versão da mensagem de chat.

ChatMessageContent

Conteúdo de uma mensagem de chat.

Name	Tipo	Description
attachments	ChatAttachment[]	Lista de anexos para esta mensagem
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Conteúdo de mensagens de bate-papo para mensagens dos tipos texto ou html.
participants	ChatParticipant[]	Conteúdo da mensagem de chat para mensagens dos tipos participanteAdicionado ou participanteRemovido.
topic	string	Conteúdo da mensagem de chat para mensagens do tipo topicUpdated.

ChatMessageType

O tipo de mensagem de chat.

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

ChatParticipant

Um participante do tópico de bate-papo.

Name	Tipo	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nome de exibição para o participante do bate-papo.
shareHistoryTime	string	Hora a partir da qual o histórico do chat é partilhado com o participante. O carimbo de data/hora está no formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Partilhar via