Chat Thread - Get Chat Message

Riferimento

Servizio:: Communication

Versione API:: 2024-03-07

Ottiene un messaggio in base all'ID.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
chatMessageId	path	True	string	ID del messaggio.
chatThreadId	path	True	string	ID del thread a cui è stato inviato il messaggio.
endpoint	path	True	string	Endpoint della risorsa di comunicazione di Azure.
api-version	query	True	string	Versione dell'API da richiamare.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Un token di accesso utente ACS (Servizi di comunicazione di Azure).

Risposte

Nome	Tipo	Descrizione
200 OK	ChatMessage	Richiesta riuscita. L'azione restituisce una risorsa `Message`.
401 Unauthorized	CommunicationErrorResponse	Non autorizzato.
403 Forbidden	CommunicationErrorResponse	Vietato.
429 Too Many Requests	CommunicationErrorResponse	Troppe richieste.
Other Status Codes	CommunicationErrorResponse	Servizio non disponibile.

Sicurezza

Authorization

Un token di accesso utente ACS (Servizi di comunicazione di Azure).

Tipo: apiKey
In: header

Esempio

Get Message

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: 401

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

Codice di stato:: 403

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

Codice di stato:: 429

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

Codice di stato:: 503

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

Definizioni

Nome	Descrizione
ChatAttachment	Allegato in un messaggio di chat.
ChatAttachmentType	Tipo di allegato.
ChatMessage	Messaggio di chat.
ChatMessageContent	Contenuto di un messaggio di chat.
ChatMessageType	Tipo di messaggio di chat.
ChatParticipant	Partecipante del thread di chat.

ChatAttachment

Allegato in un messaggio di chat.

Nome	Tipo	Descrizione
attachmentType	ChatAttachmentType	Tipo di allegato.
id	string	ID dell'allegato
name	string	Nome del contenuto dell'allegato.
previewUrl	string	URL in cui è possibile scaricare l'anteprima dell'allegato
url	string	URL in cui è possibile scaricare l'allegato

ChatAttachmentType

Tipo di allegato.

Nome	Tipo	Descrizione
file	string
image	string

ChatMessage

Messaggio di chat.

Nome	Tipo	Descrizione
content	ChatMessageContent	Contenuto di un messaggio di chat.
createdOn	string	Timestamp quando il messaggio di chat è arrivato nel server. Il timestamp è in formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Timestamp (se applicabile) quando il messaggio è stato eliminato. Il timestamp è in formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	L'ultimo timestamp (se applicabile) quando il messaggio è stato modificato. Il timestamp è in formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	ID del messaggio di chat. Questo ID è generato dal server.
metadata	object	Metadati del messaggio.
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	Nome visualizzato del mittente del messaggio di chat. Questa proprietà viene usata per popolare il nome del mittente per le notifiche push.
sequenceId	string	Sequenza del messaggio di chat nella conversazione.
type	ChatMessageType	Tipo di messaggio di chat.
version	string	Versione del messaggio di chat.

ChatMessageContent

Contenuto di un messaggio di chat.

Nome	Tipo	Descrizione
attachments	ChatAttachment[]	Elenco di allegati per questo messaggio
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Contenuto dei messaggi di chat per i messaggi di tipo testo o html.
participants	ChatParticipant[]	Contenuto del messaggio di chat per i messaggi di tipo partecipanteAggiungi o partecipanteRemoved.
topic	string	Contenuto del messaggio di chat per i messaggi di tipo topicUpdated.

ChatMessageType

Tipo di messaggio di chat.

Nome	Tipo	Descrizione
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

ChatParticipant

Partecipante del thread di chat.

Nome	Tipo	Descrizione
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nome visualizzato per il partecipante alla chat.
shareHistoryTime	string	Ora da cui la cronologia delle chat viene condivisa con il partecipante. Il timestamp è in formato RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Condividi tramite