Skip to content

Commit 195a0a1

Browse files
authored
Merge pull request #25985 from microsoftgraph/yuyaolian/v1-meeting-template-id
add v1 docs for onlineMeeting meetingTemplateId
2 parents 0d20c99 + 6afa24a commit 195a0a1

File tree

4 files changed

+109
-1
lines changed

4 files changed

+109
-1
lines changed

api-reference/v1.0/api/application-post-onlinemeetings.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,89 @@ Content-Type: application/json
468468
}
469469
```
470470

471+
### Example 4: Create an online meeting with a meeting template
472+
473+
The following example shows how to create a meeting with a Microsoft Teams [meeting template](/microsoftteams/create-custom-meeting-template). Microsoft Teams custom meeting templates allow you to specify values for many of the meeting options that are available to meeting organizers.
474+
475+
> [!CAUTION]
476+
>
477+
>- The template might lock some meeting options in the Teams UI. The enforcement of the lock takes place on the server side.
478+
>- Subsequent updates to the **onlineMeeting** can't overwrite the **meetingTemplateId** or locked meeting options.
479+
>- Using a custom meeting template to create a meeting is a Teams Premium feature.
480+
481+
#### Request
482+
483+
The following example shows a request.
484+
485+
<!-- {
486+
"blockType": "request",
487+
"name": "create-online-meeting-with-meeting-template"
488+
}-->
489+
490+
```http
491+
POST https://graph.microsoft.com/beta/me/onlineMeetings
492+
Content-Type: application/json
493+
494+
{
495+
"startDateTime": "2019-07-12T14:30:34.2444915-07:00",
496+
"endDateTime": "2019-07-12T15:00:34.2464912-07:00",
497+
"subject": "User meeting",
498+
"meetingTemplateId": "05b9ed5f-2ac3-4470-aae9-f4a0c30b1a4b"
499+
}
500+
```
501+
502+
#### Response
503+
504+
The following example shows the response.
505+
506+
>**Note:** The response object shown here might be shortened for readability.
507+
508+
<!-- {
509+
"blockType": "response",
510+
"truncated": true,
511+
"@odata.type": "microsoft.graph.onlineMeeting"
512+
} -->
513+
514+
```http
515+
HTTP/1.1 201 Created
516+
Content-Type: application/json
517+
518+
{
519+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#users('xxxxxxxx')/onlineMeetings/$entity",
520+
"audioConferencing": {
521+
"tollNumber": "+12345678",
522+
"tollFreeNumber": "+12345",
523+
"ConferenceId": "1234",
524+
"dialinUrl": "https://dialin.teams.microsoft.com/xxxxxxx?id=2999"
525+
},
526+
"chatInfo": {
527+
"threadId": "1xxxxxxxxxxxxxx%40thread.skype",
528+
"messageId": "15629053",
529+
"replyChainMessageId": null
530+
},
531+
"creationDateTime": "2019-07-11T02:17:17.6491364Z",
532+
"startDateTime": "2019-07-11T02:17:17.6491364Z",
533+
"endDateTime": "2019-07-11T02:47:17.651138Z",
534+
"id": "MSpkYzE3Njc0Yy04MWQ5LTRhFpHRTNaR1F6WGhyZWFkLnYy",
535+
"joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3ameeting_M2IzYzczNTItYmY3iMjNlOTY4MGEz%40thread.skype/0?context=%7b%22Tid%22%3a%22f8bf-86f1-41af-91ab-2011db47%22%2c%22Oid%22%3a%20fae72-d251-43ec-86c-377304f%22%7d",
536+
"participants": {
537+
"organizer": {
538+
"identity": {
539+
"user": {
540+
"id": "5e72-d251-43ec-868c-3732704f",
541+
"tenantId": "72fbf-86f1-41af-91ab-2d71db47",
542+
"displayName": "Mario Rogers"
543+
}
544+
},
545+
"role": "presenter",
546+
"upn": "upn-value"
547+
}
548+
},
549+
"subject": "User meeting",
550+
"meetingTemplateId": "05b9ed5f-2ac3-4470-aae9-f4a0c30b1a4b"
551+
}
552+
```
553+
471554
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
472555
2015-10-25 14:57:30 UTC -->
473556
<!--

api-reference/v1.0/resources/onlinemeeting.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Contains information about a meeting, including the URL used to join a meeting,
5959
| joinInformation | [itemBody](itembody.md) | The join information in the language and locale variant specified in the `Accept-Language` request HTTP header. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). |
6060
| joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. Once an **onlineMeeting** is created, the **joinMeetingIdSettings** can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). |
6161
| lobbyBypassSettings | [lobbyBypassSettings](lobbybypasssettings.md) | Specifies which participants can bypass the meeting lobby. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). |
62+
| meetingTemplateId | String | The ID of the [meeting template](/microsoftteams/create-custom-meeting-template). |
6263
| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). |
6364
| shareMeetingChatHistoryDefault | [meetingChatHistoryDefaultMode](#meetingchathistorydefaultmode-values) | Specifies whether meeting chat history is shared with participants. Possible values are: `all`, `none`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). |
6465
| startDateTime | DateTime | The meeting start time in UTC. |
@@ -136,6 +137,7 @@ The following JSON representation shows the resource type.
136137
"joinMeetingIdSettings": {"@odata.type": "microsoft.graph.joinMeetingIdSettings"},
137138
"joinWebUrl": "String",
138139
"lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"},
140+
"meetingTemplateId": "String",
139141
"participants": {"@odata.type": "microsoft.graph.meetingParticipants"},
140142
"recordAutomatically": "Boolean",
141143
"startDateTime": "String (timestamp)",

changelog/Microsoft.Skype.Calling.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
{
22
"changelog": [
3+
{
4+
"ChangeList": [
5+
{
6+
"Id": "14c5e7c8-5ba9-44eb-ac3a-b99452dde78f",
7+
"ApiChange": "Property",
8+
"ChangedApiName": "meetingTemplateId",
9+
"ChangeType": "Addition",
10+
"Description": "Added the **meetingTemplateId** property to the [onlineMeeting](https://learn.microsoft.com/en-us/graph/api/resources/onlineMeeting?view=graph-rest-1.0) resource.",
11+
"Target": "onlineMeeting"
12+
}
13+
],
14+
"Id": "14c5e7c8-5ba9-44eb-ac3a-b99452dde78f",
15+
"Cloud": "Prod",
16+
"Version": "v1.0",
17+
"CreatedDateTime": "2024-12-25T21:59:08.9618388Z",
18+
"WorkloadArea": "Teamwork and communications",
19+
"SubArea": "Calls and online meetings"
20+
},
321
{
422
"ChangeList": [
523
{

concepts/whats-new-overview.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,12 @@ For details about previous updates to Microsoft Graph, see [Microsoft Graph what
2424
Updated the endpoint of the [fileStorageContainer: restore](/graph/api/filestoragecontainer-restore) method.
2525

2626
### Identity and access | Identity and sign-in
27-
- Added riskEventType entry for the Suspicious API Traffic detection for [service principals](/graph/api/resources/serviceprincipalriskdetection?view=graph-rest-1.0&preserve-view=true).
27+
28+
Added riskEventType entry for the Suspicious API Traffic detection for [service principals](/graph/api/resources/serviceprincipalriskdetection?view=graph-rest-1.0&preserve-view=true).
29+
30+
### Teamwork and communications | Calls and online meetings
31+
32+
Microsoft Teams custom meeting templates allow you to specify values for many of the meeting options available to meeting organizers. Use the **meetingTemplateId** property on [onlineMeeting](/graph/api/resources/onlinemeeting) to create an online meeting with a meeting template.
2833

2934
### Teamwork and communications | Messaging
3035

0 commit comments

Comments
 (0)