Редактирование сотрудника
Метод | update.employees |
---|---|
Описание | Создание сотрудника |
Кому доступен | Агент, Клиент |
Возможно частичное обновление. Если обновляется массив данных, то переданный массив будет полностью заменять существующий.
Параметры запроса
Название | Тип | Обязательный | Допустимые значения | Описание |
---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
id |
number | да | Уникальный идентификатор сотрудника | |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
|
first_name |
string | нет | Имя сотрудника | |
last_name |
string | да | Фамилия сотрудника | |
patronymic |
string | нет | Отчество сотрудника | |
status |
enum | нет |
|
Параметр будет удален в ближайшее время. Используйте вместо него параметр status_idСтатус сотрудника
|
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 | нет |
|
Параметр будет удален в ближайшее время. Используйте вместо него параметры: in_external_allowed_call_directions, in_internal_allowed_call_directionsКакие типы входящих звонков разрешены сотруднику
|
in_external_allowed_call_directions |
array | нет |
|
Какие направления вызовов разрешены сотруднику для входящих внешних звонков
|
in_internal_allowed_call_directions |
array | нет |
|
Какие направления вызовов разрешены сотруднику для входящих внутренних звонков
|
allowed_out_call_types |
array | нет |
|
Параметр будет удален в ближайшее время. Используйте вместо него параметры: out_external_allowed_call_directions, out_internal_allowed_call_directionsКакие типы исходящих звонков разрешены сотруднику
|
out_external_allowed_call_directions |
array | нет |
|
Какие направления вызовов разрешены сотруднику для исходящих внешних звонков
|
out_internal_allowed_call_directions |
array | нет |
|
Какие направления вызовов разрешены сотруднику для исходящих внутренних звонков
|
email |
string | нет | Адрес электронной почты сотрудника | |
call_recording |
enum | нет |
|
Статус записи разговоров Зависит от компонента
|
schedule_id |
number | нет | График активности | |
Тренер | ||||
coach |
object | нет |
Тренер для сотрудника
Зависит от компонента
|
|
coach_always_enabled |
boolean | нет |
true , false
|
При активации опции все входящие звонки сотрудника будут
дублироваться его тренеру.
Значение |
coach_id |
number | нет | Уникальный идентификатор тренера | |
Группы в которых состоит сотрудник | ||||
groups |
array | нет | Список уникальных идентификаторов групп в которых состоит сотрудник | |
Телефоны | ||||
phone_numbers |
array | да | 10 штук | Список телефонов сотрудника
Важно понимать, что при создании нового сотрудника номер уже может существовать у другого сотрудника и если номеру переданы новые параметры, то они будут так же обновлены уже существующему номеру |
phone_number |
string | да | Номер телефона сотрудника | |
channels_count |
number | нет | От 1 до 150 | Количество линий на телефоне |
dial_time |
number | нет | От 1 до 100 | Время дозвона по телефону |
status |
enum | нет |
active , inactive
|
Статус номера. |
Внутренний номер | ||||
extension |
object | нет | Внутренний номер сотрудника | |
extension_phone_number |
string | да | Максимальная длина 5 | Внутренний номер |
extension_voice_mail_enabled |
boolean | да |
true , false
|
В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящему абоненту будет предложено оставить голосовое сообщение. |
extension_queue_enabled |
boolean | да |
true , false
|
В случае, если все номера, указанные для этого сотрудника в списке телефонов, заняты, то звонящий абонент встанет в очередь на повторный дозвон до телефонов в списке и будет ждать первый освободившийся номер. |
Является ли сотрудник оператором чата | ||||
operator |
object | нет | Оператор рабочего места Зависит от компонента
|
|
operator_display_name |
string | нет | Имя оператора в чате | |
operator_login |
string | да | Логин сотрудника для входа в приложение «Рабочее место оператора» | |
operator_password |
string | да | Минимальная длина 8 | Пароль сотрудника для входа в приложение «Рабочее место оператора» |
operator_position_id |
number | нет | Должность сотрудника в подписи | |
operator_offline_message_enabled |
boolean | нет |
true , false
|
Разрешено ли обрабатывать заявки |
operator_invite_to_chat_enabled |
boolean | нет |
true , false
|
Разрешено ли приглашать в чат |
operator_chat_enabled |
boolean | нет |
true , false
|
Разрешено ли участвовать в чатах с посетителями |
operator_sites |
array | нет | Список уникальных идентификаторов сайтов для которых доступен сотрудник. |
JSON структура запроса
{
"jsonrpc":"2.0",
"id":"number",
"method":"update.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":{
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом update"