Chat Thread - List Chat Read Receipts

Tjänst:: Communication

API-version:: 2024-03-07

Hämtar läskvitton för chattmeddelanden för en tråd.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
chatThreadId	path	True	string	Tråd-ID för att hämta läskvitton för chattmeddelandet.
endpoint	path	True	string	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.
maxPageSize	query		integer (int32)	Det maximala antalet läskvitton för chattmeddelanden som ska returneras per sida.
skip	query		integer (int32)	Hoppar över läskvitton för chattmeddelanden upp till en angiven position som svar.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ACS-användaråtkomsttoken (Azure Communication Services).

Svar

Name	Typ	Description
200 OK	ChatMessageReadReceiptsCollection	Begäran lyckades. Åtgärden returnerar de begärda `ChatMessageReadReceipt` resurserna.
401 Unauthorized	CommunicationErrorResponse	Obehörig.
403 Forbidden	CommunicationErrorResponse	Förbjuden.
429 Too Many Requests	CommunicationErrorResponse	För många begäranden.
Other Status Codes	CommunicationErrorResponse	Tjänsten är inte tillgänglig.

Säkerhet

Authorization

En ACS-användaråtkomsttoken (Azure Communication Services).

Typ: apiKey
I: header

Exempel

Get thread read receipts with pagination (max page size)

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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-07"
}

Statuskod:: 401

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

Statuskod:: 403

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

Statuskod:: 429

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

Statuskod:: 503

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

Definitioner

Name	Description
ChatMessageReadReceipt	Ett läskvitto för ett chattmeddelande anger den tid då ett chattmeddelande lästes upp av en mottagare.
ChatMessageReadReceiptsCollection	En växlingsad samling med läskvitton för chattmeddelanden.

ChatMessageReadReceipt

Objekt

Ett läskvitto för ett chattmeddelande anger den tid då ett chattmeddelande lästes upp av en mottagare.

Name	Typ	Description
chatMessageId	string	Id för chattmeddelandet som har lästs. Det här ID:t genereras av servern.
readOn	string (date-time)	Tidpunkt då meddelandet lästes. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
senderCommunicationIdentifier	CommunicationIdentifierModel

ChatMessageReadReceiptsCollection