Combination contacts (combined_contacts)

Requests

HTTP verb Endpoint Description

GET

/rest/v1/addressbook/combined_contacts

Getting a list of combined contacts

Getting a list of combined contacts

Returns contact data views, combining contacts and contactgroups into one list]. The group numbers are special values used by the system to expand the group into a set of contacts included in it.

Used in applications where selection is made from a common contact list, such as in a conference call management application and service.

Returns the entire scope of contacts and groups. Groups are always ahead. By default, returns a maximum of 1000 records unless otherwise specified in the parameter limit.

Each resource contains the following fields that map to fields of objects of type contact and contactgroup:

Resource field The field at contact The field at contactgroup

id

id

id

key

autokey

code

type

contact

contactgroup

name

displayname

name

number

number

group#<code>

Request

Table 1. Request parameters
Name Type Description

filter

object

field value filter: id, key, name, number.

offset

int

Offset in the list of resources to be issued.

limit

int

maximum number of resources in the list.

Request example
GET /rest/v1/addressbook/combined_contacts?offset=0&limit=2 HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "6f789596-0169-5710-017f-1c1b0d69174c",
    "key": "abc",
    "type": "contactgroup",
    "name": "ABC",
    "number": "group#abc"
  },
  {
    "id": "7b371f10-016a-0187-74fc-1c1b0d69174c",
    "type": "contact",
    "key": 1839,
    "name": "ABC",
    "number": "51515151"
  }
]