ms:rtc:saas:messagingInvitation

Represents an invitation to a ms:rtc:saas:conversation for the ms:rtc:saas:messaging modality.

Web link

For more on web links, see Web Links.

Name Description
relThe resource that this link points to. In JSON, this is the outer container.
hrefThe 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 messagingInvitation can be created in one of two ways. First, startMessaging will create a messagingInvitation that also creates a ms:rtc:saas:conversation. Second, ms:rtc:saas:addMessaging will attempt to add the ms:rtc:saas:messaging modality to an existing ms:rtc:saas:conversation. This resource helps keep track of the invitation status; for example, the invitation could be accepted, declined, or ignored. An outgoing messagingInvitation will be in the 'Connecting' state while waiting for the recipient to accept or decline it; during this time, the messagingInvitation can be terminated using ms:rtc:saas:cancel. Note that if the recipient does not respond in approximately thirty seconds, the messagingInvitation will complete with failure. Ultimately, the messagingInvitation will complete with success or failure (in which case a reason is supplied). If the messagingInvitation succeeds, the participant that accepts will be provided (ms:rtc:saas:acceptedByParticipant). If incoming, the messagingInvitation may either create a brand new ms:rtc:saas:conversation or attempt to add the ms:rtc:saas:messaging modality to an existing ms:rtc:saas:conversation.

Properties

Name Description
customContent Custom Content.
direction Gets the direction of the invitation.
importance Gets the importance.
ms:rtc:saas:message 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
selfThe link to the current resource.
ms:rtc:saas:acceptAndBridge accept an incoming invitation and bridge with conference
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:messaging Represents the instant messaging modality in a ms:rtc:saas:conversation.
ms:rtc:saas:startAdhocMeeting Represents an link to a resource that, if this invitation succeeded, will be replaced
ms:rtc:saas:acceptedByParticipant Represents the remote participant who accepted the invitation of the user.
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

Resource Priority Sender Reason
ms:rtc:saas:messagingInvitationHighms:rtc:saas:communication Delivered when a messaging invitation is started. This occurs when the application starts a messaging 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=63"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=63"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:messagingInvitation",
            "href" : "communication/invitations/928"
          },
          "type" : "started"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
ms:rtc:saas:messagingInvitationHighms:rtc:saas:communication Delivered when the messaging 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=53"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=53"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:messagingInvitation",
            "href" : "communication/invitations/928"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
ms:rtc:saas:messagingInvitationHighms:rtc:saas:communication Delivered when the messaging 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=22"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=22"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:messagingInvitation",
            "href" : "communication/invitations/928"
          },
          "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.

Operations

Returns a representation of an invitation to a ms:rtc:saas:conversation for the ms:rtc:saas:messaging modality.

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
BadRequest400None Something is wrong with the entire request (malformed XML/JSON, for example).
BadRequest400ParameterValidationFailure Wrong Parameters provided for the request (for example, the requested conference subject exceeds the maximum length).
Gone410None The content-type is not supported.
NotFound404None The resource does not exist.
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None
Gone410CannotRedirect

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.

Microsoft Confidential. © 2013 Microsoft Corporation. All rights reserved. By using or providing feedback on these materials, you agree to the attached license agreement.