Information about user activity: onsite, another_session, has_session.
sort
String
no
Column name for sorting: id, name, realname, email, department.
pagesize
Positive integer
no
Number of records per result page.
startidx
Non-negative integer
no
Offset of the first record for pagination.
Create employee
Function: employee.edit
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → click Add.
The function creates a new employee. Requires confirmation via parameter sok.
Access level: root, admin
Parameter
Type
Required
Value
name
String
yes
Login for system access.
realname
String
no
Last name, First name, Patronymic (if necessary) of the employee.
position
String
no
Employee position. Displayed in requests in the BILLmanager 6 interface.
passwd
String
yes
Access password.
confirm
String
yes
Password confirmation (must match passwd).
email
String
no
Employee email.
phone
String
no
Employee phone number. Can be used for sending SMS notifications.
department
String (list)
no
Departments to which the employee must be included. Listed via comma.
default_access_allow
Flag
no
Allow the employee full access, overriding department permissions. Setting it to on enables the option.
all_ip_access
Flag
no
Allow access from any IP address. Setting it to on enables the option.
ip_access
String (list)
no
List of allowed IP addresses. Used if all_ip_access is not set.
sok
String
yes
Setting the value to ok confirms operation execution. Without this parameter, changes will not be applied.
Edit employee data
Function: employee.edit
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → click Edit.
The function is used for editing an existing employee. Requires confirmation via parameter sok.
Access level: root, admin
Parameter
Type
Required
Value
elid
Positive integer
yes
Unique identifier of the employee to be edited.
name
String
no
New login for system access.
realname
String
no
New full name of the employee.
position
String
no
New employee position.
passwd
String
no
New access password. If not specified — password is not changed.
confirm
String
no
Confirmation of the new password.
email
String
no
New employee email.
phone
String
no
New employee phone number.
department
String (list)
no
Departments to which the employee belongs. Listed via comma.
default_access_allow
Flag
no
Set full access. Setting the value to on enables, empty value — disables.
all_ip_access
Flag
no
Allow access from any IP address. Setting the value to on enables, empty — disables.
ip_access
String (list)
no
New list of allowed IP addresses.
sok
String
yes
Setting the value to ok confirms operation execution.
Delete employee
Function: employee.delete
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → click Delete.
Supports deletion of multiple employees via comma. Confirmation via parameter sok is required. Cannot delete the current session (self=on).
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several id of employees via comma. For example, 123,456.
sok
String
yes
Setting the value to ok confirms operation execution.
Enable access to billing
Function: employee.resume
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → select the employee → click Enable.
Activates employee access to the system. Hidden if the employee is already active (enabled=on).
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several id of employees via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Disable access to billing
Function: employee.suspend
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → select the employee → click Disable.
Suspends employee access to the system. Hidden if the employee is already inactive (enabled=off).
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several id of employees via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Terminate employee sessions
Function: employee.logout
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → click Log out.
Terminates all active sessions of the employee. Available only if an active session exists (has_session=on) and for other accounts (self=off).
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several id of employees via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Log in with employee rights
Function: employee.su
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → select the employee → click Log in.
Opens a session on behalf of the selected employee. Hidden with restriction not_admin_to_admin.
Access level: root, admin
Parameter
Type
Required
Value
elid
Positive integer
yes
Unique identifier of the employee login under which the request must be performed.
Set access rights
Function: rights2.user
Result: list of elements
In the platform web interface: Provider section → Staff → select the employee → click Perm.
Returns a list of available rights for assignment to the account.
Access level: root, admin
Parameter
Type
Required
Value
elid
String
no
Filter by right name (element name).
caption
String
no
Right name. Wildcard character * is supported.
access
Flag
no
Access status: on — the right is enabled, off — disabled.
Enable access right
Function: rights2.user.resume
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → Perm. section → click Enable.
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several right names (name) via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Disable access right
Function: rights2.user.suspend
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → Perm. section → click Disable.
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several right names (name) via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Employee list filter
Function: employee.filter
Result: successful operation completion or an error message.
In the platform web interface: filter panel in the section Staff.
Filter conditions are saved and applied to all subsequent calls to employee until changed or reset.
Access level: root, admin, user
Parameter
Type
Required
Value
name
String
no
Filter by login. Wildcard character * is supported.
realname
String
no
Filter by full name. Wildcard character * is supported.
email
String
no
Filter by email. Wildcard character * is supported.
department
String
no
Filter by departments. Wildcard character * is supported.
reset
Flag
no
Setting the value to on resets all set filters.
Employee department
Function: employee.department
Result: list of elements
In the platform web interface: Provider section → Staff → select the employee → click Departments.
Returns a list of departments to which the employee belongs.
Access level: root, admin
Parameter
Type
Required
Value
elid
Positive integer
no
Department identifier.
name
String
no
Department name. Wildcard character * is supported.
status
String
no
Department status: on — active, off — inactive.
Include employee in department
Function: employee.department.resume
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → section Departments → click Assign.
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several id of "employee-department" association records via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Exclude employee from department
Function: employee.department.suspend
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → section Departments → click Unassign.
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several id of "employee-department" association records via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Delete department association
Function: employee.department.delete
Result: successful operation completion or an error message.
In the platform web interface: Provider section → section Departments → click Delete.
Access level: root, admin
Parameter
Type
Required
Value
elid
String (list)
yes
One or several id of association records via comma.
sok
String
yes
Setting the value to ok confirms operation execution.
Sending SMS
Function: employee.sms
Result: successful operation completion or an error message.
For the option to work, an SMS gateway must be configured.
In the platform web interface: Provider section → Staff → click SMS.
Sends an SMS message to the employee. Parameter sok is required for modification/creation.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
no
Employee identifier for viewing or sending SMS.
type
String
no
The phone number type for sending: phone, mobile, etc.
phone
String
no
The phone number to which the message will be sent.
message
String
no
Text of the message to be sent.
sok
String
no
Setting the value to ok confirms message sending.
Support center settings
Function: employee.support_tool_settings
Result: successful operation completion or an error message.
In the platform web interface: Provider section → Staff → click Settings.
Returns or modifies parameters of the support center operation for the employee.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
no
Employee identifier for viewing settings.
param_name
String
no
Name of the configurable parameter.
param_value
String
no
New parameter value.
sok
String
no
Setting the value to ok confirms saving changes.
Assign responsible employee
Function: support_tool_responsible
Result: successful operation completion or an error message.
In the platform web interface: click Transfer in the ticket.
Assigns a request to an employee or department. Use either elid or plid. When using plid, you must log in as the employee to whom the ticket is assigned.
Access level: root, admin
Parameter
Type
Required
Value
elid
Positive integer
yes
id of the request in the "All tickets" section.
plid
Positive integer
yes
id of the request in the "Tickets" section.
set_responsible
Positive integer
yes
id of the employee or department. For a department, the prefix d_ is used.
set_responsible_default
Flag
no
Setting the value to on will assign the default responsible person.
sok
String
no
Setting the value to ok allows submitting the form.
su
String
no
The employee login to be used when executing the request.
En
Es