Get Contact list

Returns list of all contacts

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• List

---

Schema

• list_items object[]

  List of added contacts

{
  "list_items": [
    {
      "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
    }
  ]
}

{
  "list_items": [
    {
      "name": "Apartment 1111",
      "type": "regular",
      "number": "0001-01-11-11",
      "is_favorite": true,
      "auto_answer": true,
      "in_black_list": false,
      "item_uid": 1,
      "ringtone": "ring1.wav",
      "is_p2p": false
    },
    {
      "name": "Panel",
      "type": "individual",
      "number": "0001-01-11-11-1",
      "is_favorite": false,
      "auto_answer": false,
      "in_black_list": false,
      "item_uid": 2,
      "ringtone": "ring1.wav",
      "is_p2p": false
    },
    {
      "name": "Outdoor",
      "type": "multi",
      "number": "0001-01-1",
      "is_favorite": false,
      "auto_answer": false,
      "in_black_list": false,
      "item_uid": 3,
      "ringtone": "ring2.wav",
      "is_p2p": false
    },
    {
      "name": "Adolph Smith",
      "type": "regular",
      "number": "sip:[email protected]",
      "is_favorite": false,
      "auto_answer": false,
      "in_black_list": false,
      "item_uid": 4,
      "ringtone": "ring4.wav",
      "is_p2p": false
    }
  ]
}

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 an string"
    }
  }
}

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

Loading...