Get Contact Entity detailed information

Returns Contact Entity detailed information.

Path Parameters

• entityUid integer required

  Possible values: >= 1

  Unique Identifier for Item

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• S I P
• Regular
• Individual panel
• Multi panel

---

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'

  	regular	idividual	multi
  building	0001 - 9999	001 - 999	0001 - 9999
  unit	00 - 99	00 - 99	00 - 99
  floor	00 - 98	00 - 98
  apartment	00 - 99	00 - 99
  device		1 - 9	01 - 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

{
  "name": "Adolph Smith",
  "type": "multi",
  "number": "0001-01-11-11",
  "is_favorite": true,
  "auto_answer": true,
  "in_black_list": false,
  "item_uid": 3
}

{
  "name": "Adolph Smith",
  "type": "regular",
  "number": "sip:[email protected]",
  "is_favorite": false,
  "auto_answer": false,
  "in_black_list": false,
  "item_uid": 1
}

{
  "name": "Apartment 1111",
  "type": "regular",
  "number": "0001-01-11-11",
  "is_favorite": false,
  "auto_answer": true,
  "in_black_list": false,
  "item_uid": 2
}

{
  "name": "Panel",
  "type": "individual",
  "number": "001-01-11-11-1",
  "is_favorite": false,
  "auto_answer": false,
  "in_black_list": false,
  "item_uid": 3
}

{
  "name": "Outdoor",
  "type": "multi",
  "number": "0001-01-1",
  "is_favorite": false,
  "auto_answer": false,
  "in_black_list": false,
  "item_uid": 4
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  code string

  Possible values: [invalid_authentification, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  code string

  Possible values: [invalid_authentification, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentification",
    "message": "Log In"
  }
}

Loading...