Skype for Business - myContacts Resource

myContacts

  • JSON
  • XML

A collection of contact resources that belong to the logged-on user.

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

This collection is read-only: it can be used only to view existing contact resources that are on the logged-on user's contact list. New contacts are added using the Skype for Business client.

Properties

None

Links

This resource can have the following relationships.

Link Description
selfThe link to the current resource.
contact Represents a person or service that the user can communicate and collaborate with.
contact Represents a person or service that the user can communicate and collaborate with.

Events

  • added
  • deleted
Resource Priority Sender Reason
contactHighpeople Delivered when a contact resource is added.

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=27"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=27"
    }
  },
  "sender" : [
    {
      "rel" : "people",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/people",
      "events" : [
        {
          "link" : {
            "rel" : "contact",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/people/235"
          },
          "in" : {
            "rel" : "myContacts",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/contacts"
          },
          "type" : "added"
        }
      ]
    }
  ]
}
Resource Priority Sender Reason
contactHighpeople Delivered when a contact resource is deleted.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=5"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=5"
    }
  },
  "sender" : [
    {
      "rel" : "people",
      "href" : "https://fe1.contoso.com:443//v1/applications/970/people",
      "events" : [
        {
          "link" : {
            "rel" : "contact",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/people/235"
          },
          "in" : {
            "rel" : "myContacts",
            "href" : "https://fe1.contoso.com:443//v1/applications/970/contacts"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

  • GET

Gets the list of contacts belonging to myContacts.

Query parameters

Click here to see the input values.

Name Description Required?
expand Optional query parameter to override default behavior when returning a collection of groups. By default, a collection of all contact list groups will be returned with data inline. If this query parameter is provided in the request with value of "false", then the collection of contact list groups will be returned as links. No

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
Forbidden403None The user does not have sufficient privileges to access the contact list.
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

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

Request

Get https://fe1.contoso.com:443//v1/applications/970/contacts?groupId=samplevalue 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: 1241
{
  "rel" : "myContacts",
  "_links" : {
    "self" : {
      "href" : "//v1/applications/970/contacts"
    },
    "contact" : [
      {
        "href" : "//v1/applications/970/people/730"
      }
    ]
  },
  "_embedded" : {
    "contact" : [
      {
        "rel" : "contact",
        "company" : "ContosoCorp.",
        "department" : "Engineering",
        "emailAddresses" : [
          "Alex.Doe@contoso.com"
        ],
        "homePhoneNumber" : "tel : +19185550107",
        "sourceNetworkIconUrl" : "https : //images.contoso.com/logo_16x16.png",
        "mobilePhoneNumber" : "tel : 4255551212;phone-context=defaultprofile",
        "name" : "AlexDoe",
        "office" : "tel : +1425554321;ext=54321",
        "otherPhoneNumber" : "tel : +19195558194",
        "sourceNetwork" : "SameEnterprise",
        "title" : "Engineer2",
        "type" : "User",
        "uri" : "sip : alex@contoso.com",
        "workPhoneNumber" : "tel : +1425554321;ext=54321",
        "_links" : {
          "self" : {
            "href" : "//v1/applications/970/people/235"
          },
          "contactLocation" : {
            "href" : "//v1/applications/970/people/235/contactLocation"
          },
          "contactNote" : {
            "href" : "//v1/applications/970/people/235/contactNote"
          },
          "contactPhoto" : {
            "href" : "//v1/applications/970/people/235/contactPhoto"
          },
          "contactPresence" : {
            "href" : "//v1/applications/970/people/235/contactPresence"
          },
          "contactPrivacyRelationship" : {
            "href" : "//v1/applications/970/people/235/contactPrivacyRelationship"
          },
          "contactSupportedModalities" : {
            "href" : "//v1/applications/970/people/235/contactSupportedModalities"
          }
        }
      }
    ]
  }
}
  

Request

Get https://fe1.contoso.com:443//v1/applications/970/contacts?groupId=samplevalue 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: 1774
<?xml version="1.0" encoding="utf-8"?>
<resource rel="myContacts" href="//v1/applications/970/contacts" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="contact" href="//v1/applications/970/people/519" />
  <property name="rel">myContacts</property>
  <resource rel="contact" href="//v1/applications/970/people/235">
    <link rel="contactLocation" href="//v1/applications/970/people/235/contactLocation" />
    <link rel="contactNote" href="//v1/applications/970/people/235/contactNote" />
    <link rel="contactPhoto" href="//v1/applications/970/people/235/contactPhoto" />
    <link rel="contactPresence" href="//v1/applications/970/people/235/contactPresence" />
    <link rel="contactPrivacyRelationship" href="//v1/applications/970/people/235/contactPrivacyRelationship" />
    <link rel="contactSupportedModalities" href="//v1/applications/970/people/235/contactSupportedModalities" />
    <property name="rel">contact</property>
    <property name="company">Contoso Corp.</property>
    <property name="department">Engineering</property>
    <propertyList name="emailAddresses">
      <item>Alex.Doe@contoso.com</item>
    </propertyList>
    <property name="homePhoneNumber">tel:+19185550107</property>
    <property name="sourceNetworkIconUrl">https://images.contoso.com/logo_16x16.png</property>
    <property name="mobilePhoneNumber">tel:4255551212;phone-context=defaultprofile</property>
    <property name="name">Alex Doe</property>
    <property name="office">tel:+1425554321;ext=54321</property>
    <property name="otherPhoneNumber">tel:+19195558194</property>
    <property name="sourceNetwork">SameEnterprise</property>
    <property name="title">Engineer 2</property>
    <property name="type">User</property>
    <property name="uri">sip:alex@contoso.com</property>
    <property name="workPhoneNumber">tel:+1425554321;ext=54321</property>
  </resource>
</resource>