Export (0) Print
Expand All
me
to
Expand Minimize

conversation (UCWA)

Last modified: July 30, 2013

Applies to: Lync Server 2013

In this article
Web link
Resource description
Events
Operations

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

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.

A dashboard of the current capabilities that are dynamically aggregated based on the corresponding application (UCWA)'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. 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.

audienceMute

The audio mute status of the local participant (UCWA).

expirationTime

The expiry time of the conversation.

importance

The importance of the conversation.

participantCount

The number of participants in 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.

addParticipant (UCWA)

Invites a contact (UCWA) to participate into a multiparty conversation (UCWA).

applicationSharing (UCWA)

Represents the application sharing modality in the corresponding conversation.

attendees (UCWA)

Represents a view of the participants whose role is attendee in an onlineMeeting (UCWA).

audioVideo (UCWA)

Represents the audio/video modality in the corresponding conversation.

dataCollaboration (UCWA)

Represents the data collaboration modality in the corresponding conversation.

disableAudienceMuteLock (UCWA)

Disables the forced mute of attendees in a conversation.

leaders (UCWA)

Represents a view of the participant (UCWA)s whose role is leader in an onlineMeeting.

lobby (UCWA)

Represents a view of the participants who have not yet been admitted to an onlineMeeting (UCWA).

localParticipant (UCWA)

Represents the user as a local participant in a specific conversation.

messaging (UCWA)

Represents the instant messaging modality in a conversation.

onlineMeeting (UCWA)

Represents a read-only version of the onlineMeeting associated with this conversation.

phoneAudio (UCWA)

Represents the phone audio modality in a conversation.

added

Resource

Priority

Sender

Reason

conversation

High

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" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=1"
    },
    "next" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "communication",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/communication",
      "events" : [
        {
          "link" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/communication/conversations/977"
          },
          "type" : "added"
        }
      ]
    }
  ]
}

updated

Resource

Priority

Sender

Reason

conversation

High

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" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=1"
    },
    "next" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "communication",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/communication",
      "events" : [
        {
          "link" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/communication/conversations/977"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

deleted

Resource

Priority

Sender

Reason

conversation

High

communication

Delivered when the conversation resource is deleted.

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" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=1"
    },
    "next" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "communication",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/communication",
      "events" : [
        {
          "link" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/communication/conversations/977"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

GET

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.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543/communication/conversations/977 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json


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.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1692
{
  "rel" : "conversation",
  "activeModalities" : [
    "Messaging",
    "Audio",
    "Video",
    "ApplicationSharing"
  ],
  "audienceMute" : "Unknown",
  "expirationTime" : "\/Date(1326337402743)\/",
  "importance" : "Normal",
  "participantCount" : 1,
  "readLocally" : false,
  "recording" : false,
  "state" : "Disconnected",
  "subject" : "Lync",
  "threadId" : "534e445ee854436a8abe02c24985f78a",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977"
    },
    "addParticipant" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/addParticipant"
    },
    "applicationSharing" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/applicationSharing"
    },
    "attendees" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/attendees"
    },
    "audioVideo" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/audioVideo"
    },
    "dataCollaboration" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/dataCollaboration"
    },
    "disableAudienceMuteLock" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/disableAudienceMuteLock"
    },
    "enableAudienceMuteLock" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/enableAudienceMuteLock"
    },
    "leaders" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/leaders"
    },
    "lobby" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/lobby"
    },
    "localParticipant" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/onlineMeeting/263"
    },
    "messaging" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/messaging"
    },
    "onlineMeeting" : {
      "href" : "/ucwa/v1/applications/543/communication/conversations/977/onlineMeeting"
    },
    "phoneAudio" : {
      "href" : "/ucwa/v1/applications/543/communication/phoneAudio"
    }
  }
}
  

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543/communication/conversations/977 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml


XML Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 2224
<?xml version="1.0" encoding="utf-8"?>
<resource rel="conversation" href="/ucwa/v1/applications/543/communication/conversations/977" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="addParticipant" href="/ucwa/v1/applications/543/communication/conversations/977/addParticipant" />
  <link rel="applicationSharing" href="/ucwa/v1/applications/543/communication/conversations/977/applicationSharing" />
  <link rel="attendees" href="/ucwa/v1/applications/543/communication/conversations/977/attendees" />
  <link rel="audioVideo" href="/ucwa/v1/applications/543/communication/conversations/977/audioVideo" />
  <link rel="dataCollaboration" href="/ucwa/v1/applications/543/communication/conversations/977/dataCollaboration" />
  <link rel="disableAudienceMuteLock" href="/ucwa/v1/applications/543/communication/conversations/977/disableAudienceMuteLock" />
  <link rel="enableAudienceMuteLock" href="/ucwa/v1/applications/543/communication/conversations/977/enableAudienceMuteLock" />
  <link rel="leaders" href="/ucwa/v1/applications/543/communication/conversations/977/leaders" />
  <link rel="lobby" href="/ucwa/v1/applications/543/communication/conversations/977/lobby" />
  <link rel="localParticipant" href="/ucwa/v1/applications/543/communication/conversations/977/onlineMeeting/263" />
  <link rel="messaging" href="/ucwa/v1/applications/543/communication/conversations/977/messaging" />
  <link rel="onlineMeeting" href="/ucwa/v1/applications/543/communication/conversations/977/onlineMeeting" />
  <link rel="phoneAudio" href="/ucwa/v1/applications/543/communication/phoneAudio" />
  <property name="rel">conversation</property>
  <propertyList name="activeModalities">
    <item>Messaging</item>
    <item>Audio</item>
    <item>Video</item>
    <item>ApplicationSharing</item>
  </propertyList>
  <property name="audienceMute">Unknown</property>
  <property name="expirationTime">2012-01-11T19:03:22.7433336-08:00</property>
  <property name="importance">Normal</property>
  <property name="participantCount">86</property>
  <property name="readLocally">False</property>
  <property name="recording">False</property>
  <property name="state">Disconnected</property>
  <property name="subject">Lync</property>
  <property name="threadId">534e445ee854436a8abe02c24985f78a</property>
</resource>
  

DELETE

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.

Examples

JSON Request

Delete https://fe1.contoso.com:443/ucwa/v1/applications/543/communication/conversations/977 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com


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.

HTTP/1.1 204 No Content

XML Request

Delete https://fe1.contoso.com:443/ucwa/v1/applications/543/communication/conversations/977 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com


XML Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 204 No Content

Show:
© 2014 Microsoft