Skip to main content

Create Contact Entity​

You can create contacts with the next types:

  • regular - for monitors, intercom SIP numbers, etc.
  • individual - for individual panels
  • multi - for multiapartment panels
  • global - for panels on wall (device number from 1 to 9000)

Contact number can take two formats:

  • inner protocol
  • SIP

For inner protocol contact numbers with different type must match different pattern:

  • regular regex is ^\d{3}[1-9]-\d{2}-\d[0-8]-\d{2}$, like [building]-[unit]-[floor]-[apartment], for example '0001-01-11-11'
  • individual regex is ^\d{2}[1-9]-\d{2}-\d[0-8]-\d{2}-[1-9]$, like [building]-[unit]-[floor]-[apartment]-[device number], for example '001-01-11-11-1'
  • multi regex is ^\d{3}[1-9]-\d{2}-\d[1-9]$, like [building]-[unit]-[device number], for example '0001-01-01'
  • global regex is ^\d{3}[1-9]$, like [device] from 1 to 9000, for example '0001'

In general, building must be in range [1-999] for individual panel and [1-9999] - for other devices, unit: [00-99], floor: [00-98] (99 is reserved for multi- panel), apartment: [00-99], device: [0-8]

For SIP contact numbers regex is sip:[0-9A-Za-z+\-_.]+@((((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?(?:\:\d{1,5})?)(\.|$)){4}\b)|([0-9]*[A-Za-z+\-_]+[0-9]*)(\.([0-9]*[A-Za-z+\-_]+[0-9]*))+), for example sip:[email protected] or sip:[email protected]

If you want the device to skip all calls from some numbers you can add it to black list, using property in_black_list. Call will be added to recent calls with proper icon.

If you want the device to immediately receive a call from the specified number use property auto_answer. If auto_answer it true then in_black_list will be set to false.

Two parameters: auto_answer and in_black_list cannot be true at the same time.

is_default parameter can be true only for panel-like contacts. Default panel will be played when panel viewer app will be opened. Only one contact on the device can be default panel.

Maximum number of contacts - 1000

Request Body required
  • name string required

    Contact name

  • type string required

    Possible values: [regular, individual, multi, global]

    Contact type

  • number string required

    Contact number.

    There is two format: inner number and SIP number

    Inner number regexes for different devices:

    • ^\d{3}[1-9]-\d{2}-\d[0-8]-\d{2}$ - for regular device - monitor
    • ^\d{3}[1-9]-\d{2}-\d[1-9]$ - for multiapartment panel
    • ^\d{2}[1-9]-\d{2}-\d[0-8]-\d{2}-[1-9]$ - for individual panel
    • ^\d{3}[1-9]$ - for global panel

    SIP number format: sip:[0-9A-Za-z+-.]+@((((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?(?::\d{1,5})?)(.|$)){4}\b)|([0-9]*[A-Za-z+-]+[0-9])(.([0-9][A-Za-z+-_]+[0-9]*))+), for example sip:[email protected] or sip:[email protected]

  • is_favorite boolean required

    Favorite contacts will be displayed at the top of the list

  • is_default boolean required

    This flag can be true only for panel-like contacts. Default panel will be played when panel viewer app will be opened

  • auto_answer boolean required

    If true device will answer immediately when received call from this contact. auto_answer and in_black_list cannot be true at the same time

  • in_black_list boolean required

    If true device will skip incoming call from this contact. auto_answer and in_black_list cannot be true at the same time

Responses

The uid value returned in the response can be used as the entityUid parameter in next requests:

  • GET/PATCH/DELETE /contact/item/{entityUid} - to get information about contact, update or delete it
Schema
  • uid integer

    UID for entities references

Loading...