Share via

2.2.2.7.5 contactCard

  • Article

A contactCard category instance contains user information such as a job title, phone number, and address that is shared with subscribers.

The following examples illustrate the format of a contactCard category instance:

<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard">
  <identity>
    <name>
      <displayName>Bob</displayName>
    </name>
  </identity>
</contactCard>
 
<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard">
  <phone type="work">
    <uri>tel:1234567890;phone-context=dialstring</uri>
  </phone>
  <phone type="mobile">
    <uri>tel:1234567890;phone-context=dialstring</uri>
  </phone>
</contactCard>
 
<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard"isUCEnabled="true">
</contactCard>
 
<contactCard xmlns="http://schemas.microsoft.com/2006/09/sip/contactcard">
    <identity>
        <name>
            <displayName>HumanResource</displayName>
        </name>
    </identity>
    <automaton>true</automaton>
    <type>huntgroup</type>
    <description>Human Resources Group</description>
</contactCard>

Elements and attributes are defined in this section. For the full XML schema, see section 7.

The XML elements of a contactCard document MUST conform to the schema defined in section 7.3

  • contactCard: This is a root element of the contactCard category instance. This element has the following attributes.

    • majorVersion (optional): Major version of contact card format.

    • minorVerson (optional): Minor version of contact card format.

    • isUCEnabled(optional): A Boolean value that indicates whether the user is enabled forUnified Communications.<17>

  • identity: The identity information of a contact card. This is a subelement of the contactCard element.

  • name: The name of a user. This is a subelement of the identity element.

  • displayName: A user's display friendly name. This is the subelement of the name element. It MAY have the following attributes:

  • LCID (optional): Locale identifier of the displayName.

  • updated (optional): The last time that the displayName element was updated, expressed in Coordinated Universal Time (UTC), as specified by [ISO-8601].

    • email: The user's e-mail address. This is the subelement of the identity element.

    • address: The user's postal address. This is the subelement of the contactCard element. It MAY have the following attribute:

    • type (optional): Type of the address, which MUST be "work", "home", or "other".

    • street: The user's street address. This is the subelement of the address element. It MAY have the following attributes:

      • LCID (optional): Locale identifier of the street name.

      • updated (optional): The last time that the street element was updated, expressed in UTC, as specified by [ISO-8601].

    • city: The user's city name. This is the subelement of the address element. It MAY have the following attributes.

      • LCID (optional): Locale identifier of the city name.

      • updated (optional): The last time that the city element was updated, expressed in UTC, as specified by [ISO-8601].

    • state: The user's state name. This is the subelement of the address element. It MAY have the following attributes.

      • LCID (optional): Locale identifier of the state name.

      • updated (optional): The last time that the state element was updated, expressed in UTC, as specified by [ISO-8601].

    • zipcode: The user's postal code. This is the subelement of the address element. It MAY have the following attributes:

      • LCID (optional): Locale identifier of the postal code.

      • updated (optional): The last time that the zipcode element was updated, expressed in UTC as specified by [ISO-8601].

    • countryCode: The user's country code. This is the subelement of the address element. Its value MUST be a two-character country code based on [ISO-3166].

    • company: The name of the user's company. This is the subelement the of contactCard element. It MAY have the following attributes:

      • LCID (optional): Locale identifier of the company name.

      • updated (optional): The last time that the company element was updated, expressed in UTC, as specified by [ISO-8601].

    • department: The name of the user's department. This is the subelement of the contactCard element. It MAY have the following attributes:

      • LCID (optional): Locale identifier of the department name.

      • updated (optional): The last time that the department element was updated, expressed in UTC, as specified by [ISO-8601].

    • title: The user's title. This is the subelement of the contactCard element. It MAY have the following attributes.

      • LCID (optional): Locale identifier of the title name.

      • updated (optional): This contains the last update time, in UTC, of the title element.

    • office: A description of the user's office. This is the subelement of the contactCard element. It MAY have the following attributes:

      • LCID (optional): Locale identifier of the office description.

      • updated (optional): The last time that the office element was updated, expressed in UTC.

    • url: The URL of the user. This is the subelement of the contactCard element. This element MAY have the following attributes:

      • type (optional): Type of the URL. The value MUST be "sharepoint", "voicemail", or "other".

      • updated (optional): The last time that the url element was updated, expressed in UTC.

    • phone: The user's phone number. This is the subelement of the contactCard element. This element MAY have the following attributes:

      • type (optional): Type of the phone, which SHOULD be "work", "home", "mobile", "other", or "custom1".

      • updated (optional): The last time that the phone element was updated, expressed in UTC.

    • uri: The normalized tel URI format of a phone number. This is the subelement of the phone element. It MAY have the following attribute:

      • updated (optional): The last time that the uri element was updated, expressed in UTC.

    • displayString: The display name of a phone number. This is the subelement of the phone element. It MAY have the following attributes:

      • LCID (optional): Locale identifier of the displayString.

      • updated (optional): The last time that the displayString element was updated, expressed in UTC.

  • automaton: A Boolean value that indicates whether the presentity is an automated agent. If the presentity is an automated agent, the value SHOULD be set to true. If the presentity is not an automated agent, either the value SHOULD be set to false or the automaton element SHOULD be omitted. An automated agent is also known as a bot. An automated agent is a self-operating presentity that provides automatic responses to requests through instant messages, voice and other modes. This is the subelement of the contactCard element.<18>

    • type: The type of the presentity. This is the subelement of the contactCard element. It MUST have one of the following values:

      • person: The presentity is an end user.

      • huntgroup: The presentity distributes phone calls from a caller to a group of agents without interacting with the caller.

      • autoattendant: The presentity distributes phone calls from a caller to a group of agents after interacting with the caller first.

      • automaton: The presentity is a self-operating presentity that provides automatic responses to requests through instant messages.

    • description: The description of presentity. This is the subelement of the contactCard element.<19>

displayADPhoto:<20> A Boolean value that controls whether a user picture is displayed. If the value is true, then the source of the displayed picture is the value of the photo subelement or the picture (if one exists) from the Active Directory. If the value is false, no picture is displayed. This is the optional subelement of the contactCard element.

  • photo:<21> The information about the photo of the presentity. There can be zero or more photo subelements in a contactCard element. This element SHOULD have the following attribute:

  • type: Type of the photo. It SHOULD have one of the tokens in the following table.

    Values

    Meaning

    default

    Default photo.

    enterprise

    Workplace photo.

    exchange

    E-mail server photo.

    other

    This is some other photo.

  • uri:<22> The photo URI of the presentity. This is the optional subelement of the photo element. This element SHOULD have the following attribute:

    • updated (optional): The last time that the uri element was updated, expressed in UTC.

  • hash:<23> A cyclic redundancy check (CRC) hash of photo if the type of the photo is "default" or "enterprise"; an email server ChangeKey if the type of the photo is "exchange". This is the mandatory subelement of the photo element.