Skype for Business - conversation Resource

conversation

  • JSON
  • XML

Represents the local participants perspective on a multi-modal, multi-party communication.

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

A dashboard of the current capabilities that are dynamically aggregated based on the corresponding application's permissions, the user's role, and the capabilities of the remote participants and service components that are 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 is created by the server following an invitation. Note that terminating a conversation simply means that the user is leaving the communication; other participants might still be able to communicate.

Properties

Name Description
activeModalities The active media in the conversation.
audienceMessaging Whether the audience messaging modality is enabled/disabled in the current conversation.
audienceMute The audio mute status of the local participant.
created Creation time stamp in UTC.
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
selfThe link to the current resource.
addParticipant Invites a contact to participate in a multiparty conversation.
applicationSharing Represents the application sharing modality in the corresponding conversation.
attendees Represents a view of the participants having the attendee role in an onlineMeeting.
audioVideo Represents the audio/video modality in the corresponding conversation.
dataCollaboration Represents the data collaboration modality in the corresponding conversation.
disableAudienceMessaging Disables the messaging modality for all members of a conversation.
disableAudienceMuteLock Disables the forced mute of attendees in a conversation.
enableAudienceMessaging Enables the messaging modality for all members of a conversation.
enableAudienceMuteLock Enables the forced mute of attendees in a conversation.
leaders Represents a view of the participants in the leader role in an onlineMeeting.
lobby Represents a view of the participants who have not yet been admitted to an onlineMeeting.
localParticipant Represents the user as a local participant in a specific conversation.
messaging Represents the instant messaging modality in a conversation.
onlineMeeting Represents a read-only version of the onlineMeeting associated with this conversation.
phoneAudio Represents the phone audio modality in a conversation.

Events

  • added
  • updated
  • deleted
Resource Priority Sender Reason
conversationHighcommunication 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=68"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=68"
    }
  },
  "sender" : [
    {
      "rel" : "communication",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/communication",
      "events" : [
        {
          "link" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314"
          },
          "type" : "added"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
conversationHighcommunication 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=74"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=74"
    }
  },
  "sender" : [
    {
      "rel" : "communication",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/communication",
      "events" : [
        {
          "link" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
conversationHighcommunication Delivered when the conversation resource is deleted.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=76"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=76"
    }
  },
  "sender" : [
    {
      "rel" : "communication",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/communication",
      "events" : [
        {
          "link" : {
            "rel" : "conversation",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314"
          },
          "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 Description
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Request

Get https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314 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: 1969
{
  "rel" : "conversation",
  "activeModalities" : [
    "Messaging",
    "Audio",
    "Video",
    "ApplicationSharing"
  ],
  "audienceMessaging" : "Enabled",
  "audienceMute" : "Unknown",
  "created" : "\/Date(1430220844745)\/",
  "expirationTime" : "\/Date(1326337402743)\/",
  "importance" : "Normal",
  "participantCount" : 14,
  "readLocally" : false,
  "recording" : false,
  "state" : "Disconnected",
  "subject" : "SkypeforBusiness",
  "threadId" : "534e445ee854436a8abe02c24985f78a",
  "_links" : {
    "self" : {
      "href" : "//v1/applications/970/communication/conversations/314"
    },
    "addParticipant" : {
      "href" : "//v1/applications/970/communication/conversations/314/addParticipant"
    },
    "applicationSharing" : {
      "href" : "//v1/applications/970/communication/conversations/314/applicationSharing"
    },
    "attendees" : {
      "href" : "//v1/applications/970/communication/conversations/314/attendees"
    },
    "audioVideo" : {
      "href" : "//v1/applications/970/communication/conversations/314/audioVideo"
    },
    "dataCollaboration" : {
      "href" : "//v1/applications/970/communication/conversations/314/dataCollaboration"
    },
    "disableAudienceMessaging" : {
      "href" : "//v1/applications/970/communication/conversations/314/messaging/disableAudienceMessaging"
    },
    "disableAudienceMuteLock" : {
      "href" : "//v1/applications/970/communication/conversations/314/disableAudienceMuteLock"
    },
    "enableAudienceMessaging" : {
      "href" : "//v1/applications/970/communication/conversations/314/messaging/enableAudienceMessaging"
    },
    "enableAudienceMuteLock" : {
      "href" : "//v1/applications/970/communication/conversations/314/enableAudienceMuteLock"
    },
    "leaders" : {
      "href" : "//v1/applications/970/communication/conversations/314/leaders"
    },
    "lobby" : {
      "href" : "//v1/applications/970/communication/conversations/314/lobby"
    },
    "localParticipant" : {
      "href" : "//v1/applications/970/communication/conversations/314/onlineMeeting/989"
    },
    "messaging" : {
      "href" : "//v1/applications/970/communication/conversations/314/messaging"
    },
    "onlineMeeting" : {
      "href" : "//v1/applications/970/communication/conversations/314/onlineMeeting"
    },
    "phoneAudio" : {
      "href" : "//v1/applications/970/communication/phoneAudio"
    }
  }
}
  

Request

Get https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314 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: 2572
<?xml version="1.0" encoding="utf-8"?>
<resource rel="conversation" href="//v1/applications/970/communication/conversations/314" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="addParticipant" href="//v1/applications/970/communication/conversations/314/addParticipant" />
  <link rel="applicationSharing" href="//v1/applications/970/communication/conversations/314/applicationSharing" />
  <link rel="attendees" href="//v1/applications/970/communication/conversations/314/attendees" />
  <link rel="audioVideo" href="//v1/applications/970/communication/conversations/314/audioVideo" />
  <link rel="dataCollaboration" href="//v1/applications/970/communication/conversations/314/dataCollaboration" />
  <link rel="disableAudienceMessaging" href="//v1/applications/970/communication/conversations/314/messaging/disableAudienceMessaging" />
  <link rel="disableAudienceMuteLock" href="//v1/applications/970/communication/conversations/314/disableAudienceMuteLock" />
  <link rel="enableAudienceMessaging" href="//v1/applications/970/communication/conversations/314/messaging/enableAudienceMessaging" />
  <link rel="enableAudienceMuteLock" href="//v1/applications/970/communication/conversations/314/enableAudienceMuteLock" />
  <link rel="leaders" href="//v1/applications/970/communication/conversations/314/leaders" />
  <link rel="lobby" href="//v1/applications/970/communication/conversations/314/lobby" />
  <link rel="localParticipant" href="//v1/applications/970/communication/conversations/314/onlineMeeting/989" />
  <link rel="messaging" href="//v1/applications/970/communication/conversations/314/messaging" />
  <link rel="onlineMeeting" href="//v1/applications/970/communication/conversations/314/onlineMeeting" />
  <link rel="phoneAudio" href="//v1/applications/970/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="audienceMessaging">Enabled</property>
  <property name="audienceMute">Unknown</property>
  <property name="created">2015-04-28T04:34:04.7615960-07:00</property>
  <property name="expirationTime">2012-01-11T19:03:22.7433336-08:00</property>
  <property name="importance">Normal</property>
  <property name="participantCount">71</property>
  <property name="readLocally">False</property>
  <property name="recording">False</property>
  <property name="state">Disconnected</property>
  <property name="subject">Skype for Business</property>
  <property name="threadId">534e445ee854436a8abe02c24985f78a</property>
</resource>
  

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

Request

Delete https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314 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

  

Request

Delete https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314 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