Conversation Thread Operations - Remove Participants

サービス:

Communication

API バージョン:

2025-04-01-preview

会話から参加者を削除する

POST {endpoint}/messages/conversations/{conversationId}/participants:remove?api-version=2025-04-01-preview

URI パラメーター

名前	/	必須	型	説明
conversationId	path	True	string	会話 ID。
endpoint	path	True	string (uri)	通信リソース (例: https://my-resource.communication.azure.com
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Repeatability-Request-ID		string	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。
Repeatability-First-Sent		string (date-time)	要求が最初に作成された日時を指定します。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前	必須	型	説明
participantIds	True	string[]	削除する参加者 ID。

応答

名前	型	説明
Other Status Codes	RemoveParticipantsResult	成功しました ヘッダー Repeatability-Result: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

AadOauth2Auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://communication.azure.com/.default

Authorization

型: apiKey
/: header

例

remove a participant from a conversation

要求のサンプル

HTTP

POST https://my-resource.communication.azure.com/messages/conversations/19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2/participants:remove?api-version=2025-04-01-preview

{
  "participantIds": [
    "8:acs:uuid2"
  ]
}

応答のサンプル

状態コード:

207

{
  "invalidParticipants": []
}

定義

名前	説明
Azure.Core.Foundations.Error	エラー オブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
RemoveParticipantsOptions	会話から参加者を削除するための要求ペイロード。
RemoveParticipantsResult	参加者の削除操作の応答。
UpdateParticipantsResult	参加者の削除操作の応答。

Azure.Core.Foundations.Error

Object

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラー オブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

RemoveParticipantsOptions

Object

会話から参加者を削除するための要求ペイロード。

名前	型	説明
participantIds	string[]	削除する参加者 ID。

RemoveParticipantsResult

Object

参加者の削除操作の応答。

名前	型	説明
invalidParticipants	UpdateParticipantsResult[]	追加に失敗した場合のエラーを含む ID の一覧

UpdateParticipantsResult

Object

参加者の削除操作の応答。

名前	型	説明
error	Azure.Core.Foundations.Error	参加者操作のエラー。
id	string	参加者ユーザー ID。