audioVideoInvitation

Article
04/17/2022

Applies to: Skype for Business 2015

Represents an audio-video invitation.

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
address	The address for a custom location
bandwidthControlId	The bandwidth control ID.
building	Building/Room Number of a custom location
city	City for a custom location
country	Country/Region for acustom location
customContent	Custom Content.
delegator	Delegator uri on behalf of whom the invitation is made.
direction	The direction of the invitation.
importance	The importance.
joinAudioMuted	The audio mute status upon joining the online meeting.
joinVideoMuted	The video mute status upon joining the online meeting.
locationState	State/Province for a custom location
operationId	The operation ID as supplied by the client.The maximum length is 50 characters.
privateLine	Whether this invitation was received on a private line of the local participant.
mediaOffer	The SDP offers.
sessionContext	The session context.The maximum length is 50 characters.
state	The invitation state.
subject	The subject.The maximum length is 250 characters.
threadId	The thread ID of the conversation.
to	The target of this invitation.
zip	Zip/PostalCode for a custom location

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
acceptedByContact	Represents the contact who ultimately accepted an incoming invitation.
acceptWithAnswer	Accepts an invitation that requires SDP (audio/video, application sharing).
acceptWithPhoneAudio	Represents a link to an audioVideoInvitation resource that allows the client application to accept the invitation by using phoneAudio.
audioVideo	Represents the audio/video modality in the corresponding conversation.
cancel	Cancels the corresponding invitation.
conversation	Represents the local participants perspective on a multi-modal, multi-party communication.
decline	Declines an incoming invitation.
delegator	Represents the contact who is the delegator
derivedAudioVideo	The derived audioVideo resource.
derivedConversation	Represents a related conversation with a different participant than the one of the original conversation.
forwardedBy	Represents the contact who last forwarded the invitation before it was received by the user.
from	Represents the participant that sent an invitation.
onBehalfOf	Represents the contact on whose behalf the invitation was received.
replacesAudioVideo	Represents a link to a resource that will be replaced, if this invitation succeeds.
reportMediaDiagnostics	Represents RreportMediaDiagnostics operation.
sendProvisionalAnswer	Represents a link in an audioVideoInvitation resource that allows the application to send an answer for early media negotiation.
to	Represents the originally intended target of the invitation as a contact.
transferredBy	Represents the contact who transferred the call.
acceptedByParticipant	Represents the remote participant who accepted the invitation of the user.
from	Represents the participant that sent an invitation.

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

Events

Started

Resource	Priority	Sender	Reason
audioVideoInvitation	High	communication	Delivered when an audio-video invitation is started. This occurs when the application starts the audioVideo modality.

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" : "communication", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication", "events" : [ { "link" : { "rel" : "audioVideoInvitation", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/invitations/507" }, "type" : "started" } ] } ] }

Updated

Resource	Priority	Sender	Reason
audioVideoInvitation	High	communication	Delivered when the audio-video invitation 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=1" }, "next" : { "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2" } }, "sender" : [ { "rel" : "communication", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication", "events" : [ { "link" : { "rel" : "audioVideoInvitation", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/invitations/507" }, "type" : "updated" } ] } ] }

Operations

GET

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	Description
NotFound	404	None	Call not found.
BadRequest	400	None	Something is wrong with the entire request (malformed XML/JSON, for example).
BadRequest	400	ParameterValidationFailure	Incorrect parameters were provided for the request (for example, the requested conference subject exceeds the maximum length).
Gone	410	None	The content-type is not supported.
NotFound	404	None	The resource does not exist.
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/invitations/507 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: 6675
{
  "rel" : "audioVideoInvitation",
  "address" : "samplevalue",
  "bandwidthControlId" : "samplevalue",
  "building" : "samplevalue",
  "city" : "samplevalue",
  "country" : "samplevalue",
  "delegator" : "sip:john@contoso.com",
  "direction" : "Incoming",
  "importance" : "Normal",
  "joinAudioMuted" : false,
  "joinVideoMuted" : false,
  "locationState" : "samplevalue",
  "operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
  "privateLine" : false,
  "sessionContext" : "8efd502350ff419cb615018ae561f97e",
  "state" : "Connecting",
  "subject" : "Strategy for next quarter",
  "threadId" : "292e0aaef36c426a97757f43dda19d06",
  "to" : "sip:john@contoso.com",
  "zip" : "samplevalue",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/507"
    },
    "customContent" : {
      "href" : "data:application/sdp;base64,base64-encoded-sdp"
    },
    "mediaOffer" : {
      "href" : "data:application/sdp;base64,base64-encoded-sdp"
    },
    "from" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/831"
    },
    "acceptedByContact" : {
      "href" : "/ucwa/v1/applications/192/people/169"
    },
    "acceptWithAnswer" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/665/acceptWithAnswer"
    },
    "acceptWithPhoneAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/507/acceptWithPhoneAudio"
    },
    "audioVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo"
    },
    "cancel" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/665/cancel"
    },
    "conversation" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137"
    },
    "decline" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/665/decline"
    },
    "delegator" : {
      "href" : "/ucwa/v1/applications/192/people/312"
    },
    "derivedAudioVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/665/derivedAudioVideo"
    },
    "derivedConversation" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/665/derivedConversation"
    },
    "forwardedBy" : {
      "href" : "/ucwa/v1/applications/192/people/776"
    },
    "onBehalfOf" : {
      "href" : "/ucwa/v1/applications/192/people/444"
    },
    "replacesAudioVideo" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/665/replacesAudioVideo"
    },
    "reportMediaDiagnostics" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/audioVideo/reportMediaDiagnostics"
    },
    "sendProvisionalAnswer" : {
      "href" : "/ucwa/v1/applications/192/communication/invitations/507/sendProvisionalAnswer"
    },
    "to" : {
      "href" : "/ucwa/v1/applications/192/people/107"
    },
    "transferredBy" : {
      "href" : "/ucwa/v1/applications/192/people/766"
    }
  },
  "_embedded" : {
    "acceptedByParticipant" : [
      {
        "rel" : "participant",
        "anonymous" : true,
        "inLobby" : true,
        "local" : true,
        "name" : "Joe Smith",
        "organizer" : true,
        "otherPhoneNumber" : "tel:+14251111111",
        "role" : "Attendee",
        "sourceNetwork" : "SameEnterprise",
        "uri" : "sip:john@contoso.com",
        "workPhoneNumber" : "tel:+14251111111",
        "_links" : {
          "self" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196"
          },
          "admit" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/admit"
          },
          "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"
          },
          "conversation" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137"
          },
          "demote" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/demote"
          },
          "eject" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/eject"
          },
          "me" : {
            "href" : "/ucwa/v1/applications/192/me"
          },
          "participantApplicationSharing" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantApplicationSharing"
          },
          "participantAudio" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantAudio"
          },
          "participantDataCollaboration" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantDataCollaboration"
          },
          "participantMessaging" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantMessaging"
          },
          "participantPanoramicVideo" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantPanoramicVideo"
          },
          "participantVideo" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantVideo"
          },
          "promote" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/promote"
          },
          "reject" : {
            "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/reject"
          }
        }
      }
    ],
    "from" : {
      "rel" : "participant",
      "anonymous" : true,
      "inLobby" : true,
      "local" : true,
      "name" : "Joe Smith",
      "organizer" : true,
      "otherPhoneNumber" : "tel:+14251111111",
      "role" : "Attendee",
      "sourceNetwork" : "SameEnterprise",
      "uri" : "sip:john@contoso.com",
      "workPhoneNumber" : "tel:+14251111111",
      "_links" : {
        "self" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196"
        },
        "admit" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/admit"
        },
        "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"
        },
        "conversation" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137"
        },
        "demote" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/demote"
        },
        "eject" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/eject"
        },
        "me" : {
          "href" : "/ucwa/v1/applications/192/me"
        },
        "participantApplicationSharing" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantApplicationSharing"
        },
        "participantAudio" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantAudio"
        },
        "participantDataCollaboration" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantDataCollaboration"
        },
        "participantMessaging" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantMessaging"
        },
        "participantPanoramicVideo" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantPanoramicVideo"
        },
        "participantVideo" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/participantVideo"
        },
        "promote" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/promote"
        },
        "reject" : {
          "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/196/reject"
        }
      }
    },
    "startEmergencyCallInput" : [
      {
        "rel" : "startEmergencyCallParameters",
        "_links" : {
          "self" : {
            "href" : "/ucwa/v1/applications/192/communication/invitations/665/startEmergencyCallParameters"
          }
        }
      }
    ]
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/invitations/507 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml

XML Response