Skip to content

call-starttranscription.md

Latest commit

 

History

History
147 lines (106 loc) · 4.81 KB

call-starttranscription.md

File metadata and controls

147 lines (106 loc) · 4.81 KB
title call: startTranscription
ms.date 11/15/2024
description Start the transcription of a call.
author calvintang
ms.localizationpriority medium
ms.subservice cloud-communications
doc_type apiPageType

call: startTranscription

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Start the transcription of a call.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /communications/calls/{id}/microsoft.graph.StartTranscription

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-type application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
language String Language of the transcription. Currently supporting: en-us.

Response

This method returns a 202 Accepted response code and a startTranscriptionOperation object created for this request.

Example

The following example shows how to call this API.

Request

The following example shows the request.

HTTP

POST https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/microsoft.graph.StartTranscription
Content-Type: application/json
Content-Length: 56

{
  "language": "en-us"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 202 Accepted
Location: https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/operations/2d7ab59c-f8bd-4911-8302-6d58ab60e338

{
  "@odata.type": "#microsoft.graph.startTranscriptionOperation",
  "clientContext": "clientContext-value",
  "status": "running"
}