{"id":3199,"date":"2019-07-02T16:49:45","date_gmt":"2019-07-02T23:49:45","guid":{"rendered":"https:\/\/developer.microsoft.com\/en-us\/office\/blogs\/?p=3199"},"modified":"2019-07-02T16:49:45","modified_gmt":"2019-07-02T23:49:45","slug":"breaking-changes-calls-and-online-meetings-api-updates-in-microsoft-graph-beta","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/breaking-changes-calls-and-online-meetings-api-updates-in-microsoft-graph-beta\/","title":{"rendered":"Breaking changes: Calls and online meetings API updates in Microsoft Graph beta"},"content":{"rendered":"
\n

We’re announcing several changes to the calls and online meetings APIs in Microsoft Graph beta, including a few breaking changes. Changes might affect existing applications that use the\u00a0\/beta<\/code>\u00a0calls and online meetings APIs. We expect the breaking change to be fully deployed by the middle of July 2019.<\/p>\n<\/div>\n

\n

call entity updates<\/h2>\n<\/div>\n
\n

Adding new property mediaState to the call entity<\/h3>\n

We’re adding a new mediaState<\/strong>\u00a0property to the call entity. This new property will include the activeness info of different modalities.<\/p>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
mediaState<\/code><\/td>\nmicrosoft.graph.callMediaState<\/code><\/td>\nNo<\/td>\nCall media state.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

The microsoft.graph.callMediaState is a new complex type with one property: audio<\/strong>.<\/p>\n\n\n\n\n
Property<\/td>\nType<\/td>\nDescription<\/td>\nRequired<\/td>\nReadOnly<\/td>\n<\/tr>\n
audio<\/code><\/td>\nmicrosoft.graph.mediaState<\/code><\/td>\nThe call media state<\/td>\nNo<\/td>\nYes<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

The microsoft.graph.mediaState is a new enum with two values.<\/p>\n\n\n\n\n\n
Value<\/td>\nDescription<\/td>\n<\/tr>\n
active<\/code><\/td>\nCall media state active.<\/td>\n<\/tr>\n
inactive<\/code><\/td>\nCall media state inactive.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Adding new property to complex type meetingCapability<\/h3>\n\n\n\n\n
Property<\/td>\nType<\/td>\nDescription<\/td>\nRequired<\/td>\nRead Only<\/td>\n<\/tr>\n
allowAnonymousUsersToStartMeeting<\/code><\/td>\nEdm.Boolean<\/code><\/td>\nA value indicating whether to allow anonymous users to start meeting.<\/td>\nNo<\/td>\nNo<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Renaming property error and ringningTimeoutInSeconds<\/h3>\n\n\n\n\n\n
Parameter old name<\/td>\nParameter new name<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
error<\/code><\/td>\nresultInfo<\/code><\/td>\nmicrosoft.graph.resultInfo<\/code><\/td>\nRename error to resultInfo, because it contains more info than just error.<\/td>\n<\/tr>\n
ringningTimeoutInSeconds<\/code><\/td>\nringingTimeoutInSeconds<\/code><\/td>\nEdm.Int32<\/code><\/td>\nThere is a typo in the name.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Add value to enum routingPolicy and make this enum extensible<\/h3>\n

The enum routingPolicy<\/strong> is now extensible to be able to add new values in the future.<\/p>\n\n\n\n\n\n
Value<\/td>\nDescription<\/td>\n<\/tr>\n
preferSfB<\/code><\/td>\n(Same enum value as preferSkypeForBusiness, this to be depricated). Some clients prefer Sfb over Teams, When this is set, calls would be routed to Sfb clients.<\/td>\n<\/tr>\n
preferSkypeForBusiness<\/code><\/td>\nSome clients prefer Sfb over Teams, When this is set, calls would be routed to Sfb clients.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

audioRoutingGroup entity updates<\/h2>\n<\/div>\n
\n

Removing property owner from audioRoutingGroup entity<\/h3>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
owner<\/code><\/td>\nstring<\/code><\/td>\nOwner is not supported anymore.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

commsOperation entity updates<\/h2>\n<\/div>\n
\n

Renaming property errorInfo<\/h3>\n\n\n\n\n
Parameter old name<\/td>\nParameter new name<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
errorInfo<\/code><\/td>\nresultInfo<\/code><\/td>\nmicrosoft.graph.resultInfo<\/code><\/td>\nRename errorInfo to resultInfo, because it contains more info than just error.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

playPromptOperation Entity<\/h2>\n<\/div>\n
\n

Remove prompts property from playPromptOperation entity<\/h3>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
prompts<\/code><\/td>\nCollection(microsoft.graph.prompt)<\/code><\/td>\nWe are moving away from returning the input parameters in the operation. Only output parameters or parameters that can change will be included.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Change type of completionReason property<\/h3>\n\n\n\n\n
Parameter name<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
completionReason<\/code><\/td>\nOld<\/strong>: microsoft.graph.completionReason<\/code><\/p>\n

New<\/strong>:\u00a0microsoft.graph.playPromptCompletionReason<\/code><\/td>\n

Changed completionReason to be specific to playPrompt, as it was not a generic enumeration.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

recordOperation entity update<\/h2>\n<\/div>\n
\n

Remove input parameters from recordOperation<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
prompts<\/code><\/td>\nCollection(microsoft.graph.prompt)<\/code><\/td>\nprompts is exposed in playPromptAction.<\/td>\n<\/tr>\n
bargeInAllowed<\/code><\/td>\nEdm.Boolean<\/code><\/td>\nExposed in playPromptAction.<\/td>\n<\/tr>\n
initialSilenceTimeoutInSeconds<\/code><\/td>\nEdm.Int32<\/code><\/td>\nExposed in playPromptAction.<\/td>\n<\/tr>\n
maxSilenceTimeoutInSeconds<\/code><\/td>\nEdm.Int32<\/code><\/td>\nExposed in playPromptAction.<\/td>\n<\/tr>\n
maxRecordDurationInSeconds<\/code><\/td>\nEdm.Int32<\/code><\/td>\nExposed in playPromptAction.<\/td>\n<\/tr>\n
playBeep<\/code><\/td>\nEdm.Boolean<\/code><\/td>\nExposed in playPromptAction.<\/td>\n<\/tr>\n
streamWhileRecording<\/code><\/td>\nEdm.Boolean<\/code><\/td>\nExposed in playPromptAction.<\/td>\n<\/tr>\n
stopTones<\/code><\/td>\nCollection(Edm.String)<\/code><\/td>\nExposed in playPromptAction.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Rename properties<\/h3>\n\n\n\n\n\n
Parameter Old Name<\/td>\nParameter New Name<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
recordResourceLocation<\/code><\/td>\nrecordingLocation<\/code><\/td>\nstring<\/code><\/td>\nNo<\/td>\nThe record resource location.<\/td>\n<\/tr>\n
recordResourceAccessToken<\/code><\/td>\nrecordingAccessToken<\/code><\/td>\nstring<\/code><\/td>\nNo<\/td>\nThe record resource access token..<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

onlineMeeting entity updates<\/h2>\n<\/div>\n
\n

Rename properties in onlineMeeting entity to match Graph specifications.<\/h3>\n\n\n\n\n\n\n\n\n
Parameter Old Name<\/td>\nParameter New Name<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
creationTime<\/code><\/td>\ncreationDateTime<\/code><\/td>\nEdm.DateTimeOffset<\/code><\/td>\nSet all properties with DateTime type as xxxDateTime.<\/td>\n<\/tr>\n
startTime<\/code><\/td>\nstartDateTime<\/code><\/td>\nEdm.DateTimeOffset<\/code><\/td>\nSet all properties with DateTime type as xxxDateTime.<\/td>\n<\/tr>\n
endTime<\/code><\/td>\nendDateTime<\/code><\/td>\nEdm.DateTimeOffset<\/code><\/td>\nSet all properties with DateTime type as xxxDateTime.<\/td>\n<\/tr>\n
canceledTime<\/code><\/td>\ncanceledDateTime<\/code><\/td>\nEdm.DateTimeOffset<\/code><\/td>\nSet all properties with DateTime type as xxxDateTime.<\/td>\n<\/tr>\n
expirationTime<\/code><\/td>\nexpirationDateTime<\/code><\/td>\nEdm.DateTimeOffset<\/code><\/td>\nSet all properties with DateTime type as xxxDateTime.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Remove meetingInfo from onlineMeeting entity<\/h3>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nDescription<\/td>\n<\/tr>\n
meetingInfo<\/code><\/td>\nMicrosoft.Graph.MeetingInfo<\/code><\/td>\nDeprecated. Use Participants.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Adding new properties to onlineMeeting entity<\/h3>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
capabilities<\/code><\/td>\nCollection(microsoft.graph.meetingCapabilities)<\/code><\/td>\nNo<\/td>\nMeeting capabilities.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

New enum meetingCapabilities<\/h3>\n\n\n\n\n\n
Value<\/td>\nDescription<\/td>\n<\/tr>\n
questionAndAnswer<\/code><\/td>\nValue indicating whether Qna is enabled.<\/td>\n<\/tr>\n
unknownFutureValue<\/code><\/td>\nFor extensible enum.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

New property videoTeleconferenceId<\/h3>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
videoTeleconferenceId<\/code><\/td>\nstring<\/code><\/td>\nNo<\/td>\nThe identifier that can be used by VTC devices to access the meeting.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Update enum meetingType (existing enum) (**new from last API review)<\/h3>\n\n\n\n\n\n\n\n
Value<\/td>\nDescription<\/td>\n<\/tr>\n
meetNow<\/code><\/td>\nThe meeting is an ad hoc meeting.<\/td>\n<\/tr>\n
scheduled<\/code>\u00a0(renamed from calendar<\/strong>)<\/td>\nThe meeting is a scheduled meeting.<\/td>\n<\/tr>\n
recurring<\/code><\/td>\nThe meeting is a recurring meeting.<\/td>\n<\/tr>\n
broadcast<\/code><\/td>\nThe meeting is a broadcast type meeting.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Adding new properties to complex type meetingParticipants<\/h3>\n\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
producers<\/code><\/td>\nCollection(microsoft.graph.meetingParticipantInfo)<\/code><\/td>\nNo<\/td>\nProducer role, for webinar meeting only.<\/td>\n<\/tr>\n
contributors<\/code><\/td>\nCollection(microsoft.graph.meetingParticipantInfo)<\/code><\/td>\nNo<\/td>\nContributors role, for webinar meeting only.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Changes to action types<\/h2>\n<\/div>\n
\n

Reject action<\/h3>\n

Adding new parameter CallbackUri to Reject action, allowing bots to receive notifications at a custom callback for the call after the call is rejected.<\/p>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
CallbackUri<\/code><\/td>\nstring<\/code><\/td>\nNo<\/td>\nThe CallbackUri allows bots to receive notifications for the call after the call is rejected.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n

Request<\/h4>\n

The following example shows the request.<\/p>\n

\n
POST \/app\/calls\/421f0a00-ba46-45bf-b034-d49ab0961b54\/microsoft.graph.reject\nContent-Type: application\/json; charset=utf-8\n{\n  \"reason\": \"busy\",\n  \"callbackUri\": \"https:\/\/paywu-bot.frontend.skype-graph-test.net\/24701998-1a73-4d42-8085-bf46ed0ae039\"\n}<\/pre>\n
In the request body, supply a JSON representation of the RejectAction object.<\/p>\n
Response<\/h4>\n
HTTP\/1.1 202 Accepted<\/pre>\n
 <\/p>\n<\/div>\n<\/div>\n
\n
Redirect action<\/h3>\n
Adding new parameter CallbackUri to redirect action, allowing bots to receive notifications at a custom callback for the call while the call is being redirected.<\/p>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
CallbackUri<\/code><\/td>\nstring<\/code><\/td>\nNo<\/td>\nThe CallbackUri allows bots to receive notifications for the call while the call is being redirected.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
\n
Play Prompt action<\/h3>\n
Added\u00a0loop<\/code>\u00a0parameter to specify that this play sequence should be looped indefinitely. This replaces the\u00a0MediaPrompt.Loop<\/code>\u00a0property that allowed bots to specify a loop count but only for a single prompt.<\/p>\n\n\n\n\n
Parameter<\/td>\nType<\/td>\nRequired?<\/td>\nDescription<\/td>\n<\/tr>\n
Loop<\/code><\/td>\nBoolean<\/code><\/td>\nNo<\/td>\nFlag indicating whether prompt sequence needs to be played in loop or not.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
We’re announcing several changes to the calls and online meetings APIs in Microsoft Graph beta, including a few breaking changes.<\/p>\n","protected":false},"author":69077,"featured_media":25159,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[3],"tags":[],"class_list":["post-3199","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-microsoft-graph"],"acf":[],"blog_post_summary":"
We’re announcing several changes to the calls and online meetings APIs in Microsoft Graph beta, including a few breaking changes.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/3199","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/users\/69077"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/comments?post=3199"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/3199\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media\/25159"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media?parent=3199"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/categories?post=3199"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/tags?post=3199"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}