Skip to main content

Get Contact Entity detailed information​

Returns Contact Entity detailed information.

Path Parameters
  • entityUid integer required

    Possible values: >= 1

    Unique Identifier for Item

Responses

OK

Schema
  • name string

    Possible values: non-empty and <= 30 characters

  • type string

    Possible values: [regular, individual, multi]

  • number string

    There is two format: inner number and SIP number

    Inner number for differen devices:

    • regular like [builing]-[unit]-[floor]-[apartment], for example '0001-01-11-11'
    • individual like [builing]-[unit]-[floor]-[apartment]-[device number], for example '001-01-11-11-1'
    • multi like [builing]-[unit]-[device number], for example '0001-01-01'
    regularidividualmulti
    building0001 - 9999001 - 9990001 - 9999
    unit00 - 9900 - 9900 - 99
    floor00 - 9800 - 98
    apartment00 - 9900 - 99
    device1 - 901 - 99

    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

  • auto_answer boolean

    If true device will answer immediatelly 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

  • item_uid integer

    UID for entities referenses

Loading...