Chat Thread - List Chat Read Receipts

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

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 identifikátoru URI

Name In Required Type Description
chatThreadId
path True
  • string

ID vlákna, ze kterého se má získat oznámení o přečtení zprávy chatu.

endpoint
path True
  • string

Koncový bod prostředku komunikace Azure.

api-version
query True
  • string

Verze rozhraní API, která se má vyvolat

maxPageSize
query
  • integer
int32

Maximální počet oznámení o čtení zprávy chatu, které se má vrátit na stránku

skip
query
  • integer
int32

Přeskočí oznámení o přečtení zprávy chatu až do zadané pozice v odpovědi.

Hlavička požadavku

Name Required Type Description
Authorization True
  • string

Token přístupu uživatele služby ACS (Azure Communications Services).

Odpovědi

Name Type Description
200 OK

Požadavek byl úspěšný. Akce vrátí požadované ChatMessageReadReceipt prostředky.

401 Unauthorized
  • CommunicationErrorResponse

Přístupu.

403 Forbidden
  • CommunicationErrorResponse

Zakázán.

Other Status Codes
  • CommunicationErrorResponse

Příliš mnoho požadavků.

Other Status Codes
  • CommunicationErrorResponse

Nedostupná služba.

Zabezpečení

Authorization

Token přístupu uživatele služby ACS (Azure Communications Services).

Type: apiKey
In: header

Příklady

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."
  }
}

Definice

ChatMessageReadReceipt

Oznámení o přečtení zprávy chatu indikuje čas, kdy příjemce přečetl zprávu chatu.

ChatMessageReadReceiptsCollection

Stránkovaný soubor oznámení o čtení zprávy chatu.

ChatMessageReadReceipt

Oznámení o přečtení zprávy chatu indikuje čas, kdy příjemce přečetl zprávu chatu.

Name Type Description
chatMessageId
  • string

ID zprávy chatu, která byla přečtena. Toto ID je vygenerováno serverem.

readOn
  • string

Čas, kdy byla zpráva přečtena. Časové razítko je ve formátu RFC3339: yyyy-MM-ddTHH:mm:ssZ .

senderCommunicationIdentifier
  • CommunicationIdentifierModel

ChatMessageReadReceiptsCollection

Stránkovaný soubor oznámení o čtení zprávy chatu.

Name Type Description
nextLink
  • string

Pokud je k dispozici více zpráv s oznámením o čtení, které se dají načíst, naplní se další odkaz.

value

Kolekce oznámení o čtení zprávy chatu