ms:rtc:saas:messaging

JSON

Represents the instant messaging modality in a ms:rtc:saas:conversation.

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

The presence of messaging in a ms:rtc:saas:conversation indicates that the application can use the instant messaging modality. When present, the resource can be used to determine the status of the instant messaging channel, to start or stop instant messaging, as well as to send a single message or a typing notification. The messaging resource is updated whenever message formats are negotiated or the state and capabilities of the modality are changed.

Properties

Name	Description
negotiatedMessageFormats	A list of the message formats (MessageFormat), such as plain or html, that are negotiated for the messaging modality of a conversation.
state	The state of the modality, such as Connecting, Connected, or Disconnected.

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
ms:rtc:saas:addMessaging	Starts a ms:rtc:saas:messagingInvitation that adds the instant messaging modality to an existing ms:rtc:saas:conversation.
ms:rtc:saas:conversation	Represents the local participant's perspective on a multi-modal, multi-party communication.
ms:rtc:saas:sendMessage	Sends an instant message to the conversation participants.
ms:rtc:saas:setIsTyping	Sets the user's typing status in a ms:rtc:saas:conversation.
ms:rtc:saas:stopMessaging	Stops the corresponding instant messaging modality that is currently connecting or connected.
ms:rtc:saas:typingParticipants	Represents a view of the ms:rtc:saas:participants who are currently typing a message in a ms:rtc:saas:conversation.

Events

updated

Resource	Priority	Sender	Reason
ms:rtc:saas:messaging	High	ms:rtc:saas:conversation	Indicates that the messaging resource has changed. The application may decide to fetch the updated information.

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=23"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=23"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:messaging",
            "href" : "communication/conversations/948/messaging"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Operations

Returns a representation of the instant messaging modality in a ms:rtc:saas:conversation

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
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.