ms:rtc:saas:conversation

JSON

Represents the local participant's perspective on a multi-modal, multi-party communication.

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

A dashboard of the current capabilities that are dynamically aggregated based on the corresponding ms:rtc:saas:application's permissions, the user's role, the capabilities of the remote participants and service components involved in the communication. While a conversation can be multi-modal and multi-party, it can also represent a basic call with one remote participant. A conversation gets created by the server following an invitation. Please note that terminating a conversation simply means that the user is leaving the communication; other participants may still communicate.

Properties

Name	Description
activeModalities	The active media in the conversation.
expirationTime	The expiry time of the conversation.
importance	The importance of the conversation.
readLocally	Whether the conversation was read locally.
recording	Whether the conversation is being recorded.
state	The state of the conversation.
subject	The subject of the conversation.
threadId	The thread ID of the conversation.

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
ms:rtc:saas:addParticipant	Invites a contact to participate into a multiparty ms:rtc:saas:conversation.
ms:rtc:saas:attendees	Represents a view of the ms:rtc:saas:participants whose role is attendee in an ms:rtc:saas:onlineMeeting.
ms:rtc:saas:audioVideo	Represents the audio/video modality in the corresponding ms:rtc:saas:conversation.
ms:rtc:saas:conversationBridge	Represents the broadcasting controls and capabilities of a conversation.
ms:rtc:saas:conversationExtension	Represents the broadcasting controls and capabilities of a conversation.
ms:rtc:saas:enableConversationExtension	EnableConversationExtensionResource
ms:rtc:saas:leaders	Represents a view of the ms:rtc:saas:participants whose role is leader in an ms:rtc:saas:onlineMeeting.
ms:rtc:saas:localParticipant	Represents the user as a local ms:rtc:saas:participant in a specific ms:rtc:saas:conversation.
ms:rtc:saas:messaging	Represents the instant messaging modality in a ms:rtc:saas:conversation.
ms:rtc:saas:onlineMeeting	Represents a read-only version of the ms:rtc:saas:onlineMeeting associated with this ms:rtc:saas:conversation.
ms:rtc:saas:participants	A collection of participant resources.
ms:rtc:saas:localParticipant	Represents the user as a local ms:rtc:saas:participant in a specific ms:rtc:saas:conversation.

Events

added
updated
deleted

Resource	Priority	Sender	Reason
ms:rtc:saas:conversation	High	ms:rtc:saas:communication	Delivered when a new conversation resource is added.

Resource

Priority

Sender

Reason

ms:rtc:saas:conversation

High

ms:rtc:saas:communication

Delivered when a new conversation resource is added.

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

Resource	Priority	Sender	Reason
ms:rtc:saas:conversation	High	ms:rtc:saas:communication	Delivered when the conversation resource 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=97"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=97"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:conversation",
            "href" : "communication/conversations/948"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:conversation	High	ms:rtc:saas:communication	Delivered when the conversation resource is deleted.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=50"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=50"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:communication",
      "href" : "communication",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:conversation",
            "href" : "communication/conversations/948"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

GET
DELETE

Returns a representation of the local participant's perspective on a multi-modal, multi-party communication.

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.

Removes the user from the communication which ends the conversation. This operation tears down all active modalities.

Request body

None

Response body

None

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