Chat Thread - List Chat Read Receipts

Reference

Service:: Communication

API Version:: 2024-03-15-preview

Získá potvrzení o přečtení zprávy chatu pro vlákno.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna, pro které chcete získat potvrzení o přečtení zprávy chatu.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.
maxPageSize	query		integer int32	Maximální počet potvrzení o přečtení chatových zpráv, která se mají vrátit na stránku.
skip	query		integer int32	Přeskočí potvrzení o přečtení chatových zpráv až na zadanou pozici v odpovědi.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele služby ACS (Azure Communication Services).

Odpovědi

Name	Typ	Description
200 OK	ChatMessageReadReceiptsCollection	Žádost byla úspěšná. Akce vrátí požadované `ChatMessageReadReceipt` prostředky.
401 Unauthorized	CommunicationErrorResponse	Neautorizováno
403 Forbidden	CommunicationErrorResponse	Zakázáno.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Nedostupná služba.

Zabezpečení

Authorization

Přístupový token uživatele služby ACS (Azure Communication Services).

Type: apiKey
In: header

Příklady

Get thread read receipts with pagination (max page size)

Sample Request

HTTP

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

Sample Response

Status code:: 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"
}

Status code:: 401

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

Status code:: 403

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

Status code:: 429

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

Status code:: 503

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

Definice

Name	Description
ChatMessageReadReceipt	Potvrzení o přečtení zprávy chatu označuje čas, kdy příjemce chatu přečetl zprávu chatu.
ChatMessageReadReceiptsCollection	Stránkovaná kolekce potvrzení o přečtení chatových zpráv.

ChatMessageReadReceipt

Potvrzení o přečtení zprávy chatu označuje čas, kdy příjemce chatu přečetl zprávu chatu.

Name	Typ	Description
chatMessageId	string	ID zprávy chatu, která byla přečtena. Toto ID vygeneruje server.
readOn	string	Čas, kdy byla zpráva přečtená. Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
senderCommunicationIdentifier	CommunicationIdentifierModel

ChatMessageReadReceiptsCollection

Stránkovaná kolekce potvrzení o přečtení chatových zpráv.

Name	Typ	Description
nextLink	string	Pokud je k dispozici více potvrzení o přečtení chatové zprávy, která se dají načíst, vyplní se další odkaz.
value	ChatMessageReadReceipt[]	Kolekce potvrzení o přečtení zprávy chatu.