Получение списка контактов в адресной книге
Получение списка контактов в адресной книге
Метод |
get.contacts |
Описание |
Получение списка контактов в адресной книге |
Кому доступен |
Агент, Клиент |
Параметры запроса
Название |
Тип |
Обязательный |
Описание |
access_token |
string |
да |
Ключ сессии аутентификации |
user_id |
number |
нет |
Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number |
нет |
Количество возвращаемых записей. См. раздел "Постраничный вывод" |
offset |
number |
нет |
Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод" |
filter |
object |
нет |
См. раздел "Критерии фильтрации" |
fields |
array |
нет |
См. раздел "Представление возвращаемых данных" |
sort |
array |
нет |
См. раздел "Сортировка данных" |
Параметры ответа
Название |
Тип |
Допустимые значения |
Фильтрация |
Сортировка |
Описание |
id |
number |
|
да |
|
Уникальный идентификатор контакта |
first_name |
string |
|
да |
да |
Имя контакта |
last_name |
string |
|
да |
да |
Фамилия контакта |
patronymic |
string |
|
|
|
Отчество контакта |
full_name |
string |
|
да |
да |
Фамилия Имя Отчество |
emails |
array |
Максимум 10
адресов |
да |
|
Адрес электронной почты контакта. |
phone_numbers |
array |
Максимум 10
номеров |
да |
|
Список номеров контакта |
Персональный менеджер |
personal_manager_id |
number |
|
да |
|
Уникальный идентификатор персонального
менеджера |
personal_manager_full_name |
string |
|
да |
|
Фамилия Имя Отчество персонального
менеджера |
Организация |
organization_id |
number |
|
да |
|
Уникальный идентификатор организации |
organization_name |
string |
|
да |
|
Название организации |
Группы в которых состоит контакт |
groups |
array |
|
да |
|
Список групп в которых состоит контакт |
group_id |
number |
|
|
|
Уникальный идентификатор группы |
group_name |
string |
|
|
|
Название группы |
JSON структура запроса
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.contacts",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"id":"number",
"last_name":"string",
"first_name":"string",
"patronymic":"string",
"full_name":"string",
"emails":[
"email"
],
"groups":[
{
"group_id":"number",
"group_name":"string"
}
],
"phone_numbers":[
"number"
],
"personal_manager_id":"number",
"personal_manager_full_name":"string",
"organization_name":"string",
"organization_id":"number"
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"