call: updateRecordingStatus

名前空間: microsoft.graph

呼び出しに関連付けられたアプリケーションの記録状態を更新します。 これには、ポリシー ベースの記録Teamsを使用する必要があります。

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	サポート対象外
委任 (個人用 Microsoft アカウント)	サポート対象外
アプリケーション	Calls.JoinGroupCalls.All, Calls.AccessMedia.All

HTTP 要求

POST /communications/calls/{id}/updateRecordingStatus

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。
Content-type	application/json. Required.

要求本文

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

パラメーター	型	説明
clientContext	String	一意のクライアント コンテキスト文字列。 最大制限は 256 文字です。
status	String	記録の状態。 使用可能な値は、notRecording、recording、failed です。

応答

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

例

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

要求

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

HTTP

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

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

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var clientContext = "clientContext-value";

var status = RecordingStatus.NotRecording | RecordingStatus.Recording | RecordingStatus.Failed;

await graphClient.Communications.Calls["{call-id}"]
    .UpdateRecordingStatus(status,clientContext)
    .Request()
    .PostAsync();

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const updateRecordingStatusOperation = {
  clientContext: 'clientContext-value',
  status: 'notRecording | recording | failed'
};

await client.api('/communications/calls/{id}/updateRecordingStatus')
    .post(updateRecordingStatusOperation);

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/communications/calls/{id}/updateRecordingStatus"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

NSString *clientContext = @"clientContext-value";
payloadDictionary[@"clientContext"] = clientContext;

MSGraphRecordingStatus *status = [MSGraphRecordingStatus notRecording];
payloadDictionary[@"status"] = status;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String clientContext = "clientContext-value";

RecordingStatus status = RecordingStatus.NOT_RECORDING;

graphClient.communications().calls("{id}")
    .updateRecordingStatus(CallUpdateRecordingStatusParameterSet
        .newBuilder()
        .withStatus(status)
        .withClientContext(clientContext)
        .build())
    .buildRequest()
    .post();

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.New()
clientContext := "clientContext-value"
requestBody.SetClientContext(&clientContext)
status := "notRecording | recording | failed"
requestBody.SetStatus(&status)
callId := "call-id"
result, err := graphClient.Communications().CallsById(&callId).UpdateRecordingStatus(call-id).Post(requestBody)

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PowerShell

Import-Module Microsoft.Graph.CloudCommunications

$params = @{
    ClientContext = "clientContext-value"
    Status = "notRecording | recording | failed"
}

Update-MgCommunicationCallRecordingStatus -CallId $callId -BodyParameter $params

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

---

応答

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

HTTP/1.1 200 OK
Location: https://graph.microsoft.com/v1.0/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"
}