Skype for Business - subscribeToGroupPresence Resource

subscribeToGroupPresence

  • JSON
  • XML

Subscribes to the presence information of all the contacts in a particular group.

Web link

For more on web links, see Web Links.

Name Description
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

The presence of the web link indicates that the application can subscribe to the presence of the current group members for a specified duration.

Properties

None

Links

None

Operations

  • POST

Creates a time-bound presenceSubscription resource.

Query parameters

Click here to see the input values.

Name Description Required?
duration The presence subscription expiration time (in minutes).

The maximum value is 30 and the minimum value is 10.

Yes

Request body

Click here to see the input values.

Name Description Required?
duration The presence subscription expiration time (in minutes).

The maximum value is 30 and the minimum value is 10.

Yes
groupId The group ID query parameter. Required parameter.

The maximum length is 256 characters.

Yes

Response body

Item Description
presenceSubscription Represents the subscription to a user-defined set of contacts.

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
ServiceFailure500CallbackChannelError
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Only server-supplied query parameters, if any, are shown in the request sample.

Request

Post https://fe1.contoso.com:443//v1/applications/970/groups/group/subscribeToGroupPresence?groupId=Family 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 201 Created
Content-Type: application/json
Content-Length: 299
{
  "rel" : "presenceSubscription",
  "id" : "3",
  "_links" : {
    "self" : {
      "href" : "//v1/applications/970/presenceSubscription"
    },
    "addToPresenceSubscription" : {
      "href" : "//v1/applications/970/presenceSubscription/addToPresenceSubscription"
    },
    "memberships" : {
      "href" : "//v1/applications/970/presenceSubscription/memberships"
    }
  }
}
  

Request

Post https://fe1.contoso.com:443//v1/applications/970/groups/group/subscribeToGroupPresence?groupId=Family 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 201 Created
Content-Type: application/xml
Content-Length: 478
<?xml version="1.0" encoding="utf-8"?>
<resource rel="presenceSubscription" href="//v1/applications/970/presenceSubscription" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="addToPresenceSubscription" href="//v1/applications/970/presenceSubscription/addToPresenceSubscription" />
  <link rel="memberships" href="//v1/applications/970/presenceSubscription/memberships" />
  <property name="rel">presenceSubscription</property>
  <property name="id">3</property>
</resource>