Contact (contact)

Table of Contents

Description
Limitations
Fields
See also
- API
- Logical roles

Description

Address Book Contact.
It is used in applications and services that regularly communicate with the same set of subscribers: conference calls, alerts, etc.
Can synchronize with LDAP in scheduled scenarios.

Limitations

The collection is only available in working domains.

Fields

Entity structure

{
  "id": uuid,
  "autokey": int,
  "displayname": str,
  "department": str,
  "jobtitle": str,
  "number": str,
  "numlocal": str,
  "numpublic": str,
  "mobile": str,
  "mobile2": str,
  "mobile3": str,
  "roomnum": str,
  "roomnum2": str,
  "roomnum3": str,
  "email": str,
  "email2": str,
  "email3": str,
  "photo": str,
  "opts": {
    "title": str,
    "comment": str,
    "groups": array<str>,
    "priority": int | null
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}

Description of the specification’s characteristics

Table 1. Fields
Specification	Description
Field: `id` Mode: `inout` Type: `uuid` Default: generated	Identifier. Can be specified at creation, otherwise generated by the system.
Field: `autokey` Mode: `out` Type: `int` Default: generated	Order Number. Generated automatically and is the key field by which the mapping is performed. Cannot be changed. Must be absent or equal to `-1` when the entity is created. Used for association with other entities.
Field: `displayname` Mode: `in` Type: `str` Default: required	Displayed name
Field: `department` Mode: `in` Type: `str` Default: empty	Division. Not used by the system. For storage and project use only.
Field: `jobtitle` Mode: `in` Type: `str` Default: empty	Position. Not used by the system. For storage and project use only.
Field: `number` Mode: `in` Type: `str` Default: required	Primary phone number.
Field: `numlocal` Mode: `in` Type: `str` Default: empty	Additional phone number (internal). Not used by the system. For storage and project use only.
Field: `numpublic` Mode: `in` Type: `str` Default: empty	Optional phone number (external). Not used by the system. For storage and project use only.
Field: `mobile` Mode: `in` Type: `str` Default: empty	Primary cell phone number. Not used by the system. For storage and project use only.
Field: `mobile2` Mode: `in` Type: `str` Default: empty	Additional cell phone number 2. Not used by the system. For storage and project use only.
Field: `mobile3` Mode: `in` Type: `str` Default: empty	Additional cell phone number 3. Not used by the system. For storage and project use only.
Field: `roomnum` Mode: `in` Type: `str` Default: empty	Reserved conference room number. Not used by the system. For storage and project use only.
Field: `roomnum2` Mode: `in` Type: `str` Default: empty	Reserved conference room number 2. Not used by the system. For storage and project use only.
Field: `roomnum3` Mode: `in` Type: `str` Default: empty	Reserved conference room number 3. Not used by the system. For storage and project use only.
Field: `email` Mode: `in` Type: `str` Default: empty	Primary e-mail account. Not used by the system. For storage and project use only.
Field: `email2` Mode: `in` Type: `str` Default: empty	Optional e-mail account. Not used by the system. For storage and project use only.
Field: `email3` Mode: `in` Type: `str` Default: empty	Optional e-mail account. Not used by the system. For storage and project use only.
Field: `photo` Mode: `in` Type: `str` Default: empty	Photo. Not used by the system. For storage and project use only.
Field: `opts` Mode: `in` Type: `object` Composite field
Field: `opts.title` Mode: `in` Type: `str` Default: empty	Arbitrary header
Field: `opts.comment` Mode: `in` Type: `str` Default: empty	Arbitrary comment
Field: `opts.groups` Mode: `inout` Type: `array<str>` Default: empty	The codes of the contact groups (`code` field) that include this contact. Automatically linked to a similar group field and can be changed by the system.
Field: `opts.priority` Mode: `in` Type: `int \| null` Default: `null`	Personal contact priority applied when building the list for notification. Synchronized with group priorities.
Field: `ext` Mode: `inout` Type: `object` Compound field	Allows you to extend the compound with arbitrary keys and values
Field: `ext.ct` Mode: `out` Type: `date` Default: generated	Object creation time
Field: `ext.lwt` Mode: `out` Type: `date` Default: generated	Time of last modification of the object

Contact (contact)

Description

Limitations

Fields

See also

API

Logical roles