呼び出し: updateRecordingStatus

名前空間: microsoft.graph

重要

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

通話に関連付けられているアプリケーションのレコーディング状態を更新します。 これには、 Teams ポリシーベースのレコーディング ソリューションを使用する必要があります。

その他の制限事項: メディア アクセス API を使用して、アプリケーションがアクセスする通話や会議からのメディア コンテンツ、またはそのメディア コンテンツから派生したデータ ("レコード" または "記録") を保持することはできません。最初に updateRecordingStatus API を呼び出して記録が開始したことを示し、その API から成功応答を受け取る必要はありません。 アプリケーションで会議の記録を開始した場合は、 updateRecordingStatus API を呼び出す前に記録を終了して、記録が終了したことを示す必要があります。

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

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

アクセス許可

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

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

HTTP 要求

POST /app/calls/{id}/updateRecordingStatus
POST /communications/calls/{id}/updateRecordingStatus

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-type application/json. 必須です。

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 説明
clientContext 文字列 一意のクライアント コンテキスト文字列。 最大文字数は 256 文字です。
status String 記録の状態。 指定できる値は、 notRecordingrecording、または failed です。

応答

このメソッドは、 200 OK 応答コードと、この要求用に作成された updateRecordingStatusOperation オブジェクトに URI を含む Location ヘッダーを返します。

次の例は、この API を呼び出す方法を示しています。

要求

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

POST https://graph.microsoft.com/beta/communications/calls/{id}/updateRecordingStatus
Content-Type: application/json
Content-Length: 79

{
  "clientContext": "clientContext-value",
  "status": "notRecording | recording | failed"
}

応答

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

HTTP/1.1 200 OK
Location: https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5

{
  "@odata.type": "#microsoft.graph.updateRecordingStatusOperation",
  "clientContext": "clientContext-value",
  "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
  "resultInfo": null,
  "status": "completed"
}