Chat Thread - Get Chat Message

Référence

Service:: Communication

Version d'API:: 2024-03-07

Obtient un message par ID.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
chatMessageId	path	True	string	ID du message.
chatThreadId	path	True	string	ID de thread auquel le message a été envoyé.
endpoint	path	True	string	Point de terminaison de la ressource Azure Communication.
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton d’accès utilisateur ACS (Azure Communication Services).

Réponses

Nom	Type	Description
200 OK	ChatMessage	Demande réussie. L’action retourne une ressource `Message`.
401 Unauthorized	CommunicationErrorResponse	Non autorisée.
403 Forbidden	CommunicationErrorResponse	Interdit.
429 Too Many Requests	CommunicationErrorResponse	Trop de demandes.
Other Status Codes	CommunicationErrorResponse	Service indisponible.

Sécurité

Authorization

Jeton d’accès utilisateur ACS (Azure Communication Services).

Type: apiKey
Dans: header

Exemples

Get Message

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 401

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

Code d’état:: 403

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

Code d’état:: 429

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

Code d’état:: 503

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

Définitions

Nom	Description
ChatAttachment	Pièce jointe dans un message de conversation.
ChatAttachmentType	Type de pièce jointe.
ChatMessage	Message de conversation.
ChatMessageContent	Contenu d’un message de conversation.
ChatMessageType	Type de message de conversation.
ChatParticipant	Participant au fil de conversation.

ChatAttachment

Pièce jointe dans un message de conversation.

Nom	Type	Description
attachmentType	ChatAttachmentType	Type de pièce jointe.
id	string	ID de la pièce jointe
name	string	Nom du contenu de la pièce jointe.
previewUrl	string	URL dans laquelle l’aperçu de la pièce jointe peut être téléchargé
url	string	URL dans laquelle la pièce jointe peut être téléchargée

ChatAttachmentType

Type de pièce jointe.

Nom	Type	Description
file	string
image	string

ChatMessage

Message de conversation.

Nom	Type	Description
content	ChatMessageContent	Contenu d’un message de conversation.
createdOn	string	Horodatage lorsque le message de conversation est arrivé au serveur. L’horodatage est au format RFC3339 : `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Horodatage (le cas échéant) lorsque le message a été supprimé. L’horodatage est au format RFC3339 : `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	Horodatage (le cas échéant) lorsque le message a été modifié. L’horodatage est au format RFC3339 : `yyyy-MM-ddTHH:mm:ssZ`.
id	string	ID du message de conversation. Cet ID est généré par le serveur.
metadata	object	Métadonnées de message.
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	Nom complet de l’expéditeur du message de conversation. Cette propriété est utilisée pour remplir le nom de l’expéditeur pour les notifications Push.
sequenceId	string	Séquence du message de conversation dans la conversation.
type	ChatMessageType	Type de message de conversation.
version	string	Version du message de conversation.

ChatMessageContent

Contenu d’un message de conversation.

Nom	Type	Description
attachments	ChatAttachment[]	Liste des pièces jointes pour ce message
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Contenu du message de conversation pour les messages de types texte ou html.
participants	ChatParticipant[]	Contenu du message de conversation pour les messages de types participantAdded ou participantRemoved.
topic	string	Contenu du message de conversation pour les messages de type topicUpdated.

ChatMessageType

Type de message de conversation.

Nom	Type	Description
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

ChatParticipant

Participant au fil de conversation.

Nom	Type	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nom complet du participant de conversation.
shareHistoryTime	string	Heure à partir de laquelle l’historique des conversations est partagé avec le participant. L’horodatage est au format RFC3339 : `yyyy-MM-ddTHH:mm:ssZ`.

Partager via