title | description |
---|---|
startOnlineMeeting reference |
The startOnlineMeeting resource in Skype for Business 2015 creates and joins an ad-hoc multiparty conversation. |
Applies to: Skype for Business 2015
Creates and joins an ad-hoc multiparty conversation.
For more on web links, see Web links.
Name | Description |
---|---|
rel | The resource that this link points to. In JSON, this is the outer container. |
href | The location of this resource on the server, and the target of an HTTP operation. |
startOnlineMeeting allows an application to create and join an ad-hoc online meeting. This is particularly useful when a user invites a group of contacts to the meeting.
None
None
The user must have at least one of these scopes for operations on the resource to be allowed.
Scope | Permission | Description |
---|---|---|
Meetings.ReadWrite | Create Skype Meetings | Allows the app to create Skype meetings on-behalf of the signed-in user |
Starts an onlineMeetingInvitation in the event channel.
Name | Description | Required? |
---|---|---|
operationId | The ID that the application supplies to correlate its request with the corresponding operation started in the event channel.The maximum length is 50 characters. String | No |
importance | The conversation's importance (Importance): Normal, Urgent, or Emergency.An application can use this as a hint to inform the user.(Importance)Normal, Urgent, or Emergency | No |
subject | The conversation's subject.The property has a maximum length of 250 characters.The maximum length is 250 characters. String | No |
threadId | The conversation's thread ID.An application can use this ID to continue an existing conversation.String | No |
Item | Description |
---|---|
onlineMeetingInvitation | Represents an invitation to a new or existing onlineMeeting. |
The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.
Error | Code | Subcode | Description |
---|---|---|---|
ServiceFailure | 500 | CallbackChannelError | The remote event channel is not reachable |
Conflict | 409 | AlreadyExists | The already exists error. |
Conflict | 409 | TooManyGroups | The too many groups error. |
Conflict | 409 | None | Un-supported Service/Resource/API error. |
Gone | 410 | CannotRedirect | Cannot redirect since there is no back up pool configured. |
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/startOnlineMeeting HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 149
{
"operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
"importance" : "Urgent",
"subject" : "SkypeforBusiness",
"threadId" : "292e0aaef36c426a97757f43dda19d06"
}
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.
HTTP/1.1 201 Created
Location: /ucwa/v1/applications/192/communication/invitations/711
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/startOnlineMeeting HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Content-Length: 347
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<property name="operationId">74cb7404e0a247d5a2d4eb0376a47dbf</property>
<property name="importance">Urgent</property>
<property name="subject">Skype for Business</property>
<property name="threadId">292e0aaef36c426a97757f43dda19d06</property>
</input>
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.
HTTP/1.1 201 Created
Location: /ucwa/v1/applications/192/communication/invitations/711