Возвращает список контактов, хранимых в адресной базе. При передаче хотя бы одного ID в параметре field_ids вывод будет дополнен значениями указанных дополнительных полей контакта.
API ver.10.0.0 Пользователь
| Запрос | |||
| Параметр | Тип | Значение | Описание |
class * | String | contact | |
method * | String | get_list | |
sid * | String | — | Идентификатор сессии пользователя. |
param | |||
contact_name | String | — | Фильтр по имени. |
deleted | Number | — | Фильтр удаленных. Допустимые значения: 0 1 |
contact_id | Number|Number[] | — | ID контакта или массив ID контактов. |
contact_parent_id | Number | — | ID родительского контакта. |
user | Number | — | Фильтр контактов, связанных с пользователями. Допустимые значения: 0 1 |
field_ids | Number[] | — | ID дополнительных полей для выборки. |
has_fields | Number[] | — | ID дополнительных полей, значения которых нужно вернуть отдельным массивом. |
tag_ids | Number[] | — | ID меток для фильтрации. |
field_filter_ids | Object[] | — | Фильтры по значениям дополнительных полей. |
field_filter_ids.id * | Number | — | ID поля. |
field_filter_ids.value * | String|Number | — | Значение для фильтра. |
field_filter_ids.compare_type * | String | — | Тип сравнения. |
field_order_by | Number | — | ID поля для сортировки. |
start | Number | — | Смещение. |
limit | Number | 1000 | Лимит. |
| * – обязательные параметры | |||
| Ответ | ||
| Параметр | Тип | Описание |
response * | Object[] | Массив объектов контактов. |
contact_id * | Number | ID контакта. |
contact_name * | String | Имя контакта. |
contact_parent_id * | Number|Null | ID родительского контакта. |
contact_deleted * | Number|Null | Дата удаления контакта. |
contact_created | Number | Дата создания контакта. |
contact_edited | Number|Null | Дата последнего изменения контакта. |
chat_id * | Number | ID чата контакта. |
like | Number|Null | ID пользователя, добавившего контакт в избранное. |
user_id | Number|Null | ID пользователя, связанного с контактом. |
fields | Object | Объект значений выбранных дополнительных полей. |
fields.field_id | Object|Object[] | Объект значения поля или массив объектов для селект-поля; ключ соответствует ID поля. |
fields.field_id.field_value_id | Number | ID значения поля. |
fields.field_id.field_char_value | String|Number|Object|Object[] | Значение текстового или SET-поля. |
fields.field_id.field_integer_value | Number | Значение числового поля. |
fields.field_id.field_double_value | Number | Значение дробного поля. |
fields.field_id.name | String | Имя файла. |
fields.field_id.href | String | Публичная ссылка на файл. |
fields.field_id.token | String | Токен доступа к файлу. |
has_fields | Object[] | Массив объектов значений полей, переданных в has_fields. |
has_fields.field_system | Number|Null | Признак предустановленного поля: 1 или null. |
tags | Object[] | Массив объектов меток контакта. |
tags.tag_id | Number | ID метки. |
tags.tag_name | String | Название метки. |
tags.tag_style | String | Цвет метки. |
| * – обязательные параметры | ||