Skype for Business - contact Resource

contact

  • JSON
  • XML

Represents a person or service that the user can communicate and collaborate with.

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

contact is the persistent representation of a person or service. A contact can be referenced by a participant or in the context of communication. A contact resource can also be referenced by various containers such as a group or subscribedContacts.

Properties

Name Description
company The name of the contact's company.
department The name of the contact's department.
emailAddresses The contact's e-mail addresses.
homePhoneNumber The contact's home phone number.
sourceNetworkIconUrl The web URI of the icon representing the contact's source network.
mobilePhoneNumber The contact's mobile phone number.
name The contact's name.
office The contact's office number.
otherPhoneNumber The contact's other phone number.
sourceNetwork The contact's source network (SourceNetwork), such as SameEnterprise or PublicCloud (such as a Skype contact).
title The contact's title.
type The contact's type (ContactType), such as User, Phone, or Bot.
uri The contact's URI.
workPhoneNumber The contact's work phone number.

Links

This resource can have the following relationships.

Link Description
selfThe link to the current resource.
contactLocation Represents a contact's location.
contactNote Represents a contact's personal or out-of-office note.
contactPhoto The photo of a contact.
contactPresence Represents a contact's availability and activity.
contactPrivacyRelationship Represents the privacy relationship between the user and a contact.
contactSupportedModalities Represents the communication modalities supported by a contact.

Operations

  • GET

Returns a representation of a person or service that the user can communicate and collaborate with.

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 Returned when an application does not have permission to view this contact's information.
Forbidden403None The user does not have sufficient privileges to access the contact list.
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Request

Get https://fe1.contoso.com:443//v1/applications/970/people/235?displayName=John&participantHash=AHJKUYKL== HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json
if-none-match: 29f1b614-46ad-4152-a47b-e6ade87eb710

  

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
Etag: 8a586bd8-d307-49af-8bf0-e4897661b830
Content-Type: application/json
Content-Length: 1078
{
  "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/people/235?displayName=John&participantHash=AHJKUYKL== HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml
if-none-match: b7f122f1-3541-4d12-93d9-277d9d022477

  

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
Etag: cfabef19-3c07-4f8f-82b2-5f54e979522e
Content-Type: application/xml
Content-Length: 1594
<?xml version="1.0" encoding="utf-8"?>
<resource rel="contact" href="//v1/applications/970/people/235" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <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>