参加者を削除する

  • [アーティクル]

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

名前空間: microsoft.graph

通話中の特定の参加者を削除します。 場合によっては、アプリケーションがアクティブな呼び出しから参加者を削除することが適切です。 このアクションは、参加者が通話に応答する前または後に実行できます。 アクティブな呼び出し元が削除されると、削除前または削除後の通知なしで、呼び出しから直ちに削除されます。 招待された参加者が削除されると、未処理の参加者追加要求が取り消されます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) サポートされていません。 サポートされていません。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Calls.JoinGroupCall.All Calls.JoinGroupCallasGuest.All

アプリケーションがこの API を呼び出せるようにするには、テナント レベルのアプリケーション会議構成が必要です。 テナント管理者は、テナント リモート PowerShell で次のコマンドレットを呼び出して、この API を呼び出すアクセス許可をアプリケーションに付与する必要があります。 詳細については、「 Set-CsApplicationMeetingConfiguration」を参照してください。

PS C:\> Set-CsApplicationMeetingConfiguration -AllowRemoveParticipantAppIds @{Add="app_id"}

HTTP 要求

DELETE /app/calls/{id}/participants/{id}
DELETE /communications/calls/{id}/participants/{id}

注:/app パスは廃止されます。 今後は、/communications パスを使用してください。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。 応答本文では何も返されません。

例

例 1: アクティブな参加者を取り消す

要求

次の例は要求を示しています。

DELETE https://graph.microsoft.com/beta/communications/calls/112f7296-5fa4-42ca-bae8-6a692b15d4b8/participants/a7ebfb2d-871e-419c-87af-27290b22e8db

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 204 No Content

例 2: 招待された非アクティブな参加者を取り消す

既存の通話に参加者を招待する

メモ： 後で招待を participantId 取り消すために使用できるように、 invitationParticipantInfo のメンバーの値を指定します。

POST https://graph.microsoft.com/beta/communications/calls/112f7296-5fa4-42ca-bae8-6a692b15d4b8/participants/invite
Content-Type: application/json
Content-Length: 464

{
  "participants": [
    {
      "@odata.type": "#microsoft.graph.invitationParticipantInfo",
      "identity": {
        "@odata.type": "#microsoft.graph.identitySet",
        "user": {
          "@odata.type": "#microsoft.graph.identity",
          "id": "278405a3-f568-4b3e-b684-009193463064",
          "identityProvider": "AAD"
        }
      },
      "participantId": "a7ebfb2d-871e-419c-87af-27290b22e8db"
    }
  ],
  "clientContext": "f2fa86af-3c51-4bc2-8fc0-475452d9764f"
}

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.inviteParticipantsOperation",
  "id": "eec3812a-fdc3-4fb4-825c-a06c9f35414e",
  "status": "Running",
  "clientContext": "f2fa86af-3c51-4bc2-8fc0-475452d9764f",
  "resultInfo": null,
  "participants": [
    {
      "endpointType": null,
      "id": null,
      "participantId": "a7ebfb2d-871e-419c-87af-27290b22e8db",
      "identity": {
        "user": {
          "id": "278405a3-f568-4b3e-b684-009193463064",
          "identityProvider": "AAD",
          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
        },
        "application": null,
        "device": null,
        "phone": null
      }
    }
  ]
}

参加者が名簿に追加される前に招待された参加者を削除する

DELETE https://graph.microsoft.com/beta/communications/calls/112f7296-5fa4-42ca-bae8-6a692b15d4b8/participants/a7ebfb2d-871e-419c-87af-27290b22e8db

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 204 No Content