Chat Thread - Remove Chat Participant

リファレンス

Service:: Communication

API Version:: 2024-03-15-preview

スレッドから参加者を削除します。

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

URI パラメーター

名前	/	必須	型	説明
chatThreadId	path	True	string	参加者を削除するスレッド ID。
endpoint	path	True	string	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

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

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

要求本文

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

名前	型	説明
participantCommunicationIdentifier	CommunicationIdentifierModel	スレッドから削除するスレッド参加要素の ID。

応答

名前	型	説明
204 No Content		要求が成功しました。
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

例

Remove participant

Sample Request

HTTP

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

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

Sample Response

Status code:: 204

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

Share via