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

makeMeAvailable

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

Applies to: Skype for Business 2015

        Makes the user available for incoming communications.

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

This resource lets users share their availability and allows them to receive incoming invitations for the modalities of their choice.Please note that a user can initiate communications, such as joining an onlineMeeting or starting a phone call, without invoking this capability.

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
User.ReadWriteRead/write Skype user informationAllows the app to read and update presence, photo, location, note, call forwarding settings 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

Makes the user available for incoming communications.

Request body

NameDescriptionRequired?
audioPreferenceGets or sets the preferred mode for incoming audio, if any, supplied by the user.Voip is default Nullable (AudioPreference)PhoneAudio, or VoipAudioNo
inactiveTimeoutThe length of time, in minutes, before the user's activity switches to inactive.The default value is 5 minutes.Nullable TimeSpanNo
phoneNumberThe phone number of the device the user wishes to be reached on.The phone number will be normalized by the server, but it will not check that the number actually rings.StringNo
signInAsThe preferred availability (PreferredAvailability) of the user upon making herself available.Nullable (PreferredAvailability)Online, Busy, DoNotDisturb, BeRightBack, Away, or OffworkNo
supportedMessageFormatsThe message formats (MessageFormat) that are supported by this application.Array of (MessageFormat)Plain, or HtmlNo
supportedModalitiesThe list of incoming modalities (ModalityType) of interest to the user.Array of (ModalityType)Audio, Video, PhoneAudio, ApplicationSharing, Messaging, DataCollaboration, or PanoramicVideoNo
voipFallbackToPhoneAudioTimeOutSets the timeout used before falling back to PhoneAudio if client does notACK the Audio invitation.Nullable TimeSpanNo

Response body

None

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
Conflict409AlreadyExistsMultiple invocations of this operation is not valid.
Forbidden403NoneThe application is attempting to use modalities other than Messaging and Phone Audio.
Forbidden403AnonymousNotAllowedThe application is attempting make an anonymous user available.
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/makeMeAvailable HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 176
{
  "audioPreference" : "PhoneAudio",
  "phoneNumber" : "4255552222",
  "signInAs" : "BeRightBack",
  "supportedMessageFormats" : [
    "Plain",
    "Html"
  ],
  "supportedModalities" : [
    "PhoneAudio",
    "Messaging"
  ]
}

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 204 No Content

XML Request

Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/makeMeAvailable HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Content-Length: 455
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <property name="audioPreference">PhoneAudio</property>
  <property name="phoneNumber">4255552222</property>
  <property name="signInAs">BeRightBack</property>
  <propertyList name="supportedMessageFormats">
    <item>Plain</item>
    <item>Html</item>
  </propertyList>
  <propertyList name="supportedModalities">
    <item>PhoneAudio</item>
    <item>Messaging</item>
  </propertyList>
</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 204 No Content
© 2017 Microsoft