Skip to main content

Get Contact detailed information​

Returns Contact detailed information.

Path Parameters
  • entity-uid integer required

    Possible values: >= 1

    Unique Identifier for Item

Responses

OK

Schema
  • name string

    Contact name

  • type string

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

    Contact type

  • number string

    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

    Favorite contacts will be displayed at the top of the list

  • is_default boolean

    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

    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

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

Loading...