Получение списка групп контактов адресной книги
Получение списка групп контактов адресной книги
Метод |
get.group_contacts |
Описание |
Получение списка групп контактов адресной книги |
Кому доступен |
Агент, Клиент |
Параметры запроса
Название |
Тип |
Обязательный |
Описание |
access_token |
string |
да |
Ключ сессии аутентификации |
user_id |
number |
нет |
Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number |
нет |
Количество возвращаемых записей. См. раздел "Постраничный вывод" |
offset |
number |
нет |
Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод" |
filter |
object |
нет |
См. раздел "Критерии фильтрации" |
fields |
array |
нет |
См. раздел "Представление возвращаемых данных" |
sort |
array |
нет |
См. раздел "Сортировка данных" |
Параметры ответа
Название |
Тип |
Допустимые значения |
Фильтрация |
Сортировка |
Описание |
id |
number |
|
да |
|
Уникальный идентификатор группы контактов адресной
книги |
name |
string |
|
да |
да |
Название группы контактов |
is_system |
boolean |
|
да |
|
Признак, что группа системная и ее нельзя удалить |
Список контактов входящих в группу |
members |
array |
|
да |
|
Список уникальных идентификаторов контактов, которые
входят в группу. |
contact_id |
number |
|
|
|
Уникальный идентификатор контакта, см. метод "get.contacts" |
contact_full_name |
string |
|
|
|
Фамилия Имя Отчество контакта |
JSON структура запроса
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.group_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",
"name":"string",
"is_system":"boolean",
"members":[
{
"contacts_id":"number",
"contact_full_name":"string"
}
]
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"