调用:updateRecordingStatus

命名空间:microsoft.graph

更新与呼叫关联的应用程序的录制状态。 这需要使用 基于 Teams 策略的录制 解决方案。

其他限制:如果不先调用 updateRecordingStatus API 来指示录制已开始录制并接收来自该 API 的成功回复,则不得使用媒体访问 API 来记录或保存应用程序访问的调用或会议中的媒体内容,或者从该媒体内容派生的数据 (“记录 ) ”或“录制”。 如果应用程序开始录制任何会议,则必须在调用 updateRecordingStatus API 之前结束录制,以指示录制已结束。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) 不支持。 不支持。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Calls.AccessMedia.All Calls.JoinGroupCall.All

HTTP 请求

POST /communications/calls/{id}/updateRecordingStatus

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-type application/json. 必需。

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
clientContext String 唯一的客户端上下文字符串。 最大限制为 256 个字符。
status String 录制状态。 可能的值为: notRecordingrecordingfailed

响应

此方法返回响应 200 OK 代码和 Location 标头,其中包含为此请求创建的 updateRecordingStatusOperation 对象的 URI。

示例

以下示例演示如何调用此 API。

请求

下面为请求示例。

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

响应

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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