Создание сотрудника

Метод	`create.employees`
Описание	Создание сотрудника
Кому доступен	Агент, Клиент

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

Название	Тип	Обязательный	Допустимые значения	Описание
`access_token`	string	да		Ключ сессии аутентификации
`user_id`	number	нет		Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`first_name`	string	нет		Имя сотрудника
`last_name`	string	да		Фамилия сотрудника
`patronymic`	string	нет		Отчество сотрудника
`status`	enum	нет	available break do_not_disturb not_at_workplace not_at_work unknown	Статус сотрудника available - Доступен break - Перерыв do_not_disturb - Не беспокоить not_at_workplace - Нет на месте not_at_work - Нет на работе unknown - Неизвестно
`calls_available`	boolean	нет	`true`, `false`	Параметр будет удален в ближайшее время. Используйте вместо него параметры: in_external_allowed_call_directions, in_internal_allowed_call_directions Значение по умолчанию `"true"`. Доступность для звонков
`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` - отключена	Значение по умолчанию `"all"`. Статус записи разговоров Зависит от компонента "recording"
`schedule_id`	number	нет		График активности
Тренер
`coach`	object	нет		Тренер для сотрудника Зависит от компонента `"trainer"`
`coach_always_enabled`	boolean	нет	`true`, `false`	По умолчанию `"false"`. При активации опции все входящие звонки сотрудника будут дублироваться его тренеру. Значение `"true"` возможно установить если задан параметр `"coach_id"`.
`coach_id`	number	да		Уникальный идентификатор тренера
Группы в которых состоит сотрудник
`groups`	array	нет		Список уникальных идентификаторов групп в которых состоит сотрудник.
Телефоны
`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	нет	`true`, `false`	Значение по умолчанию `"false"`. В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящему абоненту будет предложено оставить голосовое сообщение.
`extension_queue_enabled`	boolean	нет	`true`, `false`	Значение по умолчанию `"false"`. В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер.
Является ли сотрудник оператором чата
`operator`	object	нет		Оператор рабочего места Зависит от компонента `"consultant"`
`operator_display_name`	string	да		Имя оператора в чате
`operator_login`	string	да		Логин сотрудника для входа в приложение «Рабочее место оператора»
`operator_password`	string	да	Минимальная длина 8	Пароль сотрудника для входа в приложение «Рабочее место оператора»
`operator_position_id`	number	нет		Должность сотрудника в подписи
`operator_offline_message_enabled`	boolean	нет	`true`, `false`	Значение по умолчанию `"false"`. Разрешено ли обрабатывать заявки
`operator_invite_to_chat_enabled`	boolean	нет	`true`, `false`	Значение по умолчанию `"false"`. Разрешено ли приглашать в чат
`operator_chat_enabled`	boolean	нет	`true`, `false`	Значение по умолчанию `"true"`. Разрешено ли участвовать в чатах с посетителями
`operator_sites`	array	нет		Список уникальных идентификаторов сайтов для которых доступен сотрудник.

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

Название	Тип	Обязательный	Описание
`id`	number	да	Уникальный идентификатор сотрудника

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

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"create.employees",
 "params":{
  "access_token":"string",
  "user_id":"number",
  "first_name":"string",
  "last_name":"string",
  "patronymic":"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",
  "email":"string",
  "groups":[
   "group_id"
  ],
  "call_recording":"enum",
  "schedule_id":"number",
  "coach":{
   "coach_always_enabled":"boolean",
   "coach_id":"number"
  },
  "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_password":"string",
   "operator_position_id":"number",
   "operator_offline_message_enabled":"boolean",
   "operator_invite_to_chat_enabled":"boolean",
   "operator_chat_enabled":"boolean",
   "operator_sites":[
    "site_id"
   ]
  }
 }
}

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

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "result":{
  "id":"number"
 }
}

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

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

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

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

Создание сотрудника

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

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

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

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

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