Skype for Business - derivedConversation Resource

derivedConversation

  • JSON
  • XML

Represents a related conversation with a different participant than the one of the original conversation.

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 derivedConversation is created when a new modality is added to an existing conversation but is answered by another participant (perhaps due to simultaneousRingSettings).

Properties

None

Links

This resource can have the following relationships.

Link Description
selfThe link to the current resource.

Operations

  • GET

Returns a representation of a related conversation with a different participant than the original 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 Description
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Request

Get https://fe1.contoso.com:443//v1/applications/970/communication/invitations/127/derivedConversation 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(1430220844855)\/",
  "expirationTime" : "\/Date(1326337402743)\/",
  "importance" : "Normal",
  "participantCount" : 73,
  "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/invitations/127/derivedConversation 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.8553471-07:00</property>
  <property name="expirationTime">2012-01-11T19:03:22.7433336-08:00</property>
  <property name="importance">Normal</property>
  <property name="participantCount">79</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>