共用方式為

Chat Thread - Remove Chat Participant

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

從線程中移除參與者。

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

URI 參數

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

string

要從中移除參與者的線程標識碼。
endpoint
 path True

string

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

string

要叫用的 API 版本。

要求標頭

Media Types: "application/json", "application/merge-patch+json"

名稱 必要 類型 Description
Authorization True

string

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

要求本文

Media Types: "application/json", "application/merge-patch+json"

名稱 類型 Description
participantCommunicationIdentifier

CommunicationIdentifierModel

要從線程中移除之線程參與者的標識碼。

回應

名稱 類型 Description
204 No Content

要求成功。
401 Unauthorized

CommunicationErrorResponse

未經授權。
403 Forbidden

CommunicationErrorResponse

禁止。
429 Too Many Requests

CommunicationErrorResponse

要求太多。
Other Status Codes

CommunicationErrorResponse

服務無法使用。

安全性

Authorization

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

類型: apiKey
位於: header

範例

Remove participant

範例要求

POST https://contoso.westus.communications.azure.com/chat/threads/19:f2167429acf6482880c6b7790a9086c1@thread.v2/participants/:remove?api-version=2024-03-07

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

範例回覆

狀態碼:
204
狀態碼:
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."
  }
}