ms:rtc:saas:audioVideoFlow

JSON

Flow resource.

Web link

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
state	The state of the flow, such as Connected, or Disconnected.

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
ms:rtc:saas:audioVideo	Represents the audio/video modality in the corresponding ms:rtc:saas:conversation.
ms:rtc:saas:playPrompt	Represents an operation to play a prompt.
ms:rtc:saas:videoSubscribe	Represents an operation to subscribe to a participant's video.

Events

added
updated
deleted

Resource	Priority	Sender	Reason
ms:rtc:saas:audioVideoFlow	High	ms:rtc:saas:audioVideo	Delivered when a new AudioVideoFlowResource is added.

Resource

Priority

Sender

Reason

ms:rtc:saas:audioVideoFlow

High

ms:rtc:saas:audioVideo

Delivered when a new AudioVideoFlowResource 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=48"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=48"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:audioVideo",
      "href" : "communication/conversations/948/audioVideo",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:audioVideoFlow",
            "href" : "audioVideoFlow"
          },
          "type" : "added"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:audioVideoFlow	High	ms:rtc:saas:audioVideo	Delivered when the AudioVideoFlowResource 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=76"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=76"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:audioVideo",
      "href" : "communication/conversations/948/audioVideo",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:audioVideoFlow",
            "href" : "audioVideoFlow"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:audioVideoFlow	High	ms:rtc:saas:conversation	Delivered when the AudioVideoFlowResource is deleted.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=42"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=42"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:audioVideoFlow",
            "href" : "audioVideoFlow"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

Operation description coming soon...

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
ServiceFailure	500	InvalidExchangeServerVersion
Conflict	409	AlreadyExists
Conflict	409	TooManyGroups
Conflict	409	None
Gone	410	CannotRedirect

Examples

Request

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.