Chat Thread - List Chat Read Receipts

Odwołanie

Usługa:: Communication

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

Pobiera potwierdzenia odczytu wiadomości czatu dla wątku.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatThreadId	path	True	string	Identyfikator wątku, aby uzyskać potwierdzenia odczytu wiadomości czatu.
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 potwierdzeń odczytu wiadomości czatu, które mają być zwracane na stronę.
skip	query		integer int32	Pomija potwierdzenia odczytu wiadomości czatu do określonej pozycji w odpowiedzi.

Nagłówek żądania

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

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ChatMessageReadReceiptsCollection	Żądanie powiodło się. Akcja zwraca żądane `ChatMessageReadReceipt` zasoby.
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 usługi ACS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Get thread read receipts with pagination (max page size)

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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_c94ff260-162d-46d6-94fd-e79f4d213715",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
        }
      },
      "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=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
ChatMessageReadReceipt	Potwierdzenie przeczytania wiadomości na czacie wskazuje czas czytania wiadomości na czacie przez odbiorcę.
ChatMessageReadReceiptsCollection	Stronicowana kolekcja potwierdzeń odczytu wiadomości czatu.

ChatMessageReadReceipt

Potwierdzenie przeczytania wiadomości na czacie wskazuje czas czytania wiadomości na czacie przez odbiorcę.

Nazwa	Typ	Opis
chatMessageId	string	Identyfikator wiadomości czatu, która została przeczytana. Ten identyfikator jest generowany przez serwer.
readOn	string	Czas czytania wiadomości. Znacznik czasu ma format RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
senderCommunicationIdentifier	CommunicationIdentifierModel

ChatMessageReadReceiptsCollection

Stronicowana kolekcja potwierdzeń odczytu wiadomości czatu.

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

Udostępnij za pośrednictwem