Chat Thread - Get Chat Message

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-03-07

Pobiera komunikat według identyfikatora.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatMessageId	path	True	string	Identyfikator wiadomości.
chatThreadId	path	True	string	Identyfikator wątku, do którego wysłano wiadomość.
endpoint	path	True	string	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług ACS (Azure Communication Services).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ChatMessage	Żądanie powiodło się. Akcja zwraca zasób `Message`.
401 Unauthorized	CommunicationErrorResponse	Nieautoryzowanych.
403 Forbidden	CommunicationErrorResponse	Zakazany.
429 Too Many Requests	CommunicationErrorResponse	Zbyt wiele żądań.
Other Status Codes	CommunicationErrorResponse	Usługa jest niedostępna.

Zabezpieczenia

Authorization

Token dostępu użytkownika usług ACS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Get Message

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 401

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

Kod stanu:: 403

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

Kod stanu:: 429

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

Kod stanu:: 503

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

Definicje

Nazwa	Opis
ChatAttachment	Załącznik w wiadomości czatu.
ChatAttachmentType	Typ załącznika.
ChatMessage	Wiadomość czatu.
ChatMessageContent	Zawartość wiadomości czatu.
ChatMessageType	Typ wiadomości czatu.
ChatParticipant	Uczestnik wątku czatu.

ChatAttachment

Załącznik w wiadomości czatu.

Nazwa	Typ	Opis
attachmentType	ChatAttachmentType	Typ załącznika.
id	string	Identyfikator załącznika
name	string	Nazwa zawartości załącznika.
previewUrl	string	Adres URL, pod którym można pobrać podgląd załącznika
url	string	Adres URL, pod którym można pobrać załącznik

ChatAttachmentType

Typ załącznika.

Nazwa	Typ	Opis
file	string
image	string

ChatMessage

Wiadomość czatu.

Nazwa	Typ	Opis
content	ChatMessageContent	Zawartość wiadomości czatu.
createdOn	string	Sygnatura czasowa, kiedy wiadomość czatu dotarła na serwer. Znacznik czasu jest w formacie RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Sygnatura czasowa (jeśli ma zastosowanie) po usunięciu komunikatu. Znacznik czasu jest w formacie RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	Znacznik czasu ostatniego (jeśli dotyczy) podczas edycji wiadomości. Znacznik czasu jest w formacie RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	Identyfikator wiadomości czatu. Ten identyfikator jest generowany przez serwer.
metadata	object	Metadane wiadomości.
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	Nazwa wyświetlana nadawcy wiadomości czatu. Ta właściwość służy do wypełniania nazwy nadawcy dla powiadomień wypychanych.
sequenceId	string	Sekwencja wiadomości czatu w konwersacji.
type	ChatMessageType	Typ wiadomości czatu.
version	string	Wersja wiadomości czatu.

ChatMessageContent

Zawartość wiadomości czatu.

Nazwa	Typ	Opis
attachments	ChatAttachment[]	Lista załączników dla tej wiadomości
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Zawartość wiadomości czatu dla wiadomości o typach tekstowych lub html.
participants	ChatParticipant[]	Zawartość wiadomości czatu dla wiadomości o typach uczestnikówDodaj lub uczestnikRemoved.
topic	string	Zawartość wiadomości czatu dla wiadomości o typie topicUpdated.

ChatMessageType

Typ wiadomości czatu.

Nazwa	Typ	Opis
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

ChatParticipant

Uczestnik wątku czatu.

Nazwa	Typ	Opis
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nazwa wyświetlana uczestnika czatu.
shareHistoryTime	string	Czas, od którego historia czatu jest udostępniana uczestnikowi. Znacznik czasu jest w formacie RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Udostępnij za pośrednictwem