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

phoneAudio

John Austin|Last Updated: 1/27/2018
|
2 Contributors

Applies to: Skype for Business 2015

Represents the phone audio modality in a conversation.

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

Phone audio refers to communication that is delivered via a public switched telephone network (PSTN).When present, the resource indicates the status of the phone audio channel and can provide capabilities to start or stop the phone call via a user-supplied phone number, as well as to place the call on hold.phoneAudio will be updated whenever the state and capabilities of the modality change.

Properties

NameDescription
stateThe state of the modality, such as Connecting, Connected, or Disconnected.

This resource can have the following relationships.

LinkDescription
selfThe link to the current resource.
addPhoneAudioAdds phone audio to an existing conversation.
conversationRepresents the local participants perspective on a multi-modal, multi-party communication.
holdPhoneAudioPlaces a phone call on hold.
resumePhoneAudioResumes a phone call that was placed on hold.
stopPhoneAudioStops the corresponding phone audio modality that is currently connecting or connected.

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
phoneAudioHighconversationThe phoneAudio resource has changed.

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" : "phoneAudio", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/phoneAudio" }, "type" : "updated" } ] } ] }

Operations

GET

Returns a representation of the phone audio modality in a 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/phoneAudio 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: 585
{
  "rel" : "phoneAudio",
  "state" : "Transferring",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/192/communication/phoneAudio"
    },
    "addPhoneAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/phoneAudio/addPhoneAudio"
    },
    "conversation" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137"
    },
    "holdPhoneAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/phoneAudio/holdPhoneAudio"
    },
    "resumePhoneAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/phoneAudio/resumePhoneAudio"
    },
    "stopPhoneAudio" : {
      "href" : "/ucwa/v1/applications/192/communication/phoneAudio/stopPhoneAudio"
    }
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/phoneAudio 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: 778
<?xml version="1.0" encoding="utf-8"?>
<resource rel="phoneAudio" href="/ucwa/v1/applications/192/communication/phoneAudio" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="addPhoneAudio" href="/ucwa/v1/applications/192/communication/phoneAudio/addPhoneAudio" />
  <link rel="conversation" href="/ucwa/v1/applications/192/communication/conversations/137" />
  <link rel="holdPhoneAudio" href="/ucwa/v1/applications/192/communication/phoneAudio/holdPhoneAudio" />
  <link rel="resumePhoneAudio" href="/ucwa/v1/applications/192/communication/phoneAudio/resumePhoneAudio" />
  <link rel="stopPhoneAudio" href="/ucwa/v1/applications/192/communication/phoneAudio/stopPhoneAudio" />
  <property name="rel">phoneAudio</property>
  <property name="state">Transferring</property>
</resource>
© 2018 Microsoft