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
• P2 P

---

Schema

• name string

  Possible values: non-empty and <= 30 characters

  Contact name

• type string

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

  Contact number type

• number string

  There is two format: inner number and SIP number

  Inner number for different devices:

  • regular like [building]-[unit]-[floor]-[apartment], for example '0001-01-11-11'
  • individual like [building]-[unit]-[floor]-[apartment]-[device number], for example '001-01-11-11-1'
  • multi like [building]-[unit]-[device number], for example '0001-01-01'

  	regular	individual	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

• ringtone string

  Default value: ring1.wav

  Name of the ringtone file that will be played on incoming call from this contact.

• is_p2p boolean

  Default value: false

  Indicates that the SIP number is for peer2peer calls

• item_uid integer

  UID for entities references

{
  "name": "Adolph Smith",
  "type": "multi",
  "number": "0001-01-11-11",
  "is_favorite": true,
  "auto_answer": true,
  "in_black_list": false,
  "ringtone": "ring3.wav",
  "is_p2p": true,
  "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,
  "ringtone": "ring4.wav",
  "is_p2p": false
}

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

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

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

{
  "name": "Neighbour",
  "type": "individual",
  "number": "sip:[email protected]",
  "is_favorite": false,
  "auto_answer": false,
  "in_black_list": false,
  "ringtone": "ring4.wav",
  "is_p2p": true,
  "item_uid": 5
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, 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

  Describes the parameter that did not pass a validation

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

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, 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

  Describes the parameter that did not pass a validation

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

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

Loading...