Chat Thread - List Chat Messages

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-03-15-preview

Pobiera listę komunikatów z wątku.

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

Z parametrami opcjonalnymi:

GET {endpoint}/chat/threads/{chatThreadId}/messages?maxPageSize={maxPageSize}&startTime={startTime}&api-version=2024-03-15-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatThreadId	path	True	string	Identyfikator wątku wiadomości.
endpoint	path	True	string	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.
maxPageSize	query		integer int32	Maksymalna liczba komunikatów do zwrócenia na stronę.
startTime	query		string date-time	Najwcześniejszy punkt w czasie pobierania komunikatów po. Sygnatura czasowa powinna być w formacie RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Nagłówek żądania

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

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ChatMessagesCollection	Powodzenie
401 Unauthorized	CommunicationErrorResponse	Brak autoryzacji.
403 Forbidden	CommunicationErrorResponse	Zakazane.
429 Too Many Requests	CommunicationErrorResponse	Zbyt wiele żądań.
Other Status Codes	CommunicationErrorResponse	Usługa niedostępna.

Zabezpieczenia

Authorization

Token dostępu użytkownika acS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Get messages with pagination (max page size)

Przykładowe żądanie

HTTP

GET https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?maxPageSize=5&api-version=2024-03-15-preview

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "1593107077690",
      "type": "html",
      "version": "1593107077683",
      "sequenceId": "5",
      "content": {
        "message": "<p>This place for lunch?&nbsp;</p>\r\n<p><img itemscope=\"png\" src=\"\" width=\"1425\" height=\"539\" alt=\"image\" id=\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"></p>",
        "attachments": [
          {
            "id": "0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73",
            "attachmentType": "image",
            "name": "image",
            "url": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/original?api-version=2023-07-01-preview",
            "previewUrl": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages/1700844519132/teamsInterop/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/small?api-version=2023-07-01-preview"
          }
        ]
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "metadata": {
        "amsreferences": "[\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"]"
      },
      "senderCommunicationIdentifier": {
        "rawId": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
        "communicationUser": {
          "id": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
        }
      }
    },
    {
      "id": "1593107077683",
      "type": "text",
      "sequenceId": "4",
      "version": "1593107077683",
      "content": {
        "message": "Let's use this chat to decide what to get for lunch today."
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "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"
        }
      }
    },
    {
      "id": "1593107046498",
      "type": "text",
      "sequenceId": "3",
      "version": "1593107046498",
      "content": {
        "message": "Good morning everyone!"
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:06.4980000Z",
      "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"
        }
      }
    },
    {
      "id": "1593106976785",
      "type": "topicUpdated",
      "sequenceId": "2",
      "version": "1593106976785",
      "content": {
        "initiatorCommunicationIdentifier": {
          "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"
          }
        },
        "topic": "Lunch"
      },
      "createdOn": "2020-06-25T17:42:56.7850000Z"
    },
    {
      "id": "1593106976753",
      "type": "participantAdded",
      "version": "1593106976753",
      "sequenceId": "1",
      "content": {
        "initiatorCommunicationIdentifier": {
          "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"
          }
        },
        "participants": [
          {
            "communicationIdentifier": {
              "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"
              }
            }
          },
          {
            "communicationIdentifier": {
              "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
              "communicationUser": {
                "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
              }
            }
          },
          {
            "communicationIdentifier": {
              "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce",
              "communicationUser": {
                "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce"
              }
            }
          }
        ]
      },
      "createdOn": "2020-06-25T17:42:56.7530000Z"
    }
  ],
  "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2024-03-15-preview"
}

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. Obecnie obsługiwane tylko w scenariuszach międzyoperacyjności usługi Teams.
ChatAttachmentType	Typ załącznika.
ChatMessage	Wiadomość czatu.
ChatMessageContent	Zawartość wiadomości czatu.
ChatMessagesCollection	Kolekcja wiadomości czatu dla określonego wątku czatu.
ChatMessageType	Typ wiadomości czatu.
ChatParticipant	Uczestnik wątku czatu.

ChatAttachment

Załącznik w wiadomości czatu. Obecnie obsługiwane tylko w scenariuszach międzyoperacyjności usługi Teams.

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, gdy wiadomość czatu dotarła na serwer. Sygnatura czasowa ma format RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Sygnatura czasowa (jeśli ma zastosowanie) po usunięciu wiadomości. Sygnatura czasowa ma format RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	Znacznik czasu ostatniego (jeśli dotyczy) podczas edycji wiadomości. Sygnatura czasowa ma format 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 uczestnikaDodaj lub uczestnikaRemoved.
topic	string	Zawartość wiadomości czatu dla wiadomości o typie topicUpdated.

ChatMessagesCollection

Kolekcja wiadomości czatu dla określonego wątku czatu.

Nazwa	Typ	Opis
nextLink	string	Jeśli istnieje więcej wiadomości czatu, które można pobrać, zostanie wypełniony następny link.
value	ChatMessage[]	Kolekcja wiadomości czatu.

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.
metadata	object	Kontekstowe metadane dla uczestnika czatu. Metadane składają się z par nazw/wartości. Całkowity rozmiar wszystkich par metadanych może wynosić do 1 KB.
shareHistoryTime	string	Czas, z którego historia czatu jest udostępniana uczestnikowi. Sygnatura czasowa ma format RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Udostępnij za pośrednictwem