Комбинированные контакты (combined_contacts)

Содержание

Запросы
- Получение списка комбинированных контактов

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`GET`	`/rest/v1/addressbook/combined_contacts`	Получение списка комбинированных контактов

GET

/rest/v1/addressbook/combined_contacts

Получение списка комбинированных контактов

Возвращает представления контактных данных, объединяя в один список контакты и группы контактов. В качестве номеров групп выступают спец-значения, используемые системой для разворота группы в совокупность входящих в нее контактов.

Применяется в приложениях, где осуществляется выбор из общего списка контактов, например в приложении и сервисе управления селекторными совещаниями.

Возвращает весь объем контактов и групп. Группы всегда впереди. По умолчанию возвращает не более 1000 записей, если иное не указано в параметре limit.

Каждый ресурс содержит следующие поля, сопоставляемые с полями объектов типа contact и contactgroup:

Поле ресурса Поле у contact Поле у contactgroup

Поле ресурса	Поле у contact	Поле у contactgroup
`id`	`id`	`id`
`key`	`autokey`	`code`
`type`	`contact`	`contactgroup`
`name`	`displayname`	`name`
`number`	`number`	`group#<code>`

id

key

autokey

code

type

contact

contactgroup

name

displayname

name

number

group#<code>

Запрос

Table 1. Параметры запроса
Имя	Тип	Описание
`filter`	`object`	фильтр по значениям полей: id, key, name, number.
`offset`	`int`	смещение в списке ресурсов, подлежащих выдаче.
`limit`	`int`	максимальное количество ресурсов в списке.

Подробно про формат параметров GET-запроса

Пример запроса

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

Ответ

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"
  }
]