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

startAudioVideo2

Joseph Calev|Last Updated: 10/25/2016

Applies to: Skype for Business 2015

        Represents an operation to start AudioVideo. This token indicates 
        the user has ability to start audio, video, or audio and video.

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.

Properties

None

None

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

Operations

POST

Starts a audioVideoInvitation and creates a new conversation with a contact.

Request body

NameDescriptionRequired?
operationIdThe ID that the application supplies to correlate its request with the corresponding operation started in the event channel.The maximum length is 50 characters. StringNo
toThe contact that this invitation is to be sent to.StringYes
importanceThe conversation's importance (Importance): Normal, Urgent, or Emergency.An application can use this as a hint to inform the user.(Importance)Normal, Urgent, or EmergencyNo
subjectThe conversation's subject.The property has a maximum length of 250 characters.The maximum length is 250 characters. StringNo
threadIdThe conversation's thread ID.An application can use this ID to continue an existing conversation.StringNo
mediaOfferGets and sets the sdp offers.ExternalResourceNo
sessionContextGets the session context.The maximum length is 50 characters. StringNo
joinAudioMutedSets the audio mute status upon joining the online meeting.Nullable BooleanNo
joinVideoMutedSets the video mute status upon joining the online meeting.Nullable BooleanNo
customContentCustomContent passing with invitationExternalResourceNo

Response body

ItemDescription
audioVideoInvitationRepresents an audio-video invitation.

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
ServiceFailure500CallbackChannelErrorThe remote event channel is not reachable
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

Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/startAudioVideo HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 432
{
  "operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
  "to" : "sip : john@contoso.com",
  "importance" : "Urgent",
  "subject" : "SkypeforBusiness",
  "threadId" : "292e0aaef36c426a97757f43dda19d06",
  "sessionContext" : "8efd502350ff419cb615018ae561f97e",
  "joinAudioMuted" : false,
  "joinVideoMuted" : false,
  "_links" : {
    "mediaOffer" : {
      "href" : "data : application/sdp;base64,
      base64-encoded-sdp"
    },
    "customContent" : {
      "href" : "data : text/plain;base64,
      somebase64encodedmessage"
    }
  }
}

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 201 Created
Location: /ucwa/v1/applications/192/communication/invitations/507

XML Request

Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/startAudioVideo HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Content-Length: 569
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <property name="operationId">74cb7404e0a247d5a2d4eb0376a47dbf</property>
  <property name="to">sip:john@contoso.com</property>
  <property name="importance">Normal</property>
  <property name="subject">Skype for Business</property>
  <property name="threadId">292e0aaef36c426a97757f43dda19d06</property>
  <property name="sessionContext">8efd502350ff419cb615018ae561f97e</property>
  <property name="joinAudioMuted">False</property>
  <property name="joinVideoMuted">False</property>
</input>

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 201 Created
Location: /ucwa/v1/applications/192/communication/invitations/507
© 2017 Microsoft