Edit

makeMeAvailable

  • Article

Applies to: Skype for Business 2015

Makes the user available for incoming communications.

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.

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.

Scope Permission Description
User.ReadWrite Read/write Skype user information Allows the app to read and update presence, photo, location, note, call forwarding settings of the signed-in user
Conversations.Receive Receive conversation invites Allows 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

Name Description Required?
audioPreference Gets or sets the preferred mode for incoming audio, if any, supplied by the user.Voip is default Nullable (AudioPreference)PhoneAudio, or VoipAudio No
inactiveTimeout The length of time, in minutes, before the user's activity switches to inactive.The default value is 5 minutes.Nullable TimeSpan No
phoneNumber The 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.String No
signInAs The preferred availability (PreferredAvailability) of the user upon making herself available.Nullable (PreferredAvailability)Online, Busy, DoNotDisturb, BeRightBack, Away, or Offwork No
supportedMessageFormats The message formats (MessageFormat) that are supported by this application.Array of (MessageFormat)Plain, or Html No
supportedModalities The list of incoming modalities (ModalityType) of interest to the user.Array of (ModalityType)Audio, Video, PhoneAudio, ApplicationSharing, Messaging, DataCollaboration, or PanoramicVideo No
voipFallbackToPhoneAudioTimeOut Sets the timeout used before falling back to PhoneAudio if client does notACK the Audio invitation.Nullable TimeSpan No

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.

Error Code Subcode Description
Conflict 409 AlreadyExists Multiple invocations of this operation is not valid.
Forbidden 403 None The application is attempting to use modalities other than Messaging and Phone Audio.
Forbidden 403 AnonymousNotAllowed The application is attempting make an anonymous user available.
ServiceFailure 500 CallbackChannelError The remote event channel is not reachable
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

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