Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use get.customer_users.
first_name
string
no
Employee's first name.
last_name
string
yes
Employee's last name.
patronymic
string
no
Employee's middle name.
status
enum
no
available - available; break - on break; do_not_disturb - do not disturb; not_at_workplace - out of the office; not_at_work - not working; unknown - unknown
Employee status.
calls_available
boolean
no
true, false
Deprecated and scheduled for removal. Use in_external_allowed_call_directions and in_internal_allowed_call_directions instead. Indicates whether the employee is available for calls. Default: true.
allowed_in_call_types
array
no
internal - calls from employees; external - calls from customers
Deprecated and scheduled for removal. Use in_external_allowed_call_directions and in_internal_allowed_call_directions instead. Types of incoming calls the employee may receive.
in_external_allowed_call_directions
array
no
in - inbound; out - outbound
Allowed directions for incoming external calls.
in_internal_allowed_call_directions
array
no
in - inbound; out - outbound
Allowed directions for incoming internal calls.
allowed_out_call_types
array
no
internal - calls to employees; external - calls outside the company
Deprecated and scheduled for removal. Use out_external_allowed_call_directions and out_internal_allowed_call_directions instead. Types of outgoing calls the employee may place.
out_external_allowed_call_directions
array
no
in - inbound; out - outbound
Allowed directions for outgoing external calls.
out_internal_allowed_call_directions
array
no
in - inbound; out - outbound
Allowed directions for outgoing internal calls.
email
string
no
Employee email address.
call_recording
enum
no
all - all calls; in - inbound calls only; out - outbound calls only; off - disabled
Call-recording mode. Requires the recording component. Default: all.
schedule_id
number
no
Unique ID of the employee's work schedule.
Coaching
coach
object
no
Coaching settings for the employee. Requires the coach component.
coach_always_enabled
boolean
no
true, false
When true, all incoming calls to the employee are mirrored to the coach. Can be set to true only when coach_id is provided. Default: false.
coach_id
number
yes
Unique ID of the employee assigned as the coach.
Employee groups
groups
array
no
IDs of the groups the employee belongs to.
Phone numbers
phone_numbers
array
no
Maximum: 10 entries
Employee phone numbers. A phone number may already be assigned to another employee. If settings are supplied for an existing number, those settings are updated for the existing number as well.
phone_number
string
yes
Employee phone number. The value may include an extension, for example "74955140578...2345", and therefore does not have to follow E.164. SIP values are stored as PSTN-type phone numbers.
channels_count
number
no
1 to 150
Number of concurrent channels for the phone. Default: 1.
dial_time
number
no
1 to 100
Ringing duration, in seconds. Default: 60.
status
enum
no
active, inactive
Phone number status. Default: active.
Extension
extension
object
no
Employee extension settings.
extension_phone_number
string
yes
Maximum length: 5 characters
Employee extension number.
extension_voice_mail_enabled
boolean
no
true, false
When true, callers are prompted to leave a voicemail if all of the employee's phone numbers are busy. Default: false.
extension_queue_enabled
boolean
no
true, false
When true, callers wait in a queue until one of the employee's phone numbers becomes available. Default: false.
Chat operator settings
operator
object
no
Chat operator settings. Requires the consultant component.
operator_display_name
string
yes
Display name shown in chats.
operator_login
string
yes
Login used to access the Operator Workspace.
operator_password
string
yes
Minimum length: 8 characters
Password used to access the Operator Workspace.
operator_position_id
number
no
Unique ID of the position shown in the operator signature.
operator_offline_message_enabled
boolean
no
true, false
Whether the operator may handle offline messages. Default: false.
operator_invite_to_chat_enabled
boolean
no
true, false
Whether the operator may invite visitors to a chat. Default: false.
operator_chat_enabled
boolean
no
true, false
Whether the operator may participate in visitor chats. Default: true.