Chat Thread - Get Chat Message

Referenz

Dienst:: Communication

API-Version:: 2024-03-07

Ruft eine Nachricht nach ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
chatMessageId	path	True	string	Die Nachrichten-ID.
chatThreadId	path	True	string	Die Thread-ID, an die die Nachricht gesendet wurde.
endpoint	path	True	string	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Antworten

Name	Typ	Beschreibung
200 OK	ChatMessage	Anforderung erfolgreich. Die Aktion gibt eine `Message` Ressource zurück.
401 Unauthorized	CommunicationErrorResponse	Unbefugt.
403 Forbidden	CommunicationErrorResponse	Verboten.
429 Too Many Requests	CommunicationErrorResponse	Zu viele Anforderungen.
Other Status Codes	CommunicationErrorResponse	Der Dienst ist nicht verfügbar.

Sicherheit

Authorization

Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

Get Message

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 401

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

Statuscode:: 403

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

Statuscode:: 429

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

Statuscode:: 503

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

Definitionen

Name	Beschreibung
ChatAttachment	Eine Anlage in einer Chatnachricht.
ChatAttachmentType	Der Typ der Anlage.
ChatMessage	Chatnachricht.
ChatMessageContent	Inhalt einer Chatnachricht.
ChatMessageType	Der Chatnachrichtentyp.
ChatParticipant	Ein Teilnehmer des Chatthreads.

ChatAttachment

Eine Anlage in einer Chatnachricht.

Name	Typ	Beschreibung
attachmentType	ChatAttachmentType	Der Typ der Anlage.
id	string	ID der Anlage
name	string	Der Name des Anlageninhalts.
previewUrl	string	Die URL, unter der die Vorschau der Anlage heruntergeladen werden kann
url	string	Die URL, unter der die Anlage heruntergeladen werden kann

ChatAttachmentType

Der Typ der Anlage.

Name	Typ	Beschreibung
file	string
image	string

ChatMessage

Chatnachricht.

Name	Typ	Beschreibung
content	ChatMessageContent	Inhalt einer Chatnachricht.
createdOn	string	Der Zeitstempel, wenn die Chatnachricht auf dem Server eingetroffen ist. Der Zeitstempel befindet sich im RFC3339 Format: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Der Zeitstempel (falls zutreffend), wenn die Nachricht gelöscht wurde. Der Zeitstempel befindet sich im RFC3339 Format: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	Der letzte Zeitstempel (falls zutreffend), als die Nachricht bearbeitet wurde. Der Zeitstempel befindet sich im RFC3339 Format: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	Die ID der Chatnachricht. Diese ID wird vom Server generiert.
metadata	object	Nachrichtenmetadaten.
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	Der Anzeigename des Absenders der Chatnachricht. Diese Eigenschaft wird verwendet, um den Namen des Absenders für Pushbenachrichtigungen aufzufüllen.
sequenceId	string	Sequenz der Chatnachricht in der Unterhaltung.
type	ChatMessageType	Der Chatnachrichtentyp.
version	string	Version der Chatnachricht.

ChatMessageContent

Inhalt einer Chatnachricht.

Name	Typ	Beschreibung
attachments	ChatAttachment[]	Liste der Anlagen für diese Nachricht
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Chatnachrichteninhalt für Nachrichten vom Typ "Text" oder "HTML".
participants	ChatParticipant[]	Chatnachrichteninhalt für Nachrichten von Typen "participantAdded" oder "participantRemoved".
topic	string	Chatnachrichteninhalt für Nachrichten vom Typ "topicUpdated".

ChatMessageType

Der Chatnachrichtentyp.

Name	Typ	Beschreibung
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

ChatParticipant

Ein Teilnehmer des Chatthreads.

Name	Typ	Beschreibung
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Anzeigename für den Chatteilnehmer.
shareHistoryTime	string	Zeit, aus der der Chatverlauf für den Teilnehmer freigegeben wird. Der Zeitstempel befindet sich im RFC3339 Format: `yyyy-MM-ddTHH:mm:ssZ`.

Freigeben über