ms:rtc:saas:participantInvitation

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=67"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=67"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participantInvitation",
            "href" : "communication/invitations/491"
          },
          "type" : "started"
        }
      ]
    }
  ]
}

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=29"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=29"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participantInvitation",
            "href" : "communication/invitations/491"
          },
          "type" : "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=79"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=79"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participantInvitation",
            "href" : "communication/invitations/491"
          },
          "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

Subcode	Reason
AlreadyExists
AlreadyExists	There was a problem joining the conference focus.
None
None	There was a problem joining the conference focus.
None	The resource is being deleted.
TooManyGroups

• EntityTooLarge

Subcode	Reason
None	The request was too large.

• Forbidden

Subcode	Reason
AnonymousNotAllowed	This meeting does not allow dial-out by attendees.
DialoutNotAllowed	This meeting does not allow dial-out by attendees.
DialoutNotAllowed	Returned when an anonymous user or an attendee is not allowed to add a participant via telephone number.
FederationRequired	Federation required.
InviteesOnly	User not allowed in closed meeting.
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.

• Gone

Subcode	Reason
CannotRedirect

• Informational

Subcode	Reason
Canceled	Request was canceled.
ConnectedElsewhere	The invitation was accepted at another location.
DerivedConversation	A derived conversation was created.
MediaFallback	The invitation was cancelled by the media fallback logic.
Missed	The invitation was missed.

• LocalFailure

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.

• NotFound

Subcode	Reason
DestinationNotFound	The destination identity could not be found.

• RemoteFailure

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	Remote is temporarily unavailable.
TemporarilyUnavailable	Some service 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.

• ServiceFailure

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.

• Timeout

Subcode	Reason
None	The operation has timed out.