Получение списка групп сотрудников

Метод	`get.group_employees`
Описание	Получение списка групп сотрудников
Кому доступен	Агент, Клиент

Параметры запроса

Название	Тип	Обязательный	Описание
`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		да	да	Название группы
Список сотрудников в группе
`members`	array				Список уникальных идентификаторов сотрудников, которые состоят в группе
`employee_id`	number				Уникальный идентификатор сотрудника
`employee_full_name`	string				Ф.И.О. сотрудника
Список номеров сотрудников в группе и их доступность
`phone_numbers`	array		да		Список городских, мобильных и sip номеров сотрудников, которые входят в группу, с указанием их доступности и приоритетом обзвона. Приоритет обзвона номеров определяется положением номера в списке. Обзвон указанного списка номеров в группе возможен по внутреннему номеру группы (см. параметр `"group_phone_number"`). Для изменения приоритета и доступности номера в группе см. метод `"update.group_employees_numbers"`
`employee_phone_number`	string				Номер телефона сотрудника
`employee_phone_number_id`	number				Уникальный идентификатор номера сотрудника в группе
`employee_full_name`	string				Ф.И.О. сотрудника
`employee_id`	number				Уникальный идентификатор сотрудника
`available`	boolean				Доступность номера в группе
Настройка внутреннего номмера группы
`group_phone_number`	string	Максимальная длина 5	да	да	Внутренний номер группы
`queue_enabled`	boolean		да		Значение по умолчанию `"false"`. В случае, если все номера, указанные для этой группы сотрудников, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
`channels_count`	number	От 1 до 199	да		Количество одновременных линий при обзвоне

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.group_employees",
  "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",
        "members":[
          {
            "employee_id":"number",
            "employee_full_name":"string"
          }
        ],
        "phone_number":[
          {
            "employee_phone_number":"string",
            "employee_phone_number_id":"number",
            "employee_full_name":"string",
            "employee_id":"number",
            "available":"boolean"
          }
        ],
        "group_phone_number":"string",
        "queue_enabled":"boolean",
        "channels_count":"number"
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"