2.2.4.2 Contacts/Groups Management Document Formats

Session Initiation Protocol Extensions support modification to the contact list. These primitives are defined as SOAP elements and are sent to the server by using a SERVICE request. Session Initiation Protocol Extensions supports the following primitives:

  1. setContact

    The setContact primitive is used for adding a new contact or modifying an existing contact. It contains the following elements:

    uri: The SIP URI of the contact.

    displayName: The name of the contact.

    groups: A space-separated string of IDs for the groups to which this contact belongs.

    subscribed: A Boolean that indicates whether this contact is merely stored as an offline contact or whether the client needs to subscribe to its presence.

    externalURI: A URI that points to auxiliary information for this contact. For example, the externalURI can point to an LDAP URI that contains the information for this contact. This element is optional.

    contactExtension: This element can be any generic XML. This element can be used to store any additional application extension information about a contact. This element is optional.

  2. deleteContact

    The deleteContact primitive is used for deleting an existing contact. It contains the URI element, which identifies the sip URI of the contact to be deleted.

  3. addGroup/modifyGroup

    The addGroup primitive is used to add a new group. The modifyGroup primitive is used to modify an existing group. These primitives contain the following elements:

    groupID: A nonnegative integer that is used as the identifier of the group.

    name: The name of the group.

    externalURI: A URI that points to auxiliary information about the group. This element is optional.

  4. deleteGroup

    The deleteGroup primitive is used for deleting an existing group. It contains the groupID of the group to be deleted.

Each primitive must also include the deltaNum element. This nonnegative integer element is used as a sequence number for the contact/group management view, and each primitive must include the deltaNum equal to the current sequence number.