Presence data source and category instance ID

Applies to: Lync 2013 | Lync Server 2013

Similar enhanced presence data can be published from various data sources. For example, a presence state can describe the status of a user, a device used by the user, or a meeting scheduled for the user. In Microsoft Lync 2013, they are represented by a user state, a machine state, a phone state, and a calendar state, respectively. Each corresponds to state category instance value elements category instance that is identified by a unique instance ID.

Contact information is assembled from various data sources including Active Directory Domain Services, Address Book Server, and the user. In Lync 2013 the contact information is published and subscribed to in pieces that are contained in different contactCard category instance value element category instances that are identified by their instance IDs.

In Lync 2013, instance IDs are also used to identify different types of publications of the same presence data. For example, a static user state category instance has an instance ID that is different from that of a time-bound user state category instance.

The following table lists the instance IDs of the category instances that are used by Lync 2013 and that can be subscribed to remotely.

Note

The LSxx[MD5(key)] notation in the expression of an instance ID means the xx least significant bits of the MD5 hash of a given key.

Category name

Instance ID

Category data

contactCard category instance value element

0

User identity as specified in the underlying Active Directory domain, including the display name and email address. This is a read-only category instance.

0x1

User-specified contact information through the Lync Options dialog box. Includes the user-specified phone numbers.

0x2

User properties that include the user’s work or home address.

0x3

Contact data obtained from the Address Book Services, including a user's title, company name, office location, and available telephone numbers.

0x4

Server-provisioned user-specific application data, such as the unified communications-enabled voice mail URL.

0x5

Presentity information.

0x6

The title and office location of the user.

state category instance value elements

0

Static aggregate state.

0x1

User-bounded aggregate state.

0x100000000

User-bounded aggregate machine state.

0x20000000

Static user state.

0x24000000

Time-bounded user state.

0x30000000|LS28[MD5(GRUU)]

Machine state. The 4 most significant bits of this instance ID value hold a value of 3, and the 28 least significant bits contain the 28 least significant bits of the MD5 hash of the device GRUU value.

0x40000000|LS28[MD5(SMTP address)]

Calendar state for a meeting. The 4 most significant bits of this instance ID value hold a value of 4, and the 28 least significant bits contain the 28 least significant bits of the MD5 hash of the user’s SMTP address.

0x50000000|LS28[MD5(SMTP address)]

Calendar state that contains an activity for an OOF meeting. The 4 most significant bits of the instance ID value hold a value of 4, and the 28 least significant bits contain the 28 least significant bits of the MD5 hash of the user’s SMTP address.

0x60000000|LS28[MD5(SMTP address)]

Calendar state containing an activity for an OOF message. The 4 most significant bits of the instance ID value hold the value of 4, and the 28 least significant bits contain the 28 least significant bits of the MD5 hash of the user’s SMTP address.

0x70000000|LS28[MD5(TEL URI)]

Phone state for a RCC call. The 4 most significant bits of the instance ID value hold the value of 7, and the 28 least significant bits of the instance ID value correspond to the 28 least significant bits of the MD5 hash of the TEL URI of the RCC phone set.

0x80000000|LS28[MD5(SIP URI,GRUU)]

Phone state for a VoIP call. The 4 most significant bits of the instance ID value hold the value of 8, and the 28 least significant bits correspond to the 28 least significant bits of the MD5 hash of a comma-separated string that consists of the user’s SIP URI and the GRRU of the device in use. For example, 0x898E1BEB.

0x90000000|LS28[MD5(PSTN URI,GRUU)]

Phone state for a PSTN phone call. The 4 most significant bits of the instance ID hold the value of 9, and the 28 least significant bits of the instance ID value correspond to the 28 least significant bits of the MD5 hash of a comma-separated string consisting of the PSTN URI and the GRUU of the PSTN phone set.

calendarData

0

Calendar data for working hours.

0x40000000|LS30[MD5(Mailbox URI)]

A calendar period as a contiguous block of free-busy time slots. The two most significant bits of the instance ID value hold the value 4, and the 30 least significant bits correspond to the 30 least significant bits of the MD5 hash of the URI of the mailbox from which the calendar data is obtained.

note category instance value element

0

Personal note that can be set by the user.

0x40000000|0x00000000|LS28(MD5(Mailbox URI)]

Static OOF message as provisioned from the Microsoft Exchange store. The 4 most significant bits of the instance ID hold the value 4, and the 28 least significant bits are assigned the 28 least significant bits of the MD5 hash of the URI of the mailbox from which the OOF message is obtained.

0x40000000|0x40000000|LS28(MD5(Mailbox URI)]

Time-bounded OOF message as provisioned from the Exchange store. The 4 most significant bits of the instance ID hold the value 4, and the 28 least significant bits are assigned the 28 least significant bits of the MD5 hash of the URI of the mailbox from which the OOF message is obtained.

services category instance value element

0

Presence capabilities of the supported modalities.

device category instance value element

LS32[MD5(GRUU)]

Device information. The instance ID value is the 32 lowest significant bits of the MD5 hash of the device GRUU.

See also

Concepts

Presence category instances published or used by Lync