Skip to content

Commit 52b24bf

Browse files
FaithOmbongiFaithOmbongi
authored
Merge pull request #25678 from microsoftgraph/calvintang/callrecordingtranscription
Added New Recording and Transcription Operation Documentation
2 parents 1c53198 + d4f32fa commit 52b24bf

15 files changed

+835
-31
lines changed

‎api-reference/beta/api/call-startrecording.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: "call: startRecording"
3+
ms.date: 11/15/2024
4+
description: "Start the recording of a call."
5+
author: "calvintang"
6+
ms.localizationpriority: medium
7+
ms.subservice: "cloud-communications"
8+
doc_type: apiPageType
9+
---
10+
11+
# call: startRecording
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Start the recording of a call.
18+
19+
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
20+
21+
## Permissions
22+
23+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
24+
25+
<!-- { "blockType": "permissions", "name": "call_startrecording" } -->
26+
[!INCLUDE [permissions-table](../includes/permissions/call-startrecording-permissions.md)]
27+
28+
## HTTP request
29+
<!-- { "blockType": "ignored" } -->
30+
31+
```http
32+
POST /communications/calls/{id}/microsoft.graph.StartRecording
33+
```
34+
35+
## Request headers
36+
37+
| Name | Description |
38+
|:--------------|:--------------------------|
39+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
40+
| Content-type | application/json. Required. |
41+
42+
## Request body
43+
44+
Don't supply a request body for this method.
45+
46+
## Response
47+
48+
This method returns a `202 Accepted` response code and a [startRecordingOperation](../resources/startrecordingoperation.md) object created for this request.
49+
50+
## Example
51+
52+
The following example shows how to call this API.
53+
54+
### Request
55+
56+
The following example shows the request.
57+
58+
<!-- {
59+
"blockType": "request",
60+
"name": "call-startRecording"
61+
}-->
62+
63+
```http
64+
POST https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/microsoft.graph.StartRecording
65+
```
66+
67+
---
68+
69+
### Response
70+
71+
The following example shows the response.
72+
73+
> **Note:** The response object shown here might be shortened for readability.
74+
75+
<!-- {
76+
"blockType": "response",
77+
"name": "call-startRecording",
78+
"truncated": true,
79+
"@odata.type": "microsoft.graph.startRecordingOperation"
80+
} -->
81+
82+
```http
83+
HTTP/1.1 202 Accepted
84+
Location: https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/operations/2d7ab59c-f8bd-4911-8302-6d58ab60e338
85+
86+
{
87+
"@odata.type": "#microsoft.graph.startRecordingOperation",
88+
"clientContext": "clientContext-value",
89+
"status": "running"
90+
}
91+
92+
```
93+
94+
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
95+
2024-11-12 14:57:30 UTC -->
96+
<!--
97+
{
98+
"type": "#page.annotation",
99+
"description": "call: startRecording",
100+
"keywords": "",
101+
"section": "documentation",
102+
"tocPath": "",
103+
"suppressions": [
104+
]
105+
}
106+
-->

‎api-reference/beta/api/call-starttranscription.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: "call: startTranscription"
3+
ms.date: 11/15/2024
4+
description: "Start the transcription of a call."
5+
author: "calvintang"
6+
ms.localizationpriority: medium
7+
ms.subservice: "cloud-communications"
8+
doc_type: apiPageType
9+
---
10+
11+
# call: startTranscription
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Start the transcription of a call.
18+
19+
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
20+
21+
## Permissions
22+
23+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
24+
25+
<!-- { "blockType": "permissions", "name": "call_starttranscription" } -->
26+
[!INCLUDE [permissions-table](../includes/permissions/call-starttranscription-permissions.md)]
27+
28+
## HTTP request
29+
<!-- { "blockType": "ignored" } -->
30+
31+
```http
32+
POST /communications/calls/{id}/microsoft.graph.StartTranscription
33+
```
34+
35+
## Request headers
36+
37+
| Name | Description |
38+
|:--------------|:--------------------------|
39+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
40+
| Content-type | application/json. Required. |
41+
42+
## Request body
43+
44+
In the request body, provide a JSON object with the following parameters.
45+
46+
| Parameter | Type | Description |
47+
|:----------------|:--------|:--------------------------------------------------------------------------------------|
48+
| language | String | Language of the transcription. Currently supporting: `en-us`. |
49+
50+
## Response
51+
52+
This method returns a `202 Accepted` response code and a [startTranscriptionOperation](../resources/starttranscriptionoperation.md) object created for this request.
53+
54+
## Example
55+
56+
The following example shows how to call this API.
57+
58+
### Request
59+
60+
The following example shows the request.
61+
62+
<!-- {
63+
"blockType": "request",
64+
"name": "call-startTranscription"
65+
}-->
66+
67+
```http
68+
POST https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/microsoft.graph.StartTranscription
69+
Content-Type: application/json
70+
Content-Length: 56
71+
72+
{
73+
"language": "en-us"
74+
}
75+
```
76+
77+
---
78+
79+
### Response
80+
81+
The following example shows the response.
82+
83+
> **Note:** The response object shown here might be shortened for readability.
84+
85+
<!-- {
86+
"blockType": "response",
87+
"name": "call-startTranscription",
88+
"truncated": true,
89+
"@odata.type": "microsoft.graph.startTranscriptionOperation"
90+
} -->
91+
92+
```http
93+
HTTP/1.1 202 Accepted
94+
Location: https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/operations/2d7ab59c-f8bd-4911-8302-6d58ab60e338
95+
96+
{
97+
"@odata.type": "#microsoft.graph.startTranscriptionOperation",
98+
"clientContext": "clientContext-value",
99+
"status": "running"
100+
}
101+
102+
```
103+
104+
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
105+
2024-11-12 14:57:30 UTC -->
106+
<!--
107+
{
108+
"type": "#page.annotation",
109+
"description": "call: startTranscription",
110+
"keywords": "",
111+
"section": "documentation",
112+
"tocPath": "",
113+
"suppressions": [
114+
]
115+
}
116+
-->

‎api-reference/beta/api/call-stoprecording.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: "call: stopRecording"
3+
ms.date: 11/15/2024
4+
description: "Stop the recording of a call."
5+
author: "calvintang"
6+
ms.localizationpriority: medium
7+
ms.subservice: "cloud-communications"
8+
doc_type: apiPageType
9+
---
10+
11+
# call: stopRecording
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Stop the recording of a call.
18+
19+
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
20+
21+
## Permissions
22+
23+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
24+
25+
<!-- { "blockType": "permissions", "name": "call_stoprecording" } -->
26+
[!INCLUDE [permissions-table](../includes/permissions/call-stoprecording-permissions.md)]
27+
28+
## HTTP request
29+
<!-- { "blockType": "ignored" } -->
30+
31+
```http
32+
POST /communications/calls/{id}/microsoft.graph.StopRecording
33+
```
34+
35+
## Request headers
36+
37+
| Name | Description |
38+
|:--------------|:--------------------------|
39+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
40+
| Content-type | application/json. Required. |
41+
42+
## Request body
43+
44+
Don't supply a request body for this method.
45+
46+
## Response
47+
48+
This method returns a `202 Accepted` response code and a [stopRecordingOperation](../resources/stoprecordingoperation.md) object created for this request.
49+
50+
## Example
51+
52+
The following example shows how to call this API.
53+
54+
### Request
55+
56+
The following example shows the request.
57+
58+
<!-- {
59+
"blockType": "request",
60+
"name": "call-stopRecording"
61+
}-->
62+
63+
```http
64+
POST https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/microsoft.graph.StopRecording
65+
```
66+
67+
---
68+
69+
### Response
70+
The following example shows the response.
71+
72+
> **Note:** The response object shown here might be shortened for readability.
73+
74+
<!-- {
75+
"blockType": "response",
76+
"name": "call-stopRecording",
77+
"truncated": true,
78+
"@odata.type": "microsoft.graph.stopRecordingOperation"
79+
} -->
80+
81+
```http
82+
HTTP/1.1 202 Accepted
83+
Location: https://graph.microsoft.com/beta/communications/calls/02000980-58ea-4bf2-bb77-8ba548da56f7/operations/2d7ab59c-f8bd-4911-8302-6d58ab60e338
84+
85+
{
86+
"@odata.type": "#microsoft.graph.stopRecordingOperation",
87+
"clientContext": "clientContext-value",
88+
"status": "completed"
89+
}
90+
91+
```
92+
93+
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
94+
2024-11-12 14:57:30 UTC -->
95+
<!--
96+
{
97+
"type": "#page.annotation",
98+
"description": "call: stopRecording",
99+
"keywords": "",
100+
"section": "documentation",
101+
"tocPath": "",
102+
"suppressions": [
103+
]
104+
}
105+
-->

0 commit comments

Comments
 (0)