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 パラメーター

名前	/	必須	型	説明
chatThreadId	path	True	string	チャットメッセージの開封確認メッセージを取得するスレッド ID。
endpoint	path	True	string	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。
maxPageSize	query		integer int32	1 ページあたりに返されるチャットメッセージの開封確認メッセージの最大数。
skip	query		integer int32	応答で指定した位置までチャットメッセージの開封確認メッセージをスキップします。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	ACS (Azure Communication Services) ユーザーアクセストークン。

応答

名前	型	説明
200 OK	ChatMessageReadReceiptsCollection	要求が成功しました。アクションは、要求された `ChatMessageReadReceipt` リソースを返します。
401 Unauthorized	CommunicationErrorResponse	権限がありません。
403 Forbidden	CommunicationErrorResponse	Forbidden.
429 Too Many Requests	CommunicationErrorResponse	要求が多すぎます。
Other Status Codes	CommunicationErrorResponse	Service unavailable. (サービス利用不可。)

セキュリティ

Authorization

ACS (Azure Communication Services) ユーザーアクセストークン。

Type: apiKey
In: header

例

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

定義

名前	説明
ChatMessageReadReceipt	チャットメッセージの開封確認メッセージは、受信者がチャットメッセージを読み取った時刻を示します。
ChatMessageReadReceiptsCollection	チャットメッセージの開封確認メッセージのページコレクション。

ChatMessageReadReceipt

チャットメッセージの開封確認メッセージは、受信者がチャットメッセージを読み取った時刻を示します。

名前	型	説明
chatMessageId	string	読み取られたチャットメッセージの ID。この ID はサーバーによって生成されます。
readOn	string	メッセージが読み取られた時刻。タイムスタンプの形式は RFC3339 です。 `yyyy-MM-ddTHH:mm:ssZ`
senderCommunicationIdentifier	CommunicationIdentifierModel

ChatMessageReadReceiptsCollection

チャットメッセージの開封確認メッセージのページコレクション。

名前	型	説明
nextLink	string	取得できるチャットメッセージの開封確認メッセージが他にもある場合は、次のリンクが設定されます。
value	ChatMessageReadReceipt[]	チャットメッセージの開封確認メッセージのコレクション。

Share via