共用方式為

Chat Thread - Send Chat Read Receipt

  • 參考
服務:
Communication
API 版本:
2024-03-07

代表使用者將讀取收據事件傳送至線程。

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

URI 參數

名稱 位於 必要 類型 Description
chatThreadId
 path True

string

要傳送讀取回條事件的線程標識碼。
endpoint
 path True

string

Azure 通訊資源的端點。
api-version
 query True

string

要叫用的 API 版本。

要求標頭

名稱 必要 類型 Description
Authorization True

string

ACS （Azure 通訊服務） 使用者存取令牌。

要求本文

名稱 必要 類型 Description
chatMessageId True

string

用戶讀取的最新聊天訊息標識碼。

回應

名稱 類型 Description
200 OK

要求成功。
401 Unauthorized

CommunicationErrorResponse

未經授權。
403 Forbidden

CommunicationErrorResponse

禁止。
429 Too Many Requests

CommunicationErrorResponse

要求太多。
Other Status Codes

CommunicationErrorResponse

服務無法使用。

安全性

Authorization

ACS （Azure 通訊服務） 使用者存取令牌。

類型: 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

要求傳送讀取回條的承載。

名稱 類型 Description
chatMessageId

string

用戶讀取的最新聊天訊息標識碼。