ms:rtc:saas:participantMessaging

JSON

Used to determine a participant using the instant messaging modality in a 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 application can use this resource to monitor when a participant joins or leaves the ms:rtc:saas:messaging modality.

Properties

None

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
ms:rtc:saas:participant	Represents a remote participant in a ms:rtc:saas:conversation.

Events

added
updated
deleted

Resource	Priority	Sender	Reason
ms:rtc:saas:participantMessaging	High	ms:rtc:saas:conversation	Indicates that a participant is now using the instant messaging modality.
ms:rtc:saas:participantMessaging	High	ms:rtc:saas:conversation	Indicates that the user is now using the instant messaging modality.

Resource

Priority

Sender

Reason

ms:rtc:saas:participantMessaging

High

ms:rtc:saas:conversation

Indicates that a participant is now using the instant messaging modality.

ms:rtc:saas:participantMessaging

High

ms:rtc:saas:conversation

Indicates that the user is now using the instant 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=88"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=88"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participantMessaging",
            "href" : "communication/conversations/948/participants/631/participantMessaging"
          },
          "in" : {
            "rel" : "ms:rtc:saas:localParticipant",
            "href" : "communication/conversations/948/onlineMeeting/167"
          },
          "type" : "added"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:participantMessaging	High	ms:rtc:saas:conversation	Indicates that a participant's instant messaging modality has changed.
ms:rtc:saas:participantMessaging	High	ms:rtc:saas:conversation	Indicates that the user's instant messaging modality has changed.

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:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participantMessaging",
            "href" : "communication/conversations/948/participants/631/participantMessaging"
          },
          "in" : {
            "rel" : "ms:rtc:saas:localParticipant",
            "href" : "communication/conversations/948/onlineMeeting/167"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:participantMessaging	High	ms:rtc:saas:conversation	Indicates that a participant is no longer using the instant messaging modality.
ms:rtc:saas:participantMessaging	High	ms:rtc:saas:conversation	Indicates that the user's is no longer using the instant messaging modality.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=25"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=25"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participantMessaging",
            "href" : "communication/conversations/948/participants/631/participantMessaging"
          },
          "in" : {
            "rel" : "ms:rtc:saas:localParticipant",
            "href" : "communication/conversations/948/onlineMeeting/167"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

Returns a representation of the instant messaging modality for a participant.

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.