ms:rtc:saas:onlineMeetingInvitation
- JSON
Represents an invitation to a new or existing ms:rtc:saas:onlineMeeting.
Web link
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. |
Resource description
This resource can be incoming or outgoing. If outgoing, the onlineMeetingInvitation can be created using joinOnlineMeeting. This resource helps keep track of the invitation status; for example, the invitation could be accepted, declined, or ignored. An outgoing onlineMeetingInvitation will be in the 'Connecting' state while the invitation is being processed. Note that the onlineMeetingInvitation will not complete until the user has been admitted (admit); even after the user is in the lobby, the onlineMeetingInvitation will still be in the 'Connecting' state. The onlineMeetingInvitation will complete with success if the user is admitted from the lobby or with failure if he or she is rejected. Ultimately, the onlineMeetingInvitation will complete with success or failure (in which case a reason is supplied). The onlineMeetingInvitation will only complete with success once the ms:rtc:saas:participant appears in the roster. If incoming, the onlineMeetingInvitation was created after the user accepted a ms:rtc:saas:participantInvitation. Note that this is the only way an incoming onlineMeetingInvitation can occur.
Properties
Name | Description |
---|---|
anonymousDisplayName |
Sets the display name for anonymous users. This is required for anonymous users and should not be set for authenticated users.
The maximum length is 250 characters. |
availableModalities | Gets the available modality types in the conference. |
customContent | Custom Content. |
direction | Gets the direction of the invitation. |
importance | Gets the importance. |
localParticipantDisplayName |
The display name that will be used while impersonating this particular conversation.
The maximum length is 250 characters. |
localParticipantType | The local participant type/join mode while joining the particular online meeting. |
localParticipantUri | The uri that will be impersonated for this particular conversation. |
onlineMeetingUri | The meeting URI to join. |
Gets the first message represented in this invitation. | |
operationId |
Gets the operation id as supplied by the client.
The maximum length is 50 characters. |
state | Gets the invitation state. |
subject |
Gets the subject.
The maximum length is 250 characters. |
threadId | Gets the thread id of the conversation. |
to | Gets the target of this invitation. |
Links
This resource can have the following relationships.
Link | Description |
---|---|
self | The link to the current resource. |
ms:rtc:saas:accept | Accepts an incoming invitation. |
ms:rtc:saas:cancel | Cancels the corresponding invitation. |
ms:rtc:saas:conversation | Represents the local participant's perspective on a multi-modal, multi-party communication. |
ms:rtc:saas:decline | Declines an incoming invitation. |
ms:rtc:saas:from | Represents the ms:rtc:saas:participant that sent an invitation. |
ms:rtc:saas:application | Represents your real-time communication application. |
ms:rtc:saas:from | Represents the ms:rtc:saas:participant that sent an invitation. |
Events
- started
- updated
- completed
Resource | Priority | Sender | Reason |
---|---|---|---|
ms:rtc:saas:onlineMeetingInvitation | High | ms:rtc:saas:communication | Delivered when an online meeting invitation is started. This occurs when the application joins a meeting modality. |
Sample of returned event data.
This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.
{ "_links" : { "self" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=73" }, "next" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=73" } }, "sender" : [ { "rel" : "ms:rtc:saas:communication", "href" : "communication", "events" : [ { "link" : { "rel" : "ms:rtc:saas:onlineMeetingInvitation", "href" : "communication/invitations/414" }, "type" : "started" } ] } ] }
Resource | Priority | Sender | Reason |
---|---|---|---|
ms:rtc:saas:onlineMeetingInvitation | High | ms:rtc:saas:communication | Delivered when the online meeting invitiation is updated. |
Sample of returned event data.
This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.
{ "_links" : { "self" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=11" }, "next" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=21" } }, "sender" : [ { "rel" : "ms:rtc:saas:communication", "href" : "communication", "events" : [ { "link" : { "rel" : "ms:rtc:saas:onlineMeetingInvitation", "href" : "communication/invitations/414" }, "type" : "updated" } ] } ] }
Resource | Priority | Sender | Reason |
---|---|---|---|
ms:rtc:saas:onlineMeetingInvitation | High | ms:rtc:saas:communication | Delivered when the online meeting invitation completes. |
Sample of returned event data.
This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.
{ "_links" : { "self" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=64" }, "next" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=64" } }, "sender" : [ { "rel" : "ms:rtc:saas:communication", "href" : "communication", "events" : [ { "link" : { "rel" : "ms:rtc:saas:onlineMeetingInvitation", "href" : "communication/invitations/414" }, "type" : "completed" } ] } ] }
Asynchronous reason codes
The completed event is sent on the event channel when the operation is finished. A status value of "success" indicates that the operation completed successfully.A status value of "failure" indicates that the operation failed. In case of failure, the error code and subcode are sent on the event channel.The following table shows the errors that are possible for this resource.
It is recommended that applications handle the error codes shown here. Applications can optionally display subcodes and messages in their user interface.
- Conflict
- EntityTooLarge
- Forbidden
- Gone
- Informational
- LocalFailure
- NotFound
- RemoteFailure
- ServiceFailure
- Timeout
Subcode | Reason |
---|---|
AlreadyExists | There was a problem joining the conference focus. |
AlreadyExists | |
None | There was a problem joining the conference focus. |
None | |
None | The resource is being deleted. |
TooManyGroups | |
TooManyLobbyParticipants | There are already too many partcipants in the lobby. |
TooManyParticipants | There are already too many participants in this meeting. The meeting limit has been exceeded. |
Subcode | Reason |
---|---|
None | The request was too large. |
Subcode | Reason |
---|---|
AnonymousNotAllowed | This meeting does not allow dial-out by attendees. |
DialoutNotAllowed | This meeting does not allow dial-out by attendees. |
FederationRequired | Federation required. |
InviteesOnly | User not allowed in closed meeting. |
InviteesOnly | The meeting is for invited participants only. |
ModalityNotSupported | The requested modality is not allowed in the conference. |
ModalityNotSupported | The remote client does not support the requested modality. |
None | Participant is not connected to meeting. |
Unreachable | The destination is not reachable. |
Subcode | Reason |
---|---|
CannotRedirect |
Subcode | Reason |
---|---|
Canceled | Request was canceled. |
ConnectedElsewhere | The invitation was accepted at another location. |
DerivedConversation | A derived conversation was created. |
Ended | The meeting has ended. |
MediaFallback | The invitation was cancelled by the media fallback logic. |
Missed | The invitation was missed. |
Subcode | Reason |
---|---|
Canceled | Invitation was canceled by local user. |
Declined | Invitation was declined by local user. |
None | Local Failure. |
Timeout | The invitation timed out locally. |
Subcode | Reason |
---|---|
DestinationNotFound | The destination identity could not be found. |
Subcode | Reason |
---|---|
AnotherOperationPending | Remote Failure with another operation pending. |
Busy | The remote side indicated that it is too busy at this time to accept the invitation. |
Canceled | Invitation canceled by remote user. |
Declined | Outgoing invitation declined. |
DoNotDisturb | The remote party does not want to be disturbed at this time. |
None | Remote Failure. |
NotAcceptable | The remote client is unable to accept the call at this time or context. |
NotAllowed | The remote party is not allowed to process this request due to policy. |
RepliedWithOtherModality | Replied with other modality. |
TemporarilyUnavailable | Some service is temporarily unavailable. |
TemporarilyUnavailable | Remote is temporarily unavailable. |
ThreadIdAlreadyExists | The invitation was not accepted as the remote is already in a conversation with the same thread id. |
Timeout | The operation has timed out on the callee's end. |
UnsupportedMediaType | Unsupported media. |
Subcode | Reason |
---|---|
CallbackChannelError | |
Forwarded | Forward request failed. |
InvalidExchangeServerVersion | |
MediaNegotiationFailure | Media negotation failed. |
MediaNegotiationTimeOut | Media negotation timed out. |
None | Internal Server Error. |
Timeout | The operation timed out. |
Unavailable | There is no suitable service available for this modality in this conference. |
Subcode | Reason |
---|---|
None | The operation has timed out. |
Operations
Operation description coming soon...
Request body
None
Response body
The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.
Synchronous errors
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 |
---|---|---|---|
BadRequest | 400 | None | Something is wrong with the entire request (malformed XML/JSON, for example). |
BadRequest | 400 | ParameterValidationFailure | Wrong Parameters provided for the request (for example, the requested conference subject exceeds the maximum length). |
Gone | 410 | None | The content-type is not supported. |
NotFound | 404 | None | The resource does not exist. |
ServiceFailure | 500 | InvalidExchangeServerVersion | |
Conflict | 409 | AlreadyExists | |
Conflict | 409 | TooManyGroups | |
Conflict | 409 | None | |
Gone | 410 | CannotRedirect |
Examples
Request
JSON Response
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.