Table of contents
me
to
TOC
Collapse the table of content
Expand the table of content

audioVideo

John Austin|Last Updated: 10/25/2016
|
2 Contributors

Applies to: Skype for Business 2015

        Represents the audio/video modality in the corresponding [conversation](conversation_ref.md).

For more on web links, see Web links.

NameDescription
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

In this version of the API, establishing audio/video calls is not supported.

Properties

NameDescription
stateThe state of the modality, such as Connecting, Connected, or Disconnected.
supportsReplacesThe replacementId for the audioVideo resource that can be used while doing consultative transfer
videoSourcesAllowedThe video sources allowed to contribute to the gallery (VideoSourcesAllowed).

This resource can have the following relationships.

LinkDescription
selfThe link to the current resource.
addAudioRepresents an operation to add audio to an existing conversation.
addAudioVideoRepresents an operation to add audio/video to an existing conversation.
addVideoRepresents an operation to add video to an existing conversation.
audioVideoPoliciesThe AudioVideoPolicies resource captures all audio-video policies that may applyto UCWA clients.
audioVideoSessionRepresents a session in an audioVideo call.
conversationRepresents the local participants perspective on a multi-modal, multi-party communication.
escalateAudioRepresents an operation to escalate audio modality from P2P to conferencing
escalateAudioVideoRepresents an operation to escalate both audio and video modality from P2P to conferencing.The client must provide sdp for both modalities.
replaceWithPhoneAudioAdds phone audio to an existing conversation.
reportMediaDiagnosticsRepresents RreportMediaDiagnostics operation.
stopAudioRepresents an operation to stop established AudioVideo. This token indicatesThe user has ability to renegotiate only audio.
stopAudioVideoRepresents an operation to stop established AudioVideo. This token indicatesthe user has ability to renegotiate both audio and video.
stopVideoRepresents an operation to stop established AudioVideo. This token indicatesThe user has ability to renegotiate only video.
videoFreezeRepresents a link resource to indicate local participant's video should be freezed
videoLockedOnParticipantRepresents the participant on whom the video spotlight is locked in an onlineMeeting.

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.

ScopePermissionDescription
Conversations.InitiateInitiate conversations and join meetingsAllows the app to initiate instant messages, audio, video, and desktop sharing conversations; and join meetings on-behalf of the signed-in user
Conversations.ReceiveReceive conversation invitesAllows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user

Events

Updated

ResourcePrioritySenderReason
audioVideoHighconversationIndicates that the audio/video modality was 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=1" }, "next" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2" } }, "sender" : [ { "rel" : "conversation", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137", "events" : [ { "link" : { "rel" : "audioVideo", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/audioVideo" }, "type" : "updated" } ] } ] }

Operations

GET

Returns a representation of the audio/video modality in the corresponding 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.

ErrorCodeSubcodeDescription
ServiceFailure500InvalidExchangeServerVersionInvalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature.
Conflict409AlreadyExistsThe already exists error.
Conflict409TooManyGroupsThe too many groups error.
Conflict409NoneUn-supported Service/Resource/API error.
Gone410CannotRedirectCannot redirect since there is no back up pool configured.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/audioVideo 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: 1815
{
  "rel" : "audioVideo",
  "state" : "Connected",
  "supportsReplaces" : "None",
  "videoSourcesAllowed" : "PresentersOnly",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo"
    },
    "addAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/addAudio"
    },
    "addAudioVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/addAudioVideo"
    },
    "addVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/addVideo"
    },
    "audioVideoPolicies" : {
      "href" : "/ucwa/v1/applications/192/communication/audioVideoPolicies"
    },
    "audioVideoSession" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/audioVideoSession"
    },
    "conversation" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137"
    },
    "escalateAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/escalateAudio"
    },
    "escalateAudioVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/escalateAudioVideo"
    },
    "replaceWithPhoneAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/replaceWithPhoneAudio"
    },
    "reportMediaDiagnostics" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/reportMediaDiagnostics"
    },
    "stopAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/stopAudio"
    },
    "stopAudioVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/stopAudioVideo"
    },
    "stopVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/stopVideo"
    },
    "videoFreeze" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/videoFreeze"
    },
    "videoLockedOnParticipant" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/videoLockedOnParticipant"
    }
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/audioVideo 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: 2134
<?xml version="1.0" encoding="utf-8"?>
<resource rel="audioVideo" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="addAudio" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/addAudio" />
  <link rel="addAudioVideo" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/addAudioVideo" />
  <link rel="addVideo" href="/ucwa/v1/applications/192/communication/addVideo" />
  <link rel="audioVideoPolicies" href="/ucwa/v1/applications/192/communication/audioVideoPolicies" />
  <link rel="audioVideoSession" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/audioVideoSession" />
  <link rel="conversation" href="/ucwa/v1/applications/192/communication/conversations/137" />
  <link rel="escalateAudio" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/escalateAudio" />
  <link rel="escalateAudioVideo" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/escalateAudioVideo" />
  <link rel="replaceWithPhoneAudio" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/replaceWithPhoneAudio" />
  <link rel="reportMediaDiagnostics" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/reportMediaDiagnostics" />
  <link rel="stopAudio" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/stopAudio" />
  <link rel="stopAudioVideo" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/stopAudioVideo" />
  <link rel="stopVideo" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/stopVideo" />
  <link rel="videoFreeze" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/videoFreeze" />
  <link rel="videoLockedOnParticipant" href="/ucwa/v1/applications/192/communication/conversations/137/audioVideo/videoLockedOnParticipant" />
  <property name="rel">audioVideo</property>
  <property name="state">Connected</property>
  <property name="supportsReplaces">None</property>
  <property name="videoSourcesAllowed">PresentersOnly</property>
</resource>
© 2017 Microsoft