다음을 통해 공유

Chat Thread - List Chat Read Receipts

  • 참조
Service:
Communication
API Version:
2024-03-15-preview

스레드에 대한 채팅 메시지 읽기 영수증을 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
chatThreadId
 path True

string

채팅 메시지 읽기 영수증을 가져올 스레드 ID입니다.
endpoint
 path True

string

Azure Communication 리소스의 엔드포인트입니다.
api-version
 query True

string

호출할 API의 버전입니다.
maxPageSize
 query

integer

int32

페이지당 반환할 최대 채팅 메시지 읽기 영수증 수입니다.
skip
 query

integer

int32

응답에서 지정된 위치까지 채팅 메시지 읽기 영수증을 건너뜁니다.

요청 헤더

Name 필수 형식 Description
Authorization True

string

ACS(Azure Communication Services) 사용자 액세스 토큰입니다.

응답

Name 형식 Description
200 OK

ChatMessageReadReceiptsCollection

요청이 성공했습니다. 작업은 요청 ChatMessageReadReceipt 된 리소스를 반환합니다.
401 Unauthorized

CommunicationErrorResponse

권한이 없습니다.
403 Forbidden

CommunicationErrorResponse

사용할 수 없습니다.
429 Too Many Requests

CommunicationErrorResponse

요청이 너무 많습니다.
Other Status Codes

CommunicationErrorResponse

서비스를 사용할 수 없습니다.

보안

Authorization

ACS(Azure Communication Services) 사용자 액세스 토큰입니다.

Type: apiKey
In: header

예제

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

정의

Name Description
ChatMessageReadReceipt

채팅 메시지 읽기 영수증은 받는 사람이 채팅 메시지를 읽은 시간을 나타냅니다.
ChatMessageReadReceiptsCollection

채팅 메시지 읽기 영수증의 페이징된 컬렉션입니다.

ChatMessageReadReceipt

채팅 메시지 읽기 영수증은 받는 사람이 채팅 메시지를 읽은 시간을 나타냅니다.

Name 형식 Description
chatMessageId

string

읽은 채팅 메시지의 ID입니다. 이 ID는 서버에서 생성됩니다.
readOn

string

메시지를 읽은 시간입니다. 타임스탬프는 RFC3339 형식 yyyy-MM-ddTHH:mm:ssZ입니다.
senderCommunicationIdentifier

CommunicationIdentifierModel

ChatMessageReadReceiptsCollection

채팅 메시지 읽기 영수증의 페이징된 컬렉션입니다.

Name 형식 Description
nextLink

string

검색할 수 있는 채팅 메시지 읽기 확인이 더 많은 경우 다음 링크가 채워집니다.
value

ChatMessageReadReceipt[]

채팅 메시지 읽기 영수증의 컬렉션입니다.