次の方法で共有

Chat Thread - Send Chat Read Receipt

  • リファレンス
サービス:
Communication
API バージョン:
2024-03-07

ユーザーの代わりに、開封確認イベントをスレッドに送信します。

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

URI パラメーター

名前 / 必須 型 説明
chatThreadId
 path True

string

開封確認イベントを送信するスレッド ID。
endpoint
 path True

string

Azure Communication リソースのエンドポイント。
api-version
 query True

string

呼び出す API のバージョン。

要求ヘッダー

名前 必須 型 説明
Authorization True

string

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

要求本文

名前 必須 型 説明
chatMessageId True

string

ユーザーが読み取った最新のチャット メッセージの ID。

応答

名前 型 説明
200 OK

要求が成功しました。
401 Unauthorized

CommunicationErrorResponse

不正。
403 Forbidden

CommunicationErrorResponse

禁じられた。
429 Too Many Requests

CommunicationErrorResponse

要求が多すぎます。
Other Status Codes

CommunicationErrorResponse

サービスは使用できません。

セキュリティ

Authorization

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

型: apiKey
/: header

例

Send read receipt

要求のサンプル

POST https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/readReceipts?api-version=2024-03-07

{
  "chatMessageId": "1591137790240"
}

応答のサンプル

状態コード:
200
状態コード:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
状態コード:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
状態コード:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
状態コード:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

定義

SendReadReceiptRequest

開封確認メッセージを送信するための要求ペイロード。

名前 型 説明
chatMessageId

string

ユーザーが読み取った最新のチャット メッセージの ID。