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

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

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

Название	Тип	Обязательный	Описание
`access_token`	string	да	Ключ сессии аутентификации
`user_id`	number	нет	Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет	Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет	Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`filter`	object	нет	См. раздел "Критерии фильтрации"
`fields`	array	нет	См. раздел "Представление возвращаемых данных"
`sort`	array	нет	См. раздел "Сортировка данных"

Параметры ответа

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number		да		Уникальный идентификатор сотрудника
`login`	string		да	да	Логин пользователя для доступа в личный кабинет
`first_name`	string		да	да	Имя сотрудника
`last_name`	string		да	да	Фамилия сотрудника
`patronymic`	string			да	Отчество сотрудника
`full_name`	string		да	да	Фамилия Имя Отчество
`status`	enum	available break do_not_disturb not_at_workplace not_at_work unknown	да		Параметр будет удален в ближайшее время. Используйте вместо него параметр status_id Статус сотрудника. Будет заполнен, если у сотрудника выбран стандартный статус available - Доступен break - Перерыв do_not_disturb - Не беспокоить not_at_workplace - Нет на месте not_at_work - Нет на работе auto_out_call - Исходящий обзвон unknown - Неизвестно
`status_id`	number		да		Уникальный идентификатор статуса. Для получения полного списка статусов необходимо использовать метод "get.statuses"
`calls_available`	boolean	`true`, `false`	да	да	Параметр будет удален в ближайшее время. Используйте вместо него параметры: in_external_allowed_call_directions, in_internal_allowed_call_directions Доступность для звонков
`allowed_in_call_types`	array	internal external	да		Параметр будет удален в ближайшее время. Используйте вместо него параметры: in_external_allowed_call_directions, in_internal_allowed_call_directions Какие типы входящих звонков разрешены сотруднику internal - внутренние звонки от сотрудников компании external - внешние звонки от клиентов
`in_external_allowed_call_directions`	array	in out	да		Какие направления вызовов разрешены сотруднику для входящих внешних звонков in - входящие вызовы out - исходящие вызовы
`in_internal_allowed_call_directions`	array	in out	да		Какие направления вызовов разрешены сотруднику для входящих внутренних звонков in - входящие вызовы out - исходящие вызовы
`allowed_out_call_types`	array	internal external	да		Параметр будет удален в ближайшее время. Используйте вместо него параметры: out_external_allowed_call_directions, out_internal_allowed_call_directions Какие типы исходящих звонков разрешены сотруднику internal - внутренние звонки на сотрудников компании external - звонки за пределы компании
`out_external_allowed_call_directions`	array	in out	да		Какие направления вызовов разрешены сотруднику для исходящих внешних звонков in - входящие вызовы out - исходящие вызовы
`out_internal_allowed_call_directions`	array	in out	да		Какие направления вызовов разрешены сотруднику для исходящих внутренних звонков in - входящие вызовы out - исходящие вызовы
`email`	string		да		Адрес электронной почты сотрудника
`call_recording`	enum	`all` - для всех звонков; `in` - только для входящих; `out` - только для исходящих; `off` - отключена	да		Статус записи разговоров
`schedule_id`	number		да		Уникальный идентификатор графика активности
`schedule_name`	string		да		Название графика активности
Тренер
`coach`	object		да		Тренер для сотрудника
`coach_full_name`	string				Ф.И.О тренера
`coach_id`	number				Уникальный идентификатор тренера Выбирается из списка сотрудников
`coach_always_enabled`	boolean	`true`, `false`			При активации опции все входящие звонки сотрудника будут дублироваться его тренеру.
Группы сотрудника
`groups`	array		да		Группы вкоторых состоит сотрудник
`group_id`	number				Уникальный идентификатор группы
`group_name`	string				Название группы
Телефоны
`phone_numbers`	array	10 штук	да		Список телефонов сотрудника. Список номеров должен быть отсортирован по приоритету.
`phone_number`	string				Номер телефона сотрудника. Формат номера может быть с донабором, к примеру `"74955140578...2345"`, поэтому у номера не формат E164 Если указан SIP, то не делаем связки, а просто добавляем как номер типа ТФОП, т.е. как обычный номер
`channels_count`	number	От 1 до 150			Значение по умолчанию `"1"`. Количество линий на телефоне
`dial_time`	number	От 1 до 100			Значение по умолчанию `"60"`. Время дозвона по телефону. Значение в секундах.
`status`	enum	`active`, `inactive`			Значение по умолчанию `"active"`. Статус номера.
Внутренний номер
`extension`	object		да		Внутренний номер и его настройки
`extension_phone_number`	string	Максимальная длина 5			Внутренний номер
`extension_voice_mail_enabled`	boolean				В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящему абоненту будет предложено оставить голосовое сообщение.
`extension_queue_enabled`	boolean				В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
Сотрудник является оператором чата
`operator`	object				Оператор рабочего места
`operator_display_name`	string				Имя оператора в чате
`operator_login`	string				Логин оператора для входа в приложение «Рабочее место оператора»
`operator_position_id`	number				Уникальный идентификатор должности оператора в подписи
`operator_position_name`	string				Название должности оператора в подписи
`operator_offline_message_enabled`	boolean				Разрешено ли обрабатывать заявки
`operator_invite_to_chat_enabled`	boolean				Разрешено ли приглашать в чат
`operator_chat_enabled`	boolean				Разрешено ли участвовать в чатах с посетителями
`operator_chats_available`	boolean	`true`, `false`			Доступность для чатов
Сайт
`operator_sites`	array				Список уникальных идентификаторов и адресов сайтов для которых доступен оператор
`site_id`	number				Уникальный идентификатор сайта
`site_domain_name`	string				Адрес сайта в интернете. Без указания протокола - `"http://"` или `"https://"`.

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

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.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",
    "first_name":"string",
        "login":"string",
    "last_name":"string",
    "patronymic":"string",
    "full_name":"string",
    "email":"string",
    "status": "enum",
    "calls_available":"boolean",
    "allowed_in_call_types": "array",
    "in_external_allowed_call_directions": "array",
    "in_internal_allowed_call_directions": "array",
    "allowed_out_call_types": "array",
    "out_external_allowed_call_directions": "array",
    "out_internal_allowed_call_directions": "array",
    "groups":[
     {
      "group_id":"number",
      "group_name":"string"
     }
    ],
    "call_recording":"enum",
    "schedule_id":"number",
    "schedule_name":"string",
    "coach":{
     "coach_id":"number",
     "coach_full_name":"string",
     "coach_always_enabled":"boolean"
    },
    "phone_numbers":[
     {
      "phone_number":"string",
      "channels_count":"number",
      "dial_time":"number",
      "status":"enum"
     }
    ],
    "extension":{
     "extension_phone_number":"string",
     "extension_voice_mail_enabled":"boolean",
     "extension_queue_enabled":"boolean"
    },
    "operator":{
     "operator_login":"string",
     "operator_display_name": "string",
     "operator_position_id":"number",
     "operator_position_name":"string",
     "operator_offline_message_enabled":"boolean",
     "operator_invite_to_chat_enabled":"boolean",
     "operator_chat_enabled":"boolean",
     "operator_chats_available":"boolean",
     "operator_sites":[
      {
       "site_id":"number",
       "site_domain_name":"string"
      }
     ]
    }
   }
  ]
 }
}

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

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

Виртуальные номера

Оборудование

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

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

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

Параметры ответа

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

JSON структура ответа

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