Chat Thread - List Chat Read Receipts

Pobiera potwierdzenia odczytu komunikatu rozmowy dla wątku.

GET {endpoint}/chat/threads/{chatThreadId}/readReceipts?api-version=2021-03-07
GET {endpoint}/chat/threads/{chatThreadId}/readReceipts?maxPageSize={maxPageSize}&skip={skip}&api-version=2021-03-07

Parametry identyfikatora URI

Name In Required Type Description
chatThreadId
path True
  • string

Identyfikator wątku, w którym mają zostać pobrane potwierdzenia odczytu komunikatu rozmowy.

endpoint
path True
  • string

Punkt końcowy zasobu komunikacyjnego platformy Azure.

api-version
query True
  • string

Wersja interfejsu API do wywołania.

maxPageSize
query
  • integer
int32

Maksymalna liczba potwierdzeń odczytu komunikatów rozmowy na stronę.

skip
query
  • integer
int32

Pomija wiadomości czatu Odczytaj do określonej pozycji w odpowiedzi.

Nagłówek żądania

Name Required Type Description
Authorization True
  • string

Token dostępu użytkownika usługi ACS (Azure Communications Services).

Odpowiedzi

Name Type Description
200 OK

Żądanie powiodło się. Akcja zwraca żądane ChatMessageReadReceipt zasoby.

401 Unauthorized
  • CommunicationErrorResponse

Próby.

403 Forbidden
  • CommunicationErrorResponse

Zabrania.

Other Status Codes
  • CommunicationErrorResponse

Zbyt wiele żądań.

Other Status Codes
  • CommunicationErrorResponse

Usługa niedostępna.

Zabezpieczenia

Authorization

Token dostępu użytkownika usługi ACS (Azure Communications Services).

Type: apiKey
In: header

Przykłady

Get thread read receipts with pagination (max page size)

Sample Request

GET https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2/readReceipts?maxPageSize=2&api-version=2021-03-07

Sample Response

{
  "value": [
    {
      "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"
        }
      },
      "chatMessageId": "1591137790240",
      "readOn": "2020-06-06T05:55:41.6460000Z"
    },
    {
      "senderCommunicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a"
        }
      },
      "chatMessageId": "1591768249318",
      "readOn": "2020-06-06T05:55:41.6460000Z"
    }
  ],
  "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&maxPageSize=2&api-version=2021-03-07"
}
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definicje

ChatMessageReadReceipt

Potwierdzenie odczytania komunikatu rozmowy wskazuje czas, przez który wiadomość czatu została odczytana przez adresata.

ChatMessageReadReceiptsCollection

Stronicowana Kolekcja potwierdzeń odczytu komunikatów rozmowy.

ChatMessageReadReceipt

Potwierdzenie odczytania komunikatu rozmowy wskazuje czas, przez który wiadomość czatu została odczytana przez adresata.

Name Type Description
chatMessageId
  • string

Identyfikator komunikatu rozmowy, który został odczytany. Ten identyfikator jest generowany przez serwer.

readOn
  • string

Godzina, o której wiadomość została odczytana. Sygnatura czasowa jest w formacie RFC3339: yyyy-MM-ddTHH:mm:ssZ .

senderCommunicationIdentifier
  • CommunicationIdentifierModel

ChatMessageReadReceiptsCollection

Stronicowana Kolekcja potwierdzeń odczytu komunikatów rozmowy.

Name Type Description
nextLink
  • string

Jeśli istnieje więcej potwierdzeń odczytu komunikatów rozmowy, które można pobrać, zostanie wypełniony następny link.

value

Kolekcja potwierdzeń odczytu komunikatów rozmowy.