en En
es Es

Support tickets (ticket)

Support tickets on behalf of an administrator account

Object: ticket

Result: list of items

Access level: admin

ParameterTypeRequiredValue
ticketPositive integerNoSupport ticket code.
nameStringNoSupport ticket subject. Contains a brief description of the issue.
clientStringNoClient who created the ticket.
delayStringNoSupport ticket wait time in queue.
deadlineStringNoDeadline when the response regulation for the ticket expires.
responsibleStringNoDepartment or staff member to whom the ticket is assigned.
projectStringNoProvider to which the ticket belongs.
queuePositive integerNoInternal weight (priority) of the ticket.
propsString (enumeration)No

Additional information about the ticket. Possible values:

  • from_gate — message received via email;
  • note — comment to the client;
  • accgroup — client belongs to groups;
  • unread — there are unread messages;
  • abuse — ticket is related to a violation;
  • abuse_id — ID of the client whose ticket is related to a violation;
  • priority — current ticket priority;
  • favorite — ticket is in favorites;
  • highpriority — priority raised manually;
  • attitude — client characteristic;
  • premium — client has paid support;
  • from_abuse_process — ticket moved to active due to lack of client response.

Open a ticket

Function: ticket.edit

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Open.

Opens the form for viewing and responding to the ticket. The function is used to view parameters, create, and modify an object.

Access level: root, admin

ParameterTypeRequiredValue
elidPositive integerNoUnique ticket identifier.
plidPositive integerNoUnique identifier of the parent list.
nameStringNoSupport ticket subject.
messageStringNoMessage text. Supports Markdown markup.
ticket_itemStringNoService to which the ticket relates.
ticket_project_selectStringNoProvider to which the ticket subject relates.
client_departmentStringNoProvider department to which the ticket will be forwarded.
priorityString (enumeration)No

Support ticket priority. Possible values:

  • 0 — low;
  • 1 — medium;
  • 2 — high.
client_priorityString (enumeration)No

Support ticket priority (client-side). Possible values:

  • 0 — low;
  • 1 — medium;
  • 2 — high.
show_optionalFlagNoShow additional fields.
note_messageStringNoInternal comment. Visible only to staff.
ticket_expenseStringNoAmount of funds to be debited from the client account.
high_priorityFlagNoThe value on raises the ticket priority.
low_priorityFlagNoThe value on resets the elevated priority flag.
incident_countPositive integerNoNumber of support tickets.
show_abuseFlagNoRegister a violation. The value on displays violation registration parameters.
scorePositive integerNoNumber of points for the violation.
score_noteStringNoComment to the violation.
actionStringNoFunction applied to the violation.
deadline_dateDate and timeNoDeadline date. Format: YYYY-MM-DD
deadline_timeDate and timeNoDeadline time. Format: HH:MM:SS
sokStringNoThe value ok confirms the operation. Without this parameter, changes will not be applied.

Close the ticket

Function: ticket.delete

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Close.

Closes the ticket. Removes it from the queue. Requires confirmation via the sok parameter.

Access level: root, admin

ParameterTypeRequiredValue
elidString (list)YesOne or more ticket identifiers separated by commas. For example, 123,456.
sokStringYesThe value ok confirms the operation.

Unblock the ticket

Function: ticket.unblock

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Unblock.

Unblocks the ticket. Requires confirmation via the sok parameter.

Access level: root, admin

ParameterTypeRequiredValue
elidString (list)YesOne or more ticket identifiers separated by commas. For example, 123,456.
sokStringYesThe value ok confirms the operation.

Add to favorites

Function: ticket.favorite

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Favorite tickets.

Adds the ticket to favorites. Requires confirmation via the sok parameter.

Access level: root, admin

ParameterTypeRequiredValue
elidString (list)YesOne or more ticket identifiers separated by commas. For example, 123,456.
sokStringYesThe value ok confirms the operation.

Display list of messages

Function: ticket.message

Result: list of items

UI Equivalent: go to SupportSupport tickets → click Replies.

Returns a list of ticket messages. Supports filtering and pagination.

Access level: root, admin

ParameterTypeRequiredValue
elidPositive integerYesUnique identifier from the ticket function.
idPositive integerNoMessage identifier.
messageStringNoMessage text.
date_postDate and timeNoDate of writing. Format: YYYY-MM-DD HH:MM:SS
message_userStringNoMessage author.

Edit a message

Function: ticket.message.edit

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Replies → click Open.

Used to edit message text. Supports Markdown. Requires confirmation via the sok parameter.

Access level: root, admin

ParameterTypeRequiredValue
plidPositive integerYesIdentifier of the parent ticket. Element id from the ticket function.
elidPositive integerNoElement id from the ticket.message function. Not specified when creating a new message.
messageStringYesMessage text. Supports Markdown markup.
sokStringYesThe value ok confirms the operation.

Split the ticket into two, starting from the selected message

Function: ticket.split

Result: successful operation or error message

Splits the ticket into two. Starts from the selected message. Requires confirmation via the sok parameter.

Access level: root, admin

ParameterTypeRequiredValue
elidString (list)YesOne or more ticket identifiers separated by commas. For example, 123,456.
sokStringYesThe value ok confirms the operation.

Hide a message

Function: ticket.message.delete

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Replies → click Hide.

Hides a message from the client. Does not delete the record from the database. Requires confirmation via the sok parameter.

Access level: root, admin

ParameterTypeRequiredValue
elidString (list)YesOne or more ticket identifiers separated by commas. For example, 123,456.
sokStringYesThe value ok confirms the operation.

Set a client filter

Function: ticket.setfilter

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Filter by client.

Sets client-based selection conditions. Parameters are passed in the ticket body. Filter conditions are saved and applied each time the list is displayed until changed or reset.

Access level: root, admin

ParameterTypeRequiredValue
elidString (list)YesOne or more client identifiers separated by commas. For example, 123,456.

Apply advanced filter

Function: ticket.filter

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Filter.

Applies advanced filtering conditions to the ticket list. Supports filtering by number, provider, department, product type, and other parameters.

Access level: root, admin

ParameterTypeRequiredValue
resetFlagNoReset the filter.

Log in to the panel with client rights

Function: ticket.su

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Log in.

Performs login to the control panel with the rights of the selected client to view their data.

Access level: root, admin

Support tickets under a client account

Function: clientticket

Result: list of items

Access level: user

ParameterTypeRequiredValue
idPositive integerYesUnique identifier.
nameStringNoSupport ticket subject.
last_messageStringNoLast message.
wait_timeStringNoDelay. Response wait time.
create_userStringNoAuthor of the ticket.
tstatusString (enumeration)No

Support ticket status. Possible values:

  • 0 — new;
  • 1 — under review;
  • 2 — awaiting response;
  • 3 — closed;
  • 10 — archived.

Set a filter

Function: clientticket.filter

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Filter. Available under a client account.

Sets selection conditions for the client ticket list.

Access level: user

Purchase technical support tickets

Function: incident

Result: successful operation or error message

Allows a client to purchase additional technical support tickets. Available when paid support is configured.

Access level: user

ParameterTypeRequiredValue
elidPositive integerNoClient identifier.
countPositive integerNoNumber of tickets.
sokStringNoThe value ok confirms the operation.

Edit the ticket

Function: clientticket.edit

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click Open. Available under a client account.

Creates a new ticket or modifies an existing one. A client can add a message to an active ticket.

Access level: user

ParameterTypeRequiredValue
elidPositive integerYesSupport ticket identifier.
nameStringNoSupport ticket subject.
ticket_itemStringNoService to which the ticket relates.
ticket_project_selectStringNoProvider to which the ticket subject relates.
client_departmentStringNoProvider department to which the ticket will be forwarded.
itemStringNoService to which the ticket relates.
client_priorityString (enumeration)No

Support ticket priority. Possible values:

  • 0 — low;
  • 1 — medium;
  • 2 — high.
priorityString (enumeration)No

Support ticket priority. Possible values:

  • 0 — low;
  • 1 — medium;
  • 2 — high.
messageStringNoText of the message being added. Supports Markdown markup.
show_optionalFlagNoShow additional ticket settings.
note_messageStringNoInternal comment.
ticket_expenseStringNoAmount of funds to be debited from the client account.
high_priorityFlagNoPlace the ticket at the top of the queue.
low_priorityFlagNoReset the elevated priority flag.
incident_countPositive integerNoIncident counter.
show_abuseFlagNoShow violation registration parameters.
scorePositive integerNoNumber of points for the violation.
actionStringNoFunction to be applied.
deadline_dateDate and timeNoSupport ticket deadline date.
deadline_timeDate and timeNoSupport ticket deadline time.
score_noteStringNoComment to the violation.
sokStringNoThe value ok confirms the operation.

Move to archive

Function: clientticket.archive

Result: successful operation or error message

UI Equivalent: go to SupportSupport tickets → click To archive. Available under a client account.

Moves the ticket to archive. Available for closed tickets. Supports archiving multiple tickets.

Access level: user

ParameterTypeRequiredValue
elidString (list)YesUnique identifier from the clientticket function.
sokStringYesThe value ok confirms the operation.