forked from abdelbahgat/microsoft-graph-docs
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into feature/subscription-remove-includeproperties
- Loading branch information
Showing
200 changed files
with
4,800 additions
and
769 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| --- | ||
| title: "onlineMeeting: createOrGet" | ||
| description: "Create an online meeting with a custom specified external ID. If the external ID already exists, this API will return the [onlineMeeting](../resources/onlinemeeting.md) object with that external ID." | ||
| author: "ananmishr" | ||
| localization_priority: Normal | ||
| ms.prod: "cloud-communications" | ||
| doc_type: apiPageType | ||
| --- | ||
|
|
||
| # onlineMeeting: createOrGet | ||
|
|
||
| Namespace: microsoft.graph | ||
|
|
||
| [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] | ||
|
|
||
| Create an [onlineMeeting](../resources/onlinemeeting.md) object with a custom specified external ID. If the external ID already exists, this API will return the [onlineMeeting](../resources/onlinemeeting.md) object with that external ID. | ||
|
|
||
| > **Note**: The meeting does not show on the user's calendar. | ||
| ## Permissions | ||
| One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). | ||
|
|
||
| | Permission type | Permissions (from least to most privileged) | | ||
| |:---------------------------------------|:--------------------------------------------| | ||
| | Delegated (work or school account) | OnlineMeetings.ReadWrite | | ||
| | Delegated (personal Microsoft account) | Not Supported | | ||
| | Application | Not Supported | | ||
|
|
||
| ## HTTP request | ||
| <!-- { "blockType": "ignored" } --> | ||
| ```http | ||
| POST /me/onlineMeetings/createOrGet | ||
| ``` | ||
|
|
||
| ## Request headers | ||
| | Name | Description | | ||
| |:--------------|:--------------------------| | ||
| | Authorization | Bearer {token}. Required. | | ||
| | Content-type | application/json. Required. | | ||
|
|
||
| ## Request body | ||
| In the request body, provide a JSON object with the following parameters. | ||
|
|
||
| | Parameter | Type |Description | | ||
| |:-----------------|:-----------------------------------------|:--------------------------------------------------------------------------| | ||
| | chatInfo |[chatInfo](../resources/chatinfo.md) |The chat information associated with this online meeting.| | ||
| | endDateTime | DateTime | The meeting end time in UTC. | | ||
| | externalId | String | The external ID. A custom ID. (Required) | | ||
| | participants | [meetingParticipants](../resources/meetingparticipants.md) | The participants associated with the online meeting. This includes the organizer and the attendees. | | ||
| | startDateTime | DateTime | The meeting start time in UTC. | | ||
| | subject | String | The subject of the online meeting. | | ||
|
|
||
| >**Note:** If the 'startDateTime' and 'endDateTime' are not provided, the values will default to the datetime value that is default to the system. In C#, that value is "01/01/0001" | ||
| ## Response | ||
| If successful, this method returns a `200 OK` response code and an [onlineMeeting](../resources/onlinemeeting.md) object in the response body. | ||
|
|
||
| ## Examples | ||
|
|
||
| The following example shows how to create or get an online meeting with an external ID. | ||
|
|
||
| ### Request | ||
|
|
||
| # [HTTP](#tab/http) | ||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "create-or-get-onlinemeeting" | ||
| }--> | ||
|
|
||
| ```http | ||
| POST https://graph.microsoft.com/beta/me/onlineMeetings/createOrGet | ||
| Content-Type: application/json | ||
| { | ||
| "chatInfo": { | ||
| "threadId":"19%3A3b52398f3c524556894b776357c1dd79%40thread.skype" | ||
| }, | ||
| "startDateTime": "2020-02-06T01:49:21.3524945+00:00", | ||
| "endDateTime": "2020-02-06T02:19:21.3524945+00:00", | ||
| "externalId": "7eb8263f-d0e0-4149-bb1c-1f0476083c56", | ||
| "participants": { | ||
| "organizer": { | ||
| "identity": { | ||
| "user": { | ||
| "id": "d4a060b5-a8fc-450c-837b-750b2c280000", | ||
| "tenantId": "72f988bf-86f1-41af-91ab-2d7cd0110000" | ||
| } | ||
| }, | ||
| "upn": "test1@contoso.com" | ||
| }, | ||
| "attendees": [ | ||
| { | ||
| "identity": { | ||
| "user": { | ||
| "id": "1f35f2e6-9cab-44ad-8d5a-b74c14720000", | ||
| "identityProvider": "MSA" | ||
| } | ||
| }, | ||
| "upn": "test@contoso.com" | ||
| } | ||
| ] | ||
| }, | ||
| "subject":"Create a meeting with customId provided" | ||
| } | ||
| ``` | ||
|
|
||
| ### Response | ||
|
|
||
| >**Note:** The response object shown here might be shortened for readability. | ||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true, | ||
| "@odata.type": "microsoft.graph.onlineMeeting" | ||
| } --> | ||
|
|
||
| ```http | ||
| HTTP/1.1 200 OK | ||
| Content-Type: application/json | ||
| { | ||
| "@odata.type": "#microsoft.graph.onlineMeeting", | ||
| "creationDateTime": "2020-02-06T01:50:10.7396692+00:00", | ||
| "startDateTime": "2020-02-06T01:49:21.3524945+00:00", | ||
| "endDateTime": "2020-02-06T02:19:21.3524945+00:00", | ||
| "joinWebUrl": "https://devspaces.skype.com/l/meetup-join/19%3ameeting_MWE2Y2U2NGYtMjk4Ni00NjYyLWEyMjItYjk3MGU4YzFh0000%40thread.v2/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%22d4a060b5-a8fc-450c-837b-750b2c2869b5%22%7d", | ||
| "subject": "Create a meeting with customId provided", | ||
| "participants": { | ||
| "@odata.type": "#microsoft.graph.meetingParticipants", | ||
| "organizer": { | ||
| "@odata.type": "#microsoft.graph.meetingParticipantInfo", | ||
| "identity": { | ||
| "@odata.type": "#microsoft.graph.identitySet", | ||
| "user": { | ||
| "@odata.type": "#microsoft.graph.identity", | ||
| "id": "d4a060b5-a8fc-450c-837b-750b2c280000", | ||
| "tenantId": "72f988bf-86f1-41af-91ab-2d7cd0110000", | ||
| "displayName": "Heidi Steen", | ||
| "identityProvider": "AAD" | ||
| } | ||
| }, | ||
| "upn": "test1@contoso.com" | ||
| }, | ||
| "attendees": [ | ||
| { | ||
| "@odata.type": "#microsoft.graph.meetingParticipantInfo", | ||
| "identity": { | ||
| "@odata.type": "#microsoft.graph.identitySet", | ||
| "user": { | ||
| "@odata.type": "#microsoft.graph.identity", | ||
| "id": "1f35f2e6-9cab-44ad-8d5a-b74c14720000", | ||
| "displayName": "Joe Doe", | ||
| "identityProvider": "MSA" | ||
| } | ||
| }, | ||
| "upn": "test@contoso.com" | ||
| } | ||
| ], | ||
| "producers": [], | ||
| "contributors": [] | ||
| }, | ||
| "isBroadcast": false, | ||
| "autoAdmittedUsers": "everyone", | ||
| "capabilities": [], | ||
| "audioConferencing": { | ||
| "@odata.type": "#microsoft.graph.audioConferencing", | ||
| "conferenceId": "804980000", | ||
| "tollNumber": "+1 647-749-0000", | ||
| "dialinUrl": "https://dialin.teams.microsoft.com/8bf6e654-57eb-4b85-aeaf-36c84429b2fe?id=804980000" | ||
| }, | ||
| "chatInfo": { | ||
| "@odata.type": "#microsoft.graph.chatInfo", | ||
| "threadId": "19:meeting_MWE2Y2U2NGYtMjk4Ni00NjYyLWEyMjItYjk3MGU4YzFh0000@thread.v2", | ||
| "messageId": "0" | ||
| }, | ||
| "videoTeleconferenceId": "7166440000", | ||
| "externalId": "7eb8263f-d0e0-4149-bb1c-1f0476083c56", | ||
| "id": "d4a060b5-a8fc-450c-837b-750b2c2869b5_19:meeting_MWE2Y2U2NGYtMjk4Ni00NjYyLWEyMjItYjk3MGU4YzFh0000@thread.v2", | ||
| "@odata.context": "http://localhost/$metadata#onlineMeetings/$entity", | ||
| "outerMeetingAutoAdmittedUsers": null, | ||
| "meetingInfo": null | ||
| } | ||
| ``` | ||
|
|
||
| <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 | ||
| 2015-10-25 14:57:30 UTC --> | ||
| <!-- | ||
| { | ||
| "type": "#page.annotation", | ||
| "description": "Create onlineMeeting", | ||
| "keywords": "", | ||
| "section": "documentation", | ||
| "tocPath": "", | ||
| "suppressions": [ | ||
| ] | ||
| } | ||
| --> |
Oops, something went wrong.