conversationLog

Applies to: Skype for Business 2015

Represents the user's view of an instance of past conversation.

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.

Properties

Name Description
creationTime The time when conversation log was delivered to Exchange.
direction The direction of the call logs.
importance The importance of the past conversation.
modalities The modalities in the past conversation.
onlineMeetingUri The online meeting URI.
previewMessage The truncated messages of the conversation.
status The conversation response status.
subject The subject of the past conversation.
threadId The thread ID of the conversation.
totalRecipientsCount The number of recipients in the conversation log.
type The conversation log type.

This resource can have the following relationships.

Link Description
self The link to the current resource.
continueAudio Continues audio modality of a past conversation.
continueAudioVideo Continues audio/video modality of a past conversation.
continueMessaging Continues instant messaging modality of a past conversation.
continuePhoneAudio Continues phone audio modality of a past conversation.
continueVideo Continues video modality of a past conversation.
conversationLogTranscripts The (archived) messages from Exchange.
markAsRead Marks a conversationLog as read in Exchange.
conversationLogRecipient Represents a recipient within a conversationLog.

Azure Active Directory scopes for online applications

The user must have at least one of these scopes for operations on the resource to be allowed.

Scope Permission Description
Conversations.Initiate Initiate conversations and join meetings Allows the app to initiate instant messages, audio, video, and desktop sharing conversations; and join meetings on-behalf of the signed-in user
Conversations.Receive Receive conversation invites Allows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user

Operations

GET

Returns a representation of the past conversation instance.

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
ServiceFailure 500 InvalidExchangeServerVersion Invalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature.
Conflict 409 AlreadyExists The already exists error.
Conflict 409 TooManyGroups The too many groups error.
Conflict 409 None Un-supported Service/Resource/API error.
Gone 410 CannotRedirect Cannot redirect since there is no back up pool configured.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversationLogs/conversationLog 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: 1804
{
  "rel" : "conversationLog",
  "creationTime" : "\/Date(1474932024587)\/",
  "direction" : "Incoming",
  "importance" : "Normal",
  "modalities" : [
    "Messaging",
    "Audio",
    "Video",
    "ApplicationSharing"
  ],
  "onlineMeetingUri" : "samplevalue",
  "previewMessage" : "samplevalue",
  "status" : "Archived",
  "subject" : "Conversation with xxx.",
  "threadId" : "534e445ee854436a8abe02c24985f78a",
  "totalRecipientsCount" : 91,
  "type" : "AudioLog",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog"
    },
    "continueAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueAudio"
    },
    "continueAudioVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueAudioVideo"
    },
    "continueMessaging" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueMessaging"
    },
    "continuePhoneAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continuePhoneAudio"
    },
    "continueVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueVideo"
    },
    "conversationLogTranscripts" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/conversationLogTranscripts"
    },
    "markAsRead" : {
      "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/markAsRead"
    }
  },
  "_embedded" : {
    "conversationLogRecipient" : [
      {
        "rel" : "conversationLogRecipient",
        "displayName" : "samplevalue",
        "sipUri" : "samplevalue",
        "_links" : {
          "self" : {
            "href" : "/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/conversationLogRecipient"
          },
          "contact" : {
            "href" : "/ucwa/v1/applications/192/people/282"
          },
          "contactPhoto" : {
            "href" : "/ucwa/v1/applications/192/people/282/contactPhoto"
          },
          "contactPresence" : {
            "href" : "/ucwa/v1/applications/192/people/282/contactPresence"
          }
        }
      }
    ]
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversationLogs/conversationLog 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: 2387
<?xml version="1.0" encoding="utf-8"?>
<resource rel="conversationLog" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="continueAudio" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueAudio" />
  <link rel="continueAudioVideo" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueAudioVideo" />
  <link rel="continueMessaging" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueMessaging" />
  <link rel="continuePhoneAudio" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continuePhoneAudio" />
  <link rel="continueVideo" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/continueVideo" />
  <link rel="conversationLogTranscripts" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/conversationLogTranscripts" />
  <link rel="markAsRead" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/markAsRead" />
  <property name="rel">conversationLog</property>
  <property name="creationTime">2016-09-26T16:20:24.6066543-07:00</property>
  <property name="direction">Incoming</property>
  <property name="importance">Normal</property>
  <propertyList name="modalities">
    <item>Messaging</item>
    <item>Audio</item>
    <item>Video</item>
    <item>ApplicationSharing</item>
  </propertyList>
  <property name="onlineMeetingUri">samplevalue</property>
  <property name="previewMessage">samplevalue</property>
  <property name="status">Archived</property>
  <property name="subject">Conversation with xxx.</property>
  <property name="threadId">534e445ee854436a8abe02c24985f78a</property>
  <property name="totalRecipientsCount">85</property>
  <property name="type">AudioLog</property>
  <resource rel="conversationLogRecipient" href="/ucwa/v1/applications/192/communication/conversationLogs/conversationLog/conversationLogRecipient">
    <link rel="contact" href="/ucwa/v1/applications/192/people/282" />
    <link rel="contactPhoto" href="/ucwa/v1/applications/192/people/282/contactPhoto" />
    <link rel="contactPresence" href="/ucwa/v1/applications/192/people/282/contactPresence" />
    <property name="rel">conversationLogRecipient</property>
    <property name="displayName">samplevalue</property>
    <property name="sipUri">samplevalue</property>
  </resource>
</resource>

DELETE

Removes the past conversation instance.

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 Cannot redirect since there is no back up pool configured.

Examples

JSON Request

Delete https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversationLogs/conversationLog 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/192/communication/conversationLogs/conversationLog 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