Обратите внимание!

Страница содержит автоматически сгенерированное описание API-функций. Актуальные имена функций и параметров зависят от конкретной конфигурации панели управления.

Чтобы получить точное имя функции и её параметры, выполните нужное действие через интерфейс и просмотрите записи в лог-файле панели управления.

Порядок работы с API-функциями см. в статье Взаимодействие через API.

Реферальная программа


Функция: affiliate.client

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

  • affiliate — Реферальная программа. Выберите реферальную программу, в которой собираетесь участвовать
  • url — Реферальная ссылка. Так выглядит ваша реферальная ссылка
  • promocode — Промокод. Клиенты, которые введут этот промокод, будут считаться приведенными вами

Перечисления


Функция: enumeration

Результат: список элементов

Перечисления

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • intname — Внутреннее наименование

Удалить

Функция: enumeration.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции enumeration.

Результат: успешное выполнение операции или сообщение об ошибке

Перечисление

Функция: enumeration.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции enumeration)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции enumeration)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • intname — Внутреннее наименование. Внутреннее (служебное) наименование

Наименование

Функция: enumerationitem

Результат: список элементов

Элементы перечисления

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • intname — Внутреннее наименование

Удалить

Функция: enumerationitem.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции enumerationitem.

Результат: успешное выполнение операции или сообщение об ошибке

Элемент перечисления

Функция: enumerationitem.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции enumeration).
    • elid — уникальный идентификатор (элемент id из функции enumerationitem)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции enumeration).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции enumeration).
    • elid — уникальный идентификатор (элемент id из функции enumerationitem)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • intname — Внутреннее наименование. Внутреннее (служебное) наименование

Сотрудники


Функция: employee

Результат: список элементов

Сотрудники

Уровень доступа: root admin

  • id — Id
  • name — Логин
  • realname — ФИО
  • email — Email
  • department — Отделы
  • status — Параметры

Отключить сотруднику доступ к биллингу

Функция: employee.suspend

Отключить сотруднику доступ к биллингу

Уровень доступа: root admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции employee.

Результат: успешное выполнение операции или сообщение об ошибке

Отдел

Функция: employee.department

Результат: список элементов

Отделы, в которые входит сотрудник

Уровень доступа: root admin

  • id — Id
  • name — Отдел
  • status — Состояние

Исключить сотрудника из отдела

Функция: employee.department.suspend

Исключить сотрудника из отдела

Уровень доступа: root admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции employee.department.

Результат: успешное выполнение операции или сообщение об ошибке

Включить сотрудника в отдел

Функция: employee.department.resume

Включить сотрудника в отдел

Уровень доступа: root admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции employee.department.

Результат: успешное выполнение операции или сообщение об ошибке

Войти с правами сотрудника

Функция: employee.su

Войти с правами сотрудника

Уровень доступа: root admin

Удалить

Функция: employee.delete

Удалить

Уровень доступа: root admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции employee.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: rights2.user

Результат: список элементов

Права пользователя

Уровень доступа: root admin

  • caption — Наименование
  • access — Доступ

Включить

Функция: rights2.user.resume

Включить

Уровень доступа: root admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции rights2.user.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: rights2.user.suspend

Выключить

Уровень доступа: root admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции rights2.user.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

rights2.user.filter

Частично ограничить доступ к элементам списка. Устанавливать фильтр для списка. Отфильтрованные (исключенные) записи будут недоступны

Функция: rights2.user.hardfilter

Частично ограничить доступ к элементам списка. Устанавливать фильтр для списка. Отфильтрованные (исключенные) записи будут недоступны

Уровень доступа: root admin

Настройки центра поддержки сотрудника

Функция: employee.support_tool_settings

Настройки центра поддержки сотрудника

Уровень доступа: admin

Установка фильтра.

employee.filter

Включить сотруднику доступ к биллингу

Функция: employee.resume

Включить сотруднику доступ к биллингу

Уровень доступа: root admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции employee.

Результат: успешное выполнение операции или сообщение об ошибке

Отправка СМС сообщения

Функция: employee.sms

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции employee)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции employee)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Выбор номера телефона. Тип номера телефона, на который будет отправлено сообщение
  • phone — Номер. Номер телефона, на который будет отправлено сообщение
  • message — Сообщение. Отправляемое сообщение

Редактирование информации о сотруднике

Функция: employee.edit

Уровень доступа: admin root

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции employee)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции employee)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Логин. Логин для входа
  • realname — ФИО. Фамилия, Имя, Отчество
  • position — Должность. Должность сотрудника. Отображается в запросах в интерфейсе BILLmanager 6. Например, Консультант службы технической поддержки
  • passwd — Пароль. Пароль доступа
  • confirm — Подтверждение. Подтверждение пароля
  • department — Отделы. Выберите отделы, в которые необходимо включить данного сотрудника
  • email — Email. Укажите Email адрес сотрудника
  • phone — Номер телефона. Номер телефона сотрудника. Может быть использован для отправки СМС уведомлений
  • default_access_allow — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить сотруднику полный доступ, никак не ограничивая его в правах.

Регламент


Функция: ticket_schedule

Результат: список элементов

Регламент

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • project — Провайдер
  • schedule — Регламент
  • attitude — Характеристика клиента
  • priority — Приоритет
  • user_department — Отдел
  • account_group — Группа клиентов

Удалить

Функция: ticket_schedule.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket_schedule.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

ticket_schedule.filter

Настройки регламента

Функция: ticket_schedule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции ticket_schedule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции ticket_schedule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Условие. Условие применения регламента. Недоступно для изменения после создания регламента
  • comparison — Сравнение. Условие сравнения
  • value — Значение. Значение параметра
  • amount — Сумма. Сумма
  • project — Провайдер. Провайдер, к которому относится регламент. Недоступно для изменения после создания регламента
  • pricelist — Тарифный план. Тарифный план услуги
  • pricelist_addon — Дополнение. Дополнение тарифного плана
  • enumerationitem — Значение дополнения. Заказанное значение перечисления
  • account_client — Клиент. Клиент, для которого применяется регламент
  • account_group — Группа клиентов. Группа клиентов, для которой настраивается регламент
  • attitude — Характеристика клиента. Характеристика клиента, создавшего запрос
  • priority — Приоритет запроса. Приоритет запроса
  • user_department — Отдел. Отдел, на который назначен запрос
  • time_schedule — Регламент ответа. Время, за которое должен быть получен ответ
  • highpriority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди

Заблокированные email


Функция: gateway_blacklist

Результат: список элементов

Заблокированные email адреса

Уровень доступа: admin

  • id — Id
  • name — Email адрес

Удалить

Функция: gateway_blacklist.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway_blacklist.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

gateway_blacklist.filter

Конструктор сайтов


Функция: sitebuilder

Результат: список элементов

Конструктор сайтов

Уровень доступа: admin user

  • domain — Доменное имя
  • ip — IP-адрес
  • username — Имя пользователя
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Принудительная перезагрузка сервера в панели управления

Функция: service.hardreboot

Принудительная перезагрузка сервера в панели управления

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: sitebuilder.su

Войти в панель с правами пользователя

Уровень доступа: admin

Включить

Функция: sitebuilder.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

Результат: успешное выполнение операции или сообщение об ошибке

Статистика по использованию ресурсов

Функция: service.stat

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Задать вопрос по услуге

Функция: service.ask

Задать вопрос по услуге

Уровень доступа: user

Услуга перейдет в остановленное состояние, тарификация будет производиться по правилам для приостановленных услуг. Позже можно самостоятельно запустить.

Функция: service.stop

Услуга перейдет в остановленное состояние, тарификация будет производиться по правилам для приостановленных услуг. Позже можно самостоятельно запустить.

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

Результат: успешное выполнение операции или сообщение об ошибке

Доменное имя услуги

Функция: sitebuilder.domain

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • freedomain_name — Бесплатное доменное имя.
  • additional_domain — Дополнительное доменное имя.
  • owndomain — Доменное имя.
  • ordereddomain — Доменное имя.

Перезагрузка сервера в панели управления

Функция: service.reboot

Перезагрузка сервера в панели управления

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: service.detail

Результат: список элементов

Конфигурация услуги

Уровень доступа: admin+

  • id — Id
  • name — Наименование
  • addonlimit — Включено в тариф
  • value — Заказано дополнительно
  • props — Стоимость

Удалить выделенные записи

Функция: service.detail.delete

Удалить выделенные записи

Уровень доступа: admin+

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент idkey из функции service.detail.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование ресурса

Функция: service.detail.edit

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент idkey из функции service.detail)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент idkey из функции service.detail)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Укажите наименование для ресурса, которое будет отображаться в интерфейсе и документах
  • pricelist_measure — Единица измерения. Единица измерения дополнения
  • manualvalue — Количество. Количество предоставляемого ресурса
  • intvalue — Дополнительно. Дополнительно заказано. Значения от до
  • boolvalue — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Значение ресурса
  • enumerationitem — Значение. Выберите значение ресурса
  • no_check_addon — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Значение дополнения к услуге будет изменено без выполнения проверки модулем обработки
  • addonlimit — Включено в тариф. Включено в тариф
  • addonbool — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Значение ресурса, предоставляемое тарифным планом
  • addonenumerationitem — Включено в тариф.
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Перезагрузить сервер после применения параметров

Заказать новую услугу

Функция: sitebuilder.order

Заказать новую услугу

Уровень доступа: user

IP-адрес

Функция: service.ip

Результат: список элементов

IP-адреса

Уровень доступа: admin user

  • id — Id
  • name — IP-адрес
  • mask — Маска
  • gateway — Шлюз
  • domain — Домен
  • type — Тип
  • ip_status — Статус
  • ip_clientstatus — Статус

Перенос IP-адреса

Функция: service.ip.move

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент id из функции service.ip)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент id из функции service.ip)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • item — Услуга. Id услуги, к которой переносится IP-адрес
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) IP адрес будет добавлен без списания средств со счета клиента
  • postpaid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если опция установлена, то при нехватке средств на счете расход будет создан в долг

IP-адрес

Функция: service.ip.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент id из функции service.ip)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент id из функции service.ip)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип IP-адреса. Тип добавляемого IP-адреса
  • pools — Пул IP. Укажите пул, в котором находится данный IP-адрес
  • domain — Домен. Обратная PTR запись для IP адреса
  • ippool — Пул IP. Укажите пул, в котором находится данный IP-адрес
  • name — IP-адрес. IP-адрес
  • mask — Маска подсети. Маска подсети, используется другими продуктами для настройки сети
  • gateway — Адрес шлюза. Адрес шлюза, используется другими продуктами для настройки сети
  • addinpanel — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Снимите галочку, если не нужно добавлять адрес в панель управления
  • addinipmgr — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Снимите галочку, если не нужно резервировать IP-адрес в IPmanager'е
  • count — Количество. Количество создаваемых адресов. Значения от 1 до 1000
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) IP адрес будет добавлен без списания средств со счета клиента
  • postpaid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если опция установлена, то при нехватке средств на счете расход будет создан в долг
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Перезагрузить сервер после применения параметров

Удаление IP-адреса

Функция: service.ip.del.admin

Уровень доступа: admin+

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент id из функции service.ip)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции sitebuilder).
    • elid — уникальный идентификатор (элемент id из функции service.ip)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) IP-адрес будет удален без возврата средств на счет клиента
  • manual — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Адрес будет удален только из биллинга. Наличие адреса в панели управления и IPmanager не проверяется
  • ipcount — Количество адресов. Общее количество удаляемых IP-адресов
  • cost — Сумма возврата. Сумма, которая будет зачислена на счет клиента после удаления IP-адресов

Удалить

Функция: service.ip.delete

Удалить

Уровень доступа: user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции service.ip.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: service.ip.history

Результат: список элементов

История IP-адреса

Уровень доступа: admin user

  • changedate — Дата изменения
  • desc — Описание
  • user — Имя пользователя
  • ip — IP-адрес
  • action — Функция

Редактирование услуги

Функция: sitebuilder.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Выключить

Функция: sitebuilder.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: sitebuilder.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Написать запрос клиенту

Функция: ticket.write.service

Написать запрос клиенту

Уровень доступа: admin

Смена пароля

Функция: service.changepassword

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • passwd — . Новый пароль для услуги
  • confirm — Подтверждение.

Инструкция об использовании услуги

Функция: service.instruction.html

Инструкция об использовании услуги

Уровень доступа: admin user

Продление услуги

Функция: service.prolong

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • period — Период. Выберите период, на который необходимо продлить услугу

Удалить выделенные услуги

Функция: sitebuilder.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

Результат: успешное выполнение операции или сообщение об ошибке

Услуга перейдет в запущенное состояние, тарификация будет производиться по правилам для запущенных услуг.

Функция: service.start

Услуга перейдет в запущенное состояние, тарификация будет производиться по правилам для запущенных услуг.

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции sitebuilder.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: sitebuilder.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции sitebuilder)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Установка фильтра.

sitebuilder.filter

Сменить тариф

Функция: service.changepricelist

Сменить тариф

Уровень доступа: admin

Параметры:

  • elid — id лицензии
  • pricelist — id тарифа
  • su — логин администратора

Наименование

Функция: service.history

Результат: список элементов

История изменения услуги

Уровень доступа: admin user

  • changedate — Дата изменения
  • desc — Изменение
  • user — Имя пользователя
  • ip — IP-адрес
  • action — Функция

Отчеты


Функция: reportlist

Результат: список элементов

Отчеты

Уровень доступа: admin

  • report — Наименование отчета

Генерация отчета

Функция: report.open

Генерация отчета

Уровень доступа: admin

Виртуальные серверы


Функция: vds

Результат: список элементов

Виртуальные выделенные серверы

Уровень доступа: admin user

  • domain — Доменное имя
  • ip — IP-адрес
  • ostempl — Шаблон ОС
  • processingnode — Узел кластера
  • serverid — Наименование
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Удалить выделенные услуги

Функция: vds.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vds.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: vds.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установка фильтра.

vds.filter

Выключить

Функция: vds.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vds.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vds.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vds.

Результат: успешное выполнение операции или сообщение об ошибке

Создание запроса на перенос Виртуального сервера в ВДЦ

Функция: vds.movetovdc

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vds)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vds)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • vdc — Виртуальный дата-центр. Выберите в какой виртуальный дата-центр будут перенесены виртуальные серверы

Заказать новую услугу

Функция: vds.order

Заказать новую услугу

Уровень доступа: user

Установить фильтр по клиенту

Функция: vds.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Редактирование услуги

Функция: vds.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vds)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vds)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • change_disc_size — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выставляя опцию Вы подтверждаете, что все необходимые операции (выключение виртуального сервера, изменение размера диска, включение виртуального сервера) были произведены
  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Открытие услуги

Функция: vds.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vds)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vds)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Планировщик


Функция: scheduler

Результат: список элементов

Планировщик

Уровень доступа: root

  • command — Команда
  • interval — Период
  • schedule_type — Расписание
  • state — Статус
  • description — Описание

Восстановление

Функция: scheduler.prop

Уровень доступа: root

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент key из функции scheduler)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент key из функции scheduler)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • mailto — Адрес e-mail. Адрес электронной почты для отправки отчетов о выполнении заданий
  • path — Путь. Пути поиска исполняемых файлов. Пути разделяются двоеточием

Выполнить задание сейчас

Функция: run

Выполнить задание сейчас

Уровень доступа: root

Удалить

Функция: scheduler.delete

Удалить

Уровень доступа: root

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции scheduler.

Результат: успешное выполнение операции или сообщение об ошибке

Задание

Функция: scheduler.edit

Уровень доступа: root

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент key из функции scheduler)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент key из функции scheduler)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • mailto — Адрес e-mail. Адрес e-mail можно указать в настройках планировщика
  • command — Команда. Команда, выполняемая по расписанию
  • description — Описание. Произвольное описание задания
  • active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Задание будет выполняться в заданное время, если оно включено
  • schedule_type — Расписание. Расписание можно настроить как в базовом режиме, выбрав из предложенных вариантов, так и в экспертном режиме, введя соответствующие значения
  • run_every — Выполнять. Период выполнения задания
  • time_hour — Выполнить в. Часы и минуты начала выполнения задания
  • time_min — . Часы и минуты начала выполнения задания
  • wday1 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждый понедельник
  • wday2 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждый вторник
  • wday3 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждую среду
  • wday4 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждый четверг
  • wday5 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждую пятницу
  • wday6 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждую субботу
  • wday0 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы заупскать задание каждое воскресенье
  • month — Месяц. Месяц выполнения задания
  • month_day — День месяца. Число месяца, в которое будет выполняться задание
  • input_min — Минуты. Формат: * — все минуты; */n — каждые n минут; n — с началом минуты n; a,b,c-e — с началом минут a,b,c,d,e
  • input_hour — Часы. Формат: * — все часы; */n — каждые n часов; n — с началом часа n; a,b,c-e — с началом часа a,b,c,d,e
  • input_dmonth — Дни месяцев. Формат: * — все дни месяца; */n — каждые n-й день месяца; n — с началом n-го дня месяца; a,b,c-e — с началом дня номер a,b,c,d,e
  • input_month — Месяцы. Формат: * — все месяцы; */n — каждые n-й месяц; n — с началом n-го месяца; a,b,c-e — с началом месяца номер a,b,c,d,e
  • input_dweek — Дни недели. Формат: * — все дни недели; */n — каждые n-й день недели; n — с началом n-го дня недели; a,b,c-e — с началом дня недели номер a,b,c,d,e (0 — воскресенье)
  • hideout — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Скрыть результат выполнения команды, отчет не будет отправляться на e-mail, указанный в параметрах планировщика

Выключить

Функция: scheduler.suspend

Выключить

Уровень доступа: root

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции scheduler.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: scheduler.resume

Включить

Уровень доступа: root

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции scheduler.

Результат: успешное выполнение операции или сообщение об ошибке

Запросы


Функция: clientticket

Результат: список элементов

Список запросов

Уровень доступа: user

  • id — Id
  • name — Тема
  • last_message — Последнее сообщение
  • wait_time — Задержка
  • create_user — Автор
  • tstatus — Статус

Установка фильтра.

clientticket.filter

Купить обращения в техническую поддержку для администрирования ваших услуг

Функция: incident

Купить обращения в техническую поддержку для администрирования ваших услуг

Уровень доступа: user

Запрос

Функция: clientticket.edit

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции clientticket)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции clientticket)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item — Услуга. Услуга, к которой относится запрос
  • ticket_project_select — Провайдер. Провайдер, к которому относится тема запроса
  • client_department — Отдел. Отдел провайдера, в который будет передан запрос
  • item — Услуга. Услуга, к которой относится запрос
  • client_priority — Приоритет. Приоритет запроса
  • priority — Приоритет. Приоритет запроса
  • message — Текст сообщения. Текст добавляемого сообщения
  • show_optional — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message — .
  • ticket_expense — Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count — .
  • show_abuse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score — Количество баллов. Количество баллов за нарушение
  • action — Функция.
  • deadline_date — .
  • deadline_time — .
  • score_note — Комментарий. Комментарий к нарушению

Переместить запрос в архив

Функция: clientticket.archive

Переместить запрос в архив

Уровень доступа: user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции clientticket.

Результат: успешное выполнение операции или сообщение об ошибке

Запросы


Функция: ticket

Результат: список элементов

Запросы

Уровень доступа: admin

  • id — Id
  • ticket — Запрос
  • name — Тема
  • client — Клиент
  • delay — Задержка
  • date_start — Дата создания
  • deadline — Осталось
  • responsible — Ответственный
  • project — Провайдер
  • queue — Очередь
  • location — Размещение
  • props — Свойства

Разблокировать запрос

Функция: ticket.unblock

Разблокировать запрос

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: ticket.message

Результат: список элементов

Список сообщений запроса

Уровень доступа: admin

  • id — Id
  • message — Сообщение
  • date_post — Дата написания
  • message_user — Автор

Редактирование сообщения

Функция: ticket.message.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции ticket).
    • elid — уникальный идентификатор (элемент id из функции ticket.message)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции ticket).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции ticket).
    • elid — уникальный идентификатор (элемент id из функции ticket.message)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • message — Сообщение. Текст сообщение

Разделить запрос на два начиная с выбранного сообщения

Функция: ticket.split

Разделить запрос на два начиная с выбранного сообщения

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket.message.

Результат: успешное выполнение операции или сообщение об ошибке

Скрыть сообщение от клиента

Функция: ticket.message.delete

Скрыть сообщение от клиента

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket.message.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

ticket.filter

Добавить запрос в избранные и отслеживать историю по нему

Функция: ticket.favorite

Добавить запрос в избранные и отслеживать историю по нему

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: ticket.su

Войти в панель с правами пользователя

Уровень доступа: admin

Запрос

Функция: ticket.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции ticket)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции ticket)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item — Услуга. Услуга, к которой относится запрос
  • ticket_project_select — Провайдер. Провайдер, к которому относится тема запроса
  • client_department — Отдел. Отдел провайдера, в который будет передан запрос
  • item — Услуга. Услуга, к которой относится запрос
  • client_priority — Приоритет. Приоритет запроса
  • priority — Приоритет. Приоритет запроса
  • message — .
  • show_optional — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message — .
  • ticket_expense — Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count — Обращения в поддержку. Количество "обращений в поддержку" списанных за запрос. При увеличении указанного количества будут списаны дополнительные "обращения", при уменьшении разница будет возвращена клиенту
  • show_abuse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score — Количество баллов. Количество баллов за нарушение
  • action — Функция.
  • deadline_date — .
  • deadline_time — .
  • score_note — Комментарий. Комментарий к нарушению

Закрыть запрос (удалить из очереди)

Функция: ticket.delete

Закрыть запрос (удалить из очереди)

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: ticket.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Шаблоны ответов


Функция: anstempl

Результат: список элементов

Шаблоны ответов

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • project — Провайдер
  • template_type — Тип шаблона
  • department — Отдел
  • orderpriority — Порядок сортировки
  • props — Свойства

Переместить на одну позицию вверх

Функция: anstempl.up

Переместить на одну позицию вверх

Уровень доступа: admin

Установка фильтра.

anstempl.filter

Удалить

Функция: anstempl.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции anstempl.

Результат: успешное выполнение операции или сообщение об ошибке

Шаблон ответа

Функция: anstempl.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции anstempl)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции anstempl)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • message — Текст сообщения. Текст сообщения шаблона. Можно использовать макросы:
    %PROJECT% — наименование провайдера
    %SUPPORTUSER% — ФИО сотрудника, отвечающего в запросе
    %USER% — ФИО пользователя клиента
    %SERVICE% — наименование выбранной услуги
  • orderpriority — Порядок сортировки. Порядок сортировки шаблонов в форме вставки
  • project — Провайдер. Провайдер, для которого будет использоваться шаблон
  • shared_for_all — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает доступ к шаблону всем сотрудникам, либо сотрудникам выбранного отдела
  • user_department — Отдел. Отдел, которому будет доступен шаблон

Переместить на одну позицию вниз

Функция: anstempl.down

Переместить на одну позицию вниз

Уровень доступа: admin

Контроль качества


Функция: selecttickets

Результат: список элементов

Контроль качества

Уровень доступа: admin

  • id — Id
  • name — Наименование

Наименование

Функция: selecttickets.rate.category

Результат: список элементов

Категории оценок

Уровень доступа: admin

  • id — Id
  • name — Наименование

Редактирование категории оценок

Функция: selecttickets.rate.category.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции selecttickets).
    • elid — уникальный идентификатор (элемент id из функции selecttickets.rate.category)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции selecttickets).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции selecttickets).
    • elid — уникальный идентификатор (элемент id из функции selecttickets.rate.category)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование

Удалить

Функция: selecttickets.rate.category.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции selecttickets.rate.category.

Результат: успешное выполнение операции или сообщение об ошибке

Показать записи, попавшие в выборку

Функция: selecttickets.selection

Показать записи, попавшие в выборку

Уровень доступа: admin

Выборка запросов

Функция: selecttickets.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции selecttickets)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции selecttickets)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • type — Тип выборки. В выборку будут попадать чаты или запросы
  • email_list — Список email. Список email-адресов, которые будут доступны для выбора при отправке оцененного запроса

Наименование

Функция: selecttickets.rule

Результат: список элементов

Условия на выборку запросов

Уровень доступа: admin

  • id — Id
  • rule — Условие
  • rulegroup — Группа условий

Удалить

Функция: selecttickets.rule.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции selecttickets.rule.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование условия

Функция: selecttickets.rule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции selecttickets).
    • elid — уникальный идентификатор (элемент id из функции selecttickets.rule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции selecttickets).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции selecttickets).
    • elid — уникальный идентификатор (элемент id из функции selecttickets.rule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип.
  • group — Группа условий. Условия в группе будут объединены оператором ИЛИ. Группы между собой связаны по оператору И. Пример: есть условия A, B и С объединенные в одну группу и есть условия D и E объединенные в другую группу. Итоговое выражение тогда будет — (A ИЛИ B ИЛИ С) И (D ИЛИ E)
  • groupname — Имя группы. Введите имя группы условий

Запустить отбор запросов по правилам

Функция: selecttickets.runselection

Запустить отбор запросов по правилам

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции selecttickets.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: selecttickets.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции selecttickets.

Результат: успешное выполнение операции или сообщение об ошибке

Поддержка по обращениям


Функция: paidsupport

Результат: список элементов

Поддержка по обращениям

Уровень доступа: admin

  • ticket_usage — Использование
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Заказать новую услугу

Функция: paidsupport.order

Заказать новую услугу

Уровень доступа: user

Удалить выделенные услуги

Функция: paidsupport.delete

Удалить выделенные услуги

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paidsupport.

Результат: успешное выполнение операции или сообщение об ошибке

Покупка дополнительной поддержки

Функция: paidsupport.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paidsupport)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paidsupport)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Установка фильтра.

paidsupport.filter

Открытие услуги

Функция: paidsupport.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paidsupport)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paidsupport)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Включить

Функция: paidsupport.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paidsupport.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: paidsupport.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paidsupport.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: paidsupport.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Войти в панель с правами пользователя

Функция: paidsupport.su

Войти в панель с правами пользователя

Уровень доступа: admin

Глобальные настройки


Функция: settings

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

  • DeleteManualSuspend — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Политика включает удаление по расписанию услуг, остановленных администратором. По умолчанию удаляются только услуги, остановленные в результате истечения срока действия или при нехватке средств на продление. Срок удаления задается в настройках тарифного плана либо в настройках типа продукта
  • AllowDeleteNotification — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Политика разрешает клиентам удаление уведомлений из соответствующего раздела
  • NoProjectSelect — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция отключает возможность клиенту переключить провайдера после авторизации
  • HideClosedItem — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Во всех списках где отображаются услуги, услуги со статусом "Удалена" не будут отображаться
  • DeleteInactiveAccount — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает автоматическое удаление клиентов, без зачисленных платежей, расходов и активных услуг, последняя активность которых была более чем указанное количество дней. При проверке активности анализируются: созданные платежи, заказанные услуги, запросы в техподдержку и привлеченные по реферальной программе клиенты
  • DeleteInactiveAccountPeriod — При отсутствии активности более. Срок, в течении которого клиент не проявлял активности
  • DeleteInactiveAccountNotify — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает отправку клиенту уведомления об удалении учетной записи
  • NearDeleteInactiveAccountNotify — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает отправку предварительных уведомлений о скором удалении учетной записи
  • NearDeleteInactiveAccountPeriod — Срок отправки предварительного уведомления. Количество дней до даты удаления через пробел
  • ignore_accounts — Исключить клиентов из отчетов. Список Id клиентов, которые не будут учитываться в отчетах. Числа через запятую. Некоторые отчеты используют статистику, которая собирается ежедневно, в таких отчетах новодобавленный клиент будет исключен со следующего дня.
  • HideDiscount — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция отключает отображение размера скидки на шаге заказа услуг
  • PostPaidPaymentExpenseDate — Счет по неоплаченным расходам. Способ включения в ежемесячный счет неоплаченных расходов
  • ProRataCreateDate — Дата оказания услуги при календарном списании. Выбор выставления даты оказания услуги при календарном списании
  • PaymentWizardOrder — Порядок совершения оплаты. Порядок шагов при выписке счета
  • AllowAnyCountryForProfile — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить клиенту создавать плательщиков из стран, отличных от указанной при регистрации страны. Не рекомендуется использовать, если используются ставки налогов. Подробно о логике работы приложения при включении данной опции читайте статью справки
  • ProhibitDifferentProfileTypes — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить клиентам создавать плательщиков с разным статусом. Клиент не сможет одновременно быть и юридическим, и физическим лицом
  • AutoPayment — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить автоматическое выставление счетов при низком балансе
  • CountProfileType_1 — Количество физических лиц. Ограничить количество плательщиков с типом "Физическое лицо" для одного клиента. Пустое значение — без ограничений.
  • CountProfileType_2 — Количество юридических лиц. Ограничить количество плательщиков с типом "Юридическое лицо" для одного клиента. Пустое значение — без ограничений.
  • CountProfileType_3 — Количество индивидуальных предпринимателей. Ограничить количество плательщиков с типом "Индивидуальный предприниматель" для одного клиента. Пустое значение — без ограничений.
  • ProfileValidationPolicy — Политика изменения данных. Политика поведения системы для верифицированных плательщиков
  • DefaultInvoiceType — Тип генерации актов. Тип генерации актов, выставляемый плательщикам по умолчанию
  • InvoiceCurrencyDate — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При создании акта по неоплаченным расходам, в случае если валюта выставления акта отличается от валюты лицевого счета, по умолчанию курс валюты берется на текущую дату. При наличии данной опции, курс будет браться на дату указанную как дата создания акта выполненных работ
  • ProfileCreateNotification — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции на email плательщика будет отправлено информационное уведомление. Только для физических лиц и индивидуальных предпринимателей
  • StatNotificationType — Отправлять уведомление. Политика оптравки уведомлений при списании за потребление ресурсов сверх включенных в тарифный план
  • StatExpensePolicy — При недостаточном количестве средств для списания. Действие системы при недостаточном балансе для проведения списания за перерасход ресурса
  • StatNotificationLimit — Порог отправки уведомлений о приближении к лимиту. % от максимально допустимого значения потребления ресурса, по достижению которого будет отправляться соответствующее уведомление
  • SupportToCc — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает отправку уведомлений на email адреса указанные в копии, для письма полученного от клиента
  • SupportUsePriority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность клиенту указать приоритет запроса при создании, а также сотруднику управлять приоритетом
  • SupportFileSize — Максимальный размер файлов. Укажите максимально допустимый размер файлов, прикрепляемых клиентами к сообщениям в запросах
  • SupportMessageSize — Максимальный размер сообщения. Укажите максимально допустимый размер одного сообщения в запросе
  • SupportHightPrioritySchedule — Повышать приоритет запросов с оставшимся временем на ответ меньше. Опция позволяет регулировать приоритет запросов, время на ответ на которые осталось менее указанного значения
  • AbuseRateStat — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает суммирование баллов за нарушения и возможность применения штрафных санкций при достижении заданного порога баллов
  • AbuseBlockItemRate — Заблокировать услуги при достижении. Будут заблокированы имеющиеся услуги клиента, а так же запрещен заказ новых услуг
  • ArchiveTicket — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает автоматическое перемещение запросов в архив при отсутствии по ним активности
  • ArchiveTicketDays — При отсутствии активности в течении. Срок в днях. Если в течение этого периода не будет активности по запросу, он будет автоматически перемещен в архив
  • ValidateOrder — Порядок проверки. Порядок, в котором будет запрашиваться проверка данных, при совпадении момента проверки
  • FraudValidateType — Подтверждение номера телефона. Момент указания и подтверждения номера телефона, который будет отображен как проверенный и может быть использован для подтверждения при удалении услуг
  • fraud_phone_trycount — Количество попыток получения кода. Количество попыток получения кода подтверждения номера телефона при прохождении процедуры верификации
  • fraud_code_trycount — Количество попыток ввода кода. Количество попыток ввода кода, при достижении указанного лимита, требуется получение нового кода
  • EmailValidateType — Подтверждение по email. Момент подтверждения email адреса, указанного при регистрации
  • WaitTimeSend — Период отправки письма. Время в секундах до возможности повторной отправки письма для подтверждения email, по умолчанию 300 секунд
  • ManualValidateType — Ручное подтверждение. Ручное подтверждения учетной записи
  • ManualValidateDepartment — Отдел. Отдел, в который будут направлены задачи на ручное подтверждение учетной записи клиента
  • AllowRecoveryBySms — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает отправку кода подтверждения восстановления пароля на проверенный номер телефона. Если проверенного номера нет, клиент получит на свой email письмо с ссылкой для смены пароля
  • PhoneRestoreMaxSendTime — Количество отправок кода. Максимальное количество попыток получения кода сброса пароля по телефону
  • PhoneRestoreSendTimeOut — Таймаут на получение кода. Минимальное время в секундах, между попытками получения кода сброса пароля по телефону
  • AllowRecoveryByEmail — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает клиенту выбор способа получения кода для сброса пароля по СМС или на email
  • ProfilePhoneValidateType — Подтверждение номера телефона. Момент подтверждения номера телефона плательщика
  • ProfilePhoneTryCount — Количество попыток получения кода. Количество попыток получения кода подтверждения номера телефона при прохождении процедуры верификации
  • ProfilePhoneCodeTryCount — Количество попыток ввода кода. Количество попыток ввода кода, при достижении указанного лимита, требуется получение нового кода
  • ProfileEmailValidateType — Подтверждение email. Момент подтверждения email адреса плательщика
  • ProfileEmailWaitTimeSend — Период отправки письма. Время в секундах до возможности повторной отправки письма для подтверждения email, по умолчанию 300 секунд
  • ProfileManualValidateType — Ручное подтверждение. Ручная верификация данных плательщиков
  • ProfileManualValidateDepartment — Отдел. Отдел, в который будут направлены задачи на ручное подтверждение данных плательщика клиента
  • RequireEmailValidation — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Политика запрещает отправку уведомлений на непроверенные e-mail адреса пользователей. После регистрации в системе, пользователю будет предложено пройти процедуру верификации e-mail адреса. Отправить проверочный e-mail можно и непосредственно из настроек пользователя. Так же на непроверенные e-mail адреса не будут доставляться рассылки.
  • ParseMailSystemAutoreplay — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает обработку автоматических ответов почтовых систем о невозможности доставки email уведомления. Включение опции имеет смысл только при настройке шлюза входящих сообщений на адрес, с которого выполняется рассылка сообщений
  • BuymoreMaxCount — Количество предложений. Ограничить количество предложений сопутствующих товаров в корзине клиента
  • RegFormType — Форма регистрации. Тип формы регистрации
  • RegistrationPhone — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает возможность указания номера телефона при регистрации
  • RecaptchaType — Тип reCAPTCHA на форме регистрации. Опция включает использование reCAPTCHA на форме регистрации клиента. Не забудьте учесть эту настройки при наличии интеграции формы регистрации в сайт
  • RecaptchaPublicKey — Ключ. Публичный ключ сервиса reCAPTCHA
  • RecaptchaPrivateKey — Секретный ключ. Секретный ключ сервиса reCAPTCHA
  • RecaptchaAuthType — Тип reCAPTCHA на форме авторизации. Опция включает использование reCAPTCHA на форме авторизации клиента
  • RecaptchaAuthPublicKey — Ключ. Публичный ключ сервиса reCAPTCHA
  • RecaptchaAuthPrivateKey — Секретный ключ. Секретный ключ сервиса reCAPTCHA
  • ShowroomBehavior — Поведение. Действие при открытии страницы billmgr незарегистрированным пользователем
  • ShowroomLinkType — Тип ссылки. Тип ссылки, которая будет отображена на форме авторизации
  • OneDedicatedIp — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) После включения данной политики будет выделен только один адрес, если тариф включает в себя более одного выделенного IP-адреса, но при заказе услуги клиент не заказывал дополнительных IP-адресов. Остальные включенные в тариф IP-адреса клиент может добавить самостоятельно в разделе "IP-адреса".
  • CheckIpInUse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Только для услуг с типом "Выделенный сервер": перед удалением IP-адреса проверять его доступность; если адрес активен, удаление не происходит

IPmanager


Функция: processing.ipmgr

Результат: список элементов

Связь с IPmanager

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Удалить

Функция: processing.ipmgr.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.ipmgr.

Результат: успешное выполнение операции или сообщение об ошибке

Перейти в панель

Функция: processing.ipmgr.gotoserver

Перейти в панель

Уровень доступа: admin

Подключение к IPmanager

Функция: processing.ipmgr.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции processing.ipmgr)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции processing.ipmgr)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование подключения
  • url — URL. URL IPmanager
  • login — Имя пользователя. Имя пользователя
  • password — Пароль. Укажите пароль для доступа к панели управления
  • adminlogin — Логин администратора. Логин администратора в IPmanager'е
  • adminpassword — Пароль администратора. Пароль администратора в IPmanager'е
  • hiddentypes — Не учитывать типы IP-адресов. Укажите через пробел типы IP-адресов которые не нужно проверять на соответствие с базой данных биллинга

Виртуальный ДЦ


Функция: vdc

Результат: список элементов

Виртуальный дата-центр

Уровень доступа: admin user

  • vdcname — Наименование
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Networks

Функция: vdc.network

Результат: список элементов

Сети

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • vm_group -
  • router — Маршрутизатор
  • gateway — Шлюз
  • mask — Маска сети
  • network_subnets — Адреса подсетей
  • network_pools — Пул IP-адресов
  • status — Состояние

Наименование

Функция: vdc.network.subnet

Результат: список элементов

Подсети

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • cidr — Адрес подсети
  • gateway — Адрес шлюза
  • status — Состояние
  • status — Состояние
Удалить

Функция: vdc.network.subnet.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.subnet.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование подсети

Функция: vdc.network.subnet.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.network).
    • elid — уникальный идентификатор (элемент id из функции vdc.network.subnet)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.network).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.network).
    • elid — уникальный идентификатор (элемент id из функции vdc.network.subnet)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • subnet_type — Тип выбора сетевого адреса. Тип выбора сетевого адреса
  • pool — Пул. Выберите сетевой адрес из пула
  • mask — Маска подсети. Маска подсети
  • cidr — Адрес подсети. Адрес подсети
  • use_gateway — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать шлюз для данной подсети. Под шлюз будет занят один из адресов подсети
  • gateway — Адрес шлюза. Адрес шлюза используемый в подсети. Для назначения адреса автоматически, необходимо оставить пустым
  • use_dhcp — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать DHCP для данной подсети. Под DHCP будет занят один из адресов подсети

Удалить

Функция: vdc.network.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование сети

Функция: vdc.network.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.network)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.network)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • vdc_vm_group — Группа виртуальных серверов. Позволяет создать сеть доступную только внутри группы виртуальных серверов
  • create_subnet — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность создать подсеть вместе одновременно с сетью
  • subnet_name — Наименование подсети. Наименование подсети
  • subnet_type — Тип выбора сетевого адреса. Тип выбора сетевого адреса
  • subnet_pool — Пул. Выберите сетевой адрес из пула
  • subnet_mask — Маска подсети. Маска подсети
  • subnet_cidr — Адрес подсети. Адрес подсети в виде 'адрес_сети/маска_сети'. Например 192.168.0.0/24
  • subnet_use_gateway — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать шлюз для данной подсети. Под шлюз будет занят один из адресов подсети
  • subnet_gateway — Адрес шлюза. Адрес шлюза используемый в подсети. Для назначения адреса автоматически, необходимо оставить пустым
  • subnet_use_dhcp — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать DHCP для данной подсети. Под DHCP будет занят один из адресов подсети
  • gateway — Шлюз. Шлюз
  • mask — Маска сети. Маска сети
  • dns1 — Первичный DNS. Первичный DNS сервер, используемый в сети
  • dns2 — Вторичный DNS. Вторичный DNS сервер, используемый в сети
  • dns_suffix — DNS суффикс. DNS суффикс, используемый в сети
  • subnet_vdc_router — .
  • vdc_router — Подключить к марщрутизатору. При создании сеть будет подключена к выбранному маршрутизатору виртуального дата-центра
  • vdc_network — Подключить к сети ВДЦ. Сеть будет подключена к выбранной сети виртуального дата-центра
  • network_pools — .
  • network_dhcp — .

Выключить

Функция: vdc.network.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vdc.network.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.

Результат: успешное выполнение операции или сообщение об ошибке

Virtual machines

Функция: vdc.vm

Результат: список элементов

Список виртуальных серверов

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • vm_group — Группа
  • vmtempl — Шаблон ВС
  • ostempl_name — Шаблон ОС
  • external_ip — Внешние IP
  • internal_ip — Внутренние IP
  • ncpu_m — Процессор, шт.
  • mem_m — Оперативная память, МиБ
  • disc_total_m — Диск, ГиБ
  • status — Состояние
  • status — Состояние

Доступ к консоли сервера

Функция: vdc.vm.webconsole

Доступ к консоли сервера

Уровень доступа: admin user

Редактирование виртуального сервера

Функция: vdc.vm.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Для переменной используйте внутреннее имя значения: раздел Типы продуктов → выберите продукт — кнопка Параметры → выберите параметр → кнопка Значения → столбец Внутреннее имя.

  • name — Наименование. Наименование виртуального сервера
  • vmtempl — Набор параметров. Набор параметров виртуального сервера
  • source — Базовый объект. Выберите базовый объект, на основе которого будет создан виртуальный сервер
  • ostempl — Операционная система. Шаблон операционной системы, из которого будет создан виртуальный сервер
  • vdc_volume — Диск. Можно выбрать только загрузочный диск не используемый ни одним из виртуальных серверов
  • vdc_volume_snapshot — Снимок диска. На основе снимка будет создан новый диск, который будет подключен к виртуальному серверу
  • vdc_vm_snapshot — Снимок виртуального сервера. На основе снимка будет создан новый виртуальный сервер
  • vdc_vm_group — Группа для размещения. Группа для размещения виртуального сервера
  • vm_group_name — Имя группы. Имя группы виртуальных серверов
  • vdc_network — Сеть. Сеть виртуального дата-центра, к которой будет подключен создаваемый виртуальный сервер
  • create_volume — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для виртуального сервера будет создан диск указанного размера
  • disc — Диск. Объем жесткого диска виртуального сервера
  • ncpu — Процессоры. Количество процессоров виртуального сервера
  • mem — Оперативная память. Объем оперативной памяти выделяемой виртуальному серверу
  • password — Пароль. Пароль доступа к виртуальному серверу
  • confirm — Подтверждение.

Имя диска

Функция: vdc.vm.volume

Результат: список элементов

Список дисков, подключенных к виртуальному серверу

Уровень доступа: admin user

  • id — Id
  • name — Имя диска
  • size — Размер диска, ГиБ
Присоединение диска к виртуальному серверу

Функция: vdc.vm.volume.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.volume)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.volume)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • volumelist — Имя диска. Имя диска, присоединяемого к виртуальномуу серверу
Отключить диск от виртуального сервера

Функция: vdc.vm.volume.delete

Отключить диск от виртуального сервера

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.volume.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

vdc.vm.filter

Перезагрузить виртуальный сервер

Функция: vdc.vm.reboot

Перезагрузить виртуальный сервер

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

Результат: успешное выполнение операции или сообщение об ошибке

Остановить виртуальный сервер

Функция: vdc.vm.suspend

Остановить виртуальный сервер

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

Результат: успешное выполнение операции или сообщение об ошибке

Сделать принудительную перезагрузку виртуального сервера

Функция: vdc.vm.hardreboot

Сделать принудительную перезагрузку виртуального сервера

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить виртуальный сервер

Функция: vdc.vm.delete

Удалить виртуальный сервер

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vdc.vm.network

Результат: список элементов

Подключения к сетям виртуального дата-центра

Уровень доступа: admin user

  • id — Id
  • network_name — Имя сети
  • ip_address — IP-адрес
  • network_subnet — Подсеть
  • mac — MAC-адрес
Отключить виртуальный сервер от сети

Функция: vdc.vm.network.delete

Отключить виртуальный сервер от сети

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.network.

Результат: успешное выполнение операции или сообщение об ошибке

Добавление нового подключения

Функция: vdc.vm.network.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.network)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.network)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • network — Сеть. Сеть виртуального дата-центра, к которой необходимо подключить виртуальный сервер

Наименование

Функция: vdc.vm.ip

Результат: список элементов

Внешние IP-адреса, подключенные к виртуальному серверу

Уровень доступа: admin user

  • id — Id
  • ip — IP-адрес
  • status — Состояние
Присоединение IP к виртуальному серверу

Функция: vdc.vm.ip.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.ip)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.ip)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • iplist — IP-адрес. IP-адрес, присоединяемый к виртуальному серверу
  • port — Порт подключения. Порт виртуального сервера, к которому будет подключен внешний IP-адрес
Открепить IP от виртуального сервера

Функция: vdc.vm.ip.delete

Открепить IP от виртуального сервера

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.ip.

Результат: успешное выполнение операции или сообщение об ошибке

Запустить виртуальный сервер

Функция: vdc.vm.resume

Запустить виртуальный сервер

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

Результат: успешное выполнение операции или сообщение об ошибке

Имя диска

Функция: vdc.volume

Результат: список элементов

Дисковые хранилища

Уровень доступа: admin user

  • id — Id
  • name — Имя диска
  • size — Размер диска, ГиБ
  • externalid — ID диска
  • vdc_vm_name — Виртуальный сервер
  • type — Тип диска
  • bootable — Загрузочный диск
  • ss — Снимки
  • status — Состояние

Имя

Функция: vdc.volume.snapshot

Результат: список элементов

Снимки диска

Уровень доступа: admin user

  • id — Id
  • name — Имя
  • externalid — ID снимка
  • vdc_volume — Диск
  • status — Состояние
Удалить

Функция: vdc.volume.snapshot.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.volume.snapshot.

Результат: успешное выполнение операции или сообщение об ошибке

Снимок

Функция: vdc.volume.snapshot.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.volume).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume.snapshot)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.volume).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.volume).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume.snapshot)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Имя. Наименование

Редактирование диска

Функция: vdc.volume.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Имя диска. Имя диска
  • type — Тип. Тип диска
  • source_type — Источник. Источник создания диска
  • ostempl — Образ. Образ, из которого будет создан диск
  • snapshot — Снимок. Снимок из которого будет создан диск
  • size — Размер диска. Размер диска в гигабайтах
  • bootable — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Загрузочный диск

Удалить

Функция: vdc.volume.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.volume.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: vdc.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vdc.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

vdc.filter

Виртуальный дата-центр

Функция: vdc.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vdc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vdc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: vdc.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

Результат: успешное выполнение операции или сообщение об ошибке

Заказ виртуального дата-центра

Функция: vdc.order.pricelist

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vdc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vdc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • datacenter — Выберите дата-центр. Дата-центр, в котором будет открыта услуга

Установить фильтр по клиенту

Функция: vdc.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Наименование

Функция: vdc.loadbalancer

Результат: список элементов

Список балансировщиков

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • externalid — ID балансировщика
  • vm — Виртуальный сервер
  • protocol — Протокол
  • port — Порт
  • method — Метод
  • monitortype — Протокол мониторинга
  • delay — Интервал, сек
  • retries — Количество попыток
  • timeout — Таймаут, сек
  • status — Состояние

Редактировать балансировщик

Функция: vdc.loadbalancer.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • subnet — Подсети. Выберите подсеть
  • protocol — Протокол. Выберите протокол
  • port — Порт. Выберите порт. Значение должно быть от 1 до 65535
  • method — Метод. Метод распределения трафика между участника пула
  • vm — Виртуальный сервер. Виртуальные серверы, входящие в пул
  • monitortype — Протокол мониторинга. Тип протокола мониторинга
  • delay — Интервал, сек. Интервал опроса, в секундах
  • retries — Количество попыток. Количество успешных проверок перед изменением состояния участника пула. Значение от 1 до 10
  • timeout — Таймаут, сек. Максимальное время ожидания подключения, в секундах

Наименование

Функция: vdc.loadbalancer.vm

Результат: список элементов

Виртуальные серверы, подключенные к балансировщику

Уровень доступа: admin user

  • id — Id
  • vm -
  • subnet — Подсеть
Присоединение виртуального сервера к балансировщику

Функция: vdc.loadbalancer.vm.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.vm)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.vm)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • vm — Виртуальный сервер. Виртуальный сервер, присоединяемый к балансировщику
Удалить

Функция: vdc.loadbalancer.vm.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.loadbalancer.vm.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vdc.loadbalancer.ip

Результат: список элементов

IP-адреса, подключенные к балансировщику

Уровень доступа: admin user

  • id — Id
  • ip — IP-адрес
  • status — Состояние
Присоединение IP к балансировщику

Функция: vdc.loadbalancer.ip.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.ip)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.ip)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • iplist — IP адрес. IP-адрес, присоединяемый к балансировщику
Открепить IP от балансировщика

Функция: vdc.loadbalancer.ip.delete

Открепить IP от балансировщика

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.loadbalancer.ip.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить балансировщик

Функция: vdc.loadbalancer.delete

Удалить балансировщик

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.loadbalancer.

Результат: успешное выполнение операции или сообщение об ошибке

Routers

Функция: vdc.router

Результат: список элементов

Список маршутизаторов виртуального дата-центра

Уровень доступа: admin user

  • id — Id
  • externalid — Идентификатор маршрутизатора
  • name — Наименование маршрутизатора
  • routertempl_name — Конфигурация
  • network — Внешняя сеть
  • external_ip — IP-адреса
  • status — Состояние
  • status — Состояние

Выключить

Функция: vdc.router.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vdc.router.lbp

Результат: список элементов

Список пулов

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • description — Описание
  • members — Участников пула, шт.
  • service — Службы
  • port — Порты
  • monitor_port — Порт мониторинга
  • method — Метод
  • interval — Интервал
  • timeout — Таймаут
  • status — Состояние
Удаление пула

Функция: vdc.router.lbp.delete

Удаление пула

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbp.

Результат: успешное выполнение операции или сообщение об ошибке

Параметры пула

Функция: vdc.router.lbp.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbp)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbp)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование пула балансировщика нагрузки. Может содержать только быквы латинского алфавита, цифры, тире, нижнее подчеркивание и должно начинаться с буквы
  • description — Описание. Произвольное описание пула
  • uri — URI проверки доступности. URI для проверки доступности службы HTTP

Наименование тоннеля

Функция: vdc.router.vpn

Результат: список элементов

Управление IPSec VPN тоннелями маршрутизатора

Уровень доступа: admin user

  • id — Id
  • name — Наименование тоннеля
  • connection_type — Тип подключения
  • local_ip_address — Локальный IP-адрес
  • peer_ip_address — Внешний IP-адрес
  • network_local — Локальные сети
  • network_peer — Внешние сети
  • encryption_protocol — Протокол шифрования
  • status — Состояние
  • status — Состояние
Параметры IPSec VPN тоннеля маршрутизатора

Функция: vdc.router.vpn.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.vpn)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.vpn)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • description — Описание.
  • connection_type — Тип подключения. Тип подключения IPSec VPN туннеля
  • vdc_router_peer — Маршрутизатор. Маршрутизатор виртуального дата-центра, для которого настраивается IPSec VPN туннель
  • vdc_network_local — Локальные сети. Локальные сети, подключенные к маршрутизатору
  • vdc_network_peer — Внешние сети. Внешние сети, подключенные к маршрутизатору виртуального дата-центра
  • peer_cidr — Внешние сети. Внешние сети, для которой настраивается IPSec VPN туннель в формате адрес_сети/маска, через пробел. Например 192.168.0.0/24 192.168.1.0/24
  • local_endpoint — Локальная точка подключения. Интерфейс маршрутизатора, который будет использован для создания VPN соединения. Если необходимо использовать публичный IP адрес соединения, необходимо отметить опцию "Публичный IP-адрес"
  • local_endpoint_use_public_ip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • peer_endpoint — Внешняя точка подключения. Интерфейс маршрутизатора, который будет использован для создания VPN соединения. Если необходимо использовать публичный IP адрес соединения, необходимо отметить опцию "Публичный IP-адрес"
  • peer_endpoint_use_public_ip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • local_id — Локальный ID. Локальный ID IPSec VPN туннеля
  • peer_id — Внешний ID. Внешний ID IPSec VPN туннеля
  • peer_ip_address — Внешний IP-адрес. Адрес внешней точки подключения
  • encryption_protocol — Протокол шифрования. Протокол шифрования соединения
  • shared_key — Ключ шифрования. Ключ шифрования. Допустимо использование латинских символов и цифр. Длина ключа должна быть не короче 32 и не длинее 128 символов
  • mtu — MTU. Максимальный размер пакета для передачи по IPSec VPN туннелю
Удалить

Функция: vdc.router.vpn.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.vpn.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: vdc.router.vpn.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.vpn.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vdc.router.vpn.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.vpn.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vdc.router.lbs

Результат: список элементов

Список серверов

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • description — Описание
  • ip — IP-адрес
  • vdc_loadbalancer_pool_name — Пул
  • service_name — Имя службы
  • service_port — Порт службы
  • service_persistence — Метод
  • status — Состояние
  • status — Состояние
Выключить

Функция: vdc.router.lbs.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbs.

Результат: успешное выполнение операции или сообщение об ошибке

Удаление сервера

Функция: vdc.router.lbs.delete

Удаление сервера

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbs.

Результат: успешное выполнение операции или сообщение об ошибке

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

Функция: vdc.router.lbs.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbs)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbs)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование сервера балансировщика нагрузки. Может содержать только быквы латинского алфавита, цифры, тире, нижнее подчеркивание и должно начинаться с буквы
  • description — Описание. Произвольное описание сервера
  • vdc_network — Сеть. Сеть маршрутизатора, для которой будет активен балансировщик нагрузки
  • ip — IP-адрес. IP-адрес сервера балансировщика нагрузки
  • pool — Пул. Пул настроек балансировщика нагрузки
  • use_log — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает журналирование трафика, проходящего через сервер балансировщика нагрузки
Включить

Функция: vdc.router.lbs.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbs.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование правила

Функция: vdc.router.firewall

Результат: список элементов

Управление Firewall маршрутизатора

Уровень доступа: admin user

  • id — Id
  • name — Наименование правила
  • source_desc — Источник
  • destination_desc — Адрес назначения
  • protocol — Протокол
  • policy — Политика
  • status — Состояние
  • status — Состояние
Удалить

Функция: vdc.router.firewall.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.firewall.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: vdc.router.firewall.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.firewall.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование правила Firewall

Функция: vdc.router.firewall.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.firewall)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.firewall)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование правила. Наименование правила
  • protocol — Протокол. Протокол, к которому применяется правило
  • source — Источник. Источник трафика. Допустимым значением может быть IP-адрес, CIDR, диапазон IP-адресов, "any","internal" и "external". Значение можно выбрать из списка или указать самостоятельно
  • source_port — Порт источника. Порт источника. Значение можно выбрать из списка или указать самостоятельно
  • destination — Адрес назначения. Адрес назначения трафика. Допустимым значением может быть IP-адрес, CIDR, диапазон IP-адресов, "any","internal" и "external". Значение можно выбрать из списка или указать самостоятельно
  • destination_port — Порт адреса назначения. Порт адреса назначения. Значение можно выбрать из списка или указать самостоятельно
  • policy — Политика. Политика, применяемая к трафику
  • use_log — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает ведение журнала трафика, попадаемого под правило
Включить

Функция: vdc.router.firewall.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.firewall.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vdc.router.interface

Результат: список элементов

Интерфейсы маршрутизатора

Уровень доступа: admin user

  • id — Id
  • externalid — Идентификатор интерфейса маршрутизатора
  • network — Сеть
  • subnet — Подсеть
  • fixedips — IP-адрес
  • type — Тип интерфейса
  • status — Состояние
Восстановление

Функция: vdc.router.interface.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.interface)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.interface)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • subnet — Подсеть. Подсеть, к которой будет привязан маршрутизатор

Функция: vdc.router.interface.param

Уровень доступа: admin user

Удалить выделенные интерфейсы

Функция: vdc.router.interface.delete

Удалить выделенные интерфейсы

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.interface.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vdc.router.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vdc.router.dhcp

Результат: список элементов

Управление DHCP маршрутизатора

Уровень доступа: admin user

  • id — Id
  • network — Сеть дата-центра
  • ip_range — Диапазон адресов
  • default_lease_time — Время аренды по умолчанию
  • max_lease_time — Максимальное время аренды
  • status — Состояние
Выключить

Функция: vdc.router.dhcp.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.dhcp.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vdc.router.dhcp.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.dhcp.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: vdc.router.dhcp.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.dhcp.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование диапазона адресов

Функция: vdc.router.dhcp.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.dhcp)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.dhcp)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • vdc_network — Сеть дата-центра. Сеть дата-центра, для которой активируется DHCP диапазон
  • ip_range — Диапазон адресов. Диапазон адресов, из которого будут выдаваться IP адреса
  • default_lease_time — Время аренды по умолчанию. Время аренды IP-адреса по умолчанию
  • max_lease_time — Максимальное время аренды. Максимальное время аренды IP-адреса

Редактирование маршрутизатора

Функция: vdc.router.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.router)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.router)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование маршрутизатора. Наименование
  • routertempl — Конфигурация. Конфигурация маршрутизатора
  • external_network — Внешняя сеть. Внешняя сеть, к которой будет подключен создаваемый маршрутизатор
  • use_dhcp — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить DHCP для маршрутизатора
  • use_firewall — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить Firewall для маршрутизатора
  • firewall_policy — Политика по умолчанию. Политика обработки пакетов по умолчанию
  • use_vpn — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить использование VPN для маршрутизатора

Удалить выделенные маршрутизаторы

Функция: vdc.router.delete

Удалить выделенные маршрутизаторы

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: vdc.router.nat

Результат: список элементов

Управление NAT маршрутизатора

Уровень доступа: admin user

  • id — Id
  • network — Сеть дата-центра
  • rule_type — Тип правила
  • original_ip_range — Исходный адрес/диапазон
  • original_port_desc — Исходный порт
  • translated_ip_range — Транслируемый адрес/диапазон
  • translated_port_desc — Транслируемый порт
  • protocol — Протокол
  • status — Состояние
Выключить

Функция: vdc.router.nat.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.nat.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: vdc.router.nat.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.nat.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование правила NAT

Функция: vdc.router.nat.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.nat)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.nat)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • vdc_network — Сеть дата-центра. Сеть дата-центра, для которой применяется правило NAT
  • rule_type — Тип правила. Тип правила трансляции адресов. SNAT — трансляция исходящих из внутренней сети запросов, DNAT — трансляция входящих во внутреннюю сеть запросов
  • description — Описание. Произвольное описание правила
  • protocol — Протокол. Протокол, для которого будет применяться правило NAT
  • original_ip_range — Исходный адрес/диапазон. Для SNAT правила это внутренний IP-адрес или диапазон IP-адресов, для правила DNAT — внешний IP-адрес или диапазон IP-адресов. Значение можно выбрать из списка или указать самостоятельно
  • original_port — Исходный порт. Исходный порт, для которого выполняется трансляция. Значение можно выбрать из списка или указать самостоятельно
  • translated_ip_range — Транслируемый адрес/диапазон. Для SNAT правила это внешний IP-адрес или диапазон IP-адресов, для правила DNAT — внутренний IP-адрес или диапазон IP-адресов. Значение можно выбрать из списка или указать самостоятельно
  • translated_port — Транслируемый порт. Транслируемый порт, по которому идет обращение. Значение можно выбрать из списка или указать самостоятельно
Включить

Функция: vdc.router.nat.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.nat.

Результат: успешное выполнение операции или сообщение об ошибке

Синхронизирация объектов услуги с объектами на стороне ВДЦ

Функция: vdc.sync

Синхронизирация объектов услуги с объектами на стороне ВДЦ

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: vdc.su

Войти в панель с правами пользователя

Уровень доступа: admin

Реферальные программы


Функция: affiliate

Результат: список элементов

Реферальные программы

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • reward — Вознаграждение, %
  • period — Период вознаграждения, месяц
  • locale_url — URL сайта
  • project_name — Провайдер

Удалить

Функция: affiliate.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции affiliate.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование реферальной программы

Функция: affiliate.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции affiliate)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции affiliate)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • project — Провайдер. Выберите провайдера, у которого действует данная реферальная программа
  • name — Наименование. Наименование реферальной программы, которое отображается клиенту
  • promocode — Шаблон промокода. Укажите шаблон промокода, используйте в том месте, куда нужно вставить Id партнера. Если реферал введет промокод соответсвующий этому шаблону, то будет засчитано, что клиента завербовал партнер.
  • reward — Размер вознаграждения. Проценты от расходов реферала, которые будут начислены партнеру в начале следующего месяца.
  • period — Период вознаграждения. Период в месяцах, в течении которого клиенту будут выплачивать проценты от расходов реферала
  • url — URL сайта. Укажите URL сайта провайдера. У каждого партнера будет уникальная ссылка, для этого в конец данного URL будет добавлен Id клиента.
  • account_group — Группа клиентов. Группа клиентов, для которых будет доступно участие в реферальной программе
  • account_group_restrict — Запретить состоящим в группе. Выберите группу, клиентам состоящим в этой группе не будет начисляться вознаграждение по реферальной программе

Наименование

Функция: affiliate.reward

Результат: список элементов

Затраты на реферальную программу

Уровень доступа: admin

  • cdate — Дата
  • amount — Сумма

Клиент

Функция: affiliate.reward.partner

Результат: список элементов

Затраты на реферальную программу

Уровень доступа: admin

  • id — Id
  • name — Клиент
  • amount — Сумма
Войти в панель с правами пользователя

Функция: affiliate.reward.partner.su

Войти в панель с правами пользователя

Уровень доступа: admin

Наименование

Функция: affiliate.itemtype

Результат: список элементов

Особые правила начисления вознаграждения

Уровень доступа: admin

  • id — Id
  • locale_name — Тип продукта
  • pricelist_locale_name — Тариф
  • reward — Вознаграждение, %

Редактирование правила

Функция: affiliate.itemtype.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции affiliate).
    • elid — уникальный идентификатор (элемент id из функции affiliate.itemtype)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции affiliate).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции affiliate).
    • elid — уникальный идентификатор (элемент id из функции affiliate.itemtype)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • reward — Размер вознаграждения. Проценты от расходов реферала за услуги выбранного типа

Удалить

Функция: affiliate.itemtype.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции affiliate.itemtype.

Результат: успешное выполнение операции или сообщение об ошибке

Лицензии ISPsystem


Функция: soft

Результат: список элементов

Лицензии ISPsystem

Уровень доступа: admin user

  • id — Номер
  • licname — Название лицензии
  • ip — IP-адрес
  • period — Период
  • update_expiredate — Получение обновлений до
  • real_ipchange — Дата IP-адреса
  • real_keychange — Дата ключа
  • id — Номер
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • special_status — дополнительный параметр статуса услуги. Используется для отображения в BILLmanager 6. Может принимать значения:

    • 0 — нет ограничений;

    • 1 — идёт операция смены статуса;

    • 2 — остановлена при почасовом биллинге

  • cost — Стоимость

Лицензия

Функция: soft.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции soft)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции soft)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • remoteip — IP-адрес сервера. В поле указывается IP-адрес, с которого будут приходить запросы на получение лицензии. В случае, если это значение совпадает с IP адресом, на который будет выдана лицензия, данное поле можно оставить пустым
  • update_expiredate — Срок получения обновлений. Панель сможет получать обновления до указанной даты
  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Заказать новую услугу

Функция: soft.order

Заказать новую услугу

Уровень доступа: user

Включить

Функция: soft.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции soft.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить выделенные услуги

Функция: soft.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции soft.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: soft.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции soft.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: soft.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Войти в панель с правами пользователя

Функция: soft.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установка фильтра.

soft.filter

Открытие услуги

Функция: soft.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции soft)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции soft)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

CRM контакты


Функция: crm

Результат: список элементов

CRM-контакты

Уровень доступа: admin

  • id — Id
  • cdate — Дата
  • description — Описание
  • employee — Сотрудник
  • account — Клиент
  • type — Тип
  • channel — Канал
  • project — Провайдер
  • info — Комментарий
  • status — Статус

Копирование CRM-контакта

Функция: crm.clone

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции crm)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции crm)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • description — Описание контакта. Дополнительное описание контакта
  • employee — Сотрудник. Сотрудник создавший контакт
  • account — Клиент. Клиент связанный с контактом
  • project — Провайдер. Провайдер, к которому относится данный CRM-контакт
  • type — Тип контакта. Тип контакта
  • channel — Канал. Канал, по которому привлечен контакт
  • contactperson — Контактное лицо. Контактное лицо
  • email — Email. Email адрес контакта
  • phone — Номер телефона. Номер телефона контакта
  • attitude — Статус клиента. Характеристика клиента
  • info — Комментарий.

Установить фильтр по клиенту (включая данный список)

Функция: crm.setfilterall

Установить фильтр по клиенту (включая данный список)

Уровень доступа: admin

Установка фильтра.

crm.filter

Открыть привязанный к контакту запрос

Функция: crm.ticket

Открыть привязанный к контакту запрос

Уровень доступа: admin

Удалить

Функция: crm.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: crm.remind

Результат: список элементов

Список напоминаний CRM-контакта

Уровень доступа: admin

  • id — Id
  • remind_date — Дата
  • comment — Комментарий
  • status — Состояние

Изменить статус напоминания на "Выполнено"

Функция: crm.remind.resume

Изменить статус напоминания на "Выполнено"

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.remind.

Результат: успешное выполнение операции или сообщение об ошибке

Изменить статус напоминания на "Не выполнено"

Функция: crm.remind.suspend

Изменить статус напоминания на "Не выполнено"

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.remind.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить напоминание из списка

Функция: crm.remind.delete

Удалить напоминание из списка

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.remind.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование напоминания

Функция: crm.remind.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции crm).
    • elid — уникальный идентификатор (элемент id из функции crm.remind)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции crm).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции crm).
    • elid — уникальный идентификатор (элемент id из функции crm.remind)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • remind_date — Дата. Дата напоминания
  • comment — Комментарий. Произвольный текстовый комментарий

Закрыть CRM-контакт

Функция: crm.suspend

Закрыть CRM-контакт

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.

Результат: успешное выполнение операции или сообщение об ошибке

CRM-контакт

Функция: crm.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции crm)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции crm)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • description — Описание контакта. Дополнительное описание контакта
  • employee — Сотрудник. Сотрудник создавший контакт
  • account — Клиент. Клиент связанный с контактом
  • project — Провайдер. Провайдер, к которому относится данный CRM-контакт
  • type — Тип контакта. Тип контакта
  • channel — Канал. Канал, по которому привлечен контакт
  • contactperson — Контактное лицо. Контактное лицо
  • email — Email. Email адрес контакта
  • phone — Номер телефона. Номер телефона контакта
  • attitude — Статус клиента. Характеристика клиента
  • info — Комментарий.

Услуга

Функция: crm.item

Результат: список элементов

Список услуг CRM-контакта

Уровень доступа: admin

  • id — Id
  • name — Услуга
  • opendate — Дата активации
  • status — Статус услуги
  • project — Провайдер
  • itemtype — Тип продукта
  • pricelist — Тариф
  • contact — CRM-контакты
  • relationstatus — Статус

Выключить

Функция: crm.item.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.item.

Результат: успешное выполнение операции или сообщение об ошибке

Изменить

Функция: crm.item.edit

Изменить

Уровень доступа: admin

Включить

Функция: crm.item.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.item.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

crm.item.filter

Открыть CRM-контакт

Функция: crm.resume

Открыть CRM-контакт

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции crm.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: crm.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Редактирование информации о пользователе


Функция: user.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

  • email — Email. Укажите Email адрес пользователя, который будет использоваться в качестве имени пользователя, в дальнейшем изменение невозможно
  • verify_email — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) До проверки email адреса, пользователь не будет получать уведомления о новостях компании и событиях в личном кабинете
  • name — Логин. Логин для входа
  • realname — ФИО. Фамилия, Имя, Отчество
  • phone — Номер телефона. Номер телефона пользователя для получения СМС уведомлений. Уровень доступа: admin, user.
  • passwd — Пароль доступа клиента. Уровень доступа: admin, user.
  • confirm — Подтверждение. Уровень доступа: admin, user.
  • default_access_allow — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить пользователю полный доступ, никак не ограничивая его в правах.

Домены


Функция: domain

Результат: список элементов

Домены

Уровень доступа: admin user

  • id — Id
  • domain — Имя домена
  • account — Клиент
  • pricelist — Тариф
  • project — Провайдер
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Информация о домене

Функция: domain.whois

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • whois_data — Информация о домене. WHOIS информация о домене

Зарегистрировать новый домен/домены

Функция: domain.order.register

Зарегистрировать новый домен/домены

Уровень доступа: user

Включить

Функция: domain.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: domain.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Серверы имен

Функция: domain.ns

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • ns0 — NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns1 — NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns2 — NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns3 — NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
  • ns_additional — Дополнительные NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2". Каждый дополнительный сервер имен указывается с новой строки
  • provider — .

Установить фильтр по клиенту

Функция: domain.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Имя файла

Функция: domain.doc

Результат: список элементов

Документы

Уровень доступа: admin user

  • id — Id
  • profile — Контакт домена
  • doctype — Тип документа
  • name — Имя файла
  • size — Размер
  • props — Свойства

Тип документа

Функция: domain.doc.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • doctype — Тип документа. Тип загружаемого документа

Добавить документ

Функция: domain.doc.upload

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • doctype — Тип документа. Тип загружаемого документа

Удалить документ

Функция: domain.doc.delete

Удалить документ

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Просмотреть выбранный файл

Функция: domain.doc.file

Просмотреть выбранный файл

Уровень доступа: admin user

Отправить файлы для подтверждения данных контакта домена

Функция: domain.doc.verify

Отправить файлы для подтверждения данных контакта домена

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Выставить документу статус верификации

Функция: domain.doc.verified

Выставить документу статус верификации

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Скачать документ

Функция: domain.doc.download

Скачать документ

Уровень доступа: admin user

Войти в панель с правами пользователя

Функция: domain.su

Войти в панель с правами пользователя

Уровень доступа: admin

Перенести домен/домены от другого регистратора

Функция: domain.order.transfer

Перенести домен/домены от другого регистратора

Уровень доступа: user

Редактирование услуги

Функция: domain.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: domain.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Запросить данные и состояние домена у регистратора

Функция: domain.sync

Запросить данные и состояние домена у регистратора

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

domain.filter

Локализации


Функция: locale

Результат: список элементов

Локализации

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • langcode — Код
  • status — Состояние

Удалить

Функция: locale.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции locale.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: locale.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции locale.

Результат: успешное выполнение операции или сообщение об ошибке

Выставить локаль по умолчанию

Функция: locale.setdefault

Выставить локаль по умолчанию

Уровень доступа: admin

Редактирование локализации

Функция: locale.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции locale)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции locale)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование локализации (примеры: Русский, Французский)
  • langcode — Код языка. Код языка, который будет использоваться для идентификации локализованных сообщений

Выключить

Функция: locale.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции locale.

Результат: успешное выполнение операции или сообщение об ошибке

Забота о сервере


Функция: servicemonitor

Результат: список элементов

Забота о сервере

Уровень доступа: admin user

  • url — URL
  • monserver — Сервер
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Открытие услуги

Функция: servicemonitor.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции servicemonitor)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции servicemonitor)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Редактирование услуги

Функция: servicemonitor.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции servicemonitor)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции servicemonitor)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Установка фильтра.

servicemonitor.filter

Войти в панель с правами пользователя

Функция: servicemonitor.su

Войти в панель с правами пользователя

Уровень доступа: admin

Удалить выделенные услуги

Функция: servicemonitor.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции servicemonitor.

Результат: успешное выполнение операции или сообщение об ошибке

Заказать новую услугу

Функция: servicemonitor.order

Заказать новую услугу

Уровень доступа: user

Включить

Функция: servicemonitor.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции servicemonitor.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: servicemonitor.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции servicemonitor.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: servicemonitor.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Шаблоны сообщений


Функция: notifytype

Результат: список элементов

Типы шаблонов сообщений

Уровень доступа: admin

  • type — Тип

Наименование

Функция: notifytype.template

Результат: список элементов

Шаблоны сообщений

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • notice — Вид сообщения
  • project — Провайдер
  • intname — Внутреннее наименование
  • changetemplate — Дата изменения
  • status — Состояние

Выключить

Функция: notifytype.template.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: notifytype.template.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование шаблона сообщения

Функция: notifytype.template.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции notifytype).
    • elid — уникальный идентификатор (элемент id из функции notifytype.template)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции notifytype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции notifytype).
    • elid — уникальный идентификатор (элемент id из функции notifytype.template)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • project — Провайдер. Выберите провайдера, которым будет использоваться данный шаблон
  • notice — Тип уведомления. Тип уведомления определяет, при каком событии будет отправлено сообщение
  • subject — Заголовок сообщения. С указанным заголовком будет отправлено уведомление пользователю
  • allowcopy — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При отправке письмо будет скопировано в меню "Уведомления"
  • allowunverifiedemail — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает отправку уведомлений по данному шаблону на непроверенные адреса электронной почты
  • blindcopy — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Скрытая копия
  • blindcarboncopy — Email. Укажите email для отправки "скрытой" копии письма
  • content — Шаблон сообщения. Шаблон сообщения в формате xslt или ejs

Наименование

Функция: notifytypecontent.history

Результат: список элементов

История изменения шаблона

Уровень доступа: admin

  • changedate — Дата изменения
  • desc — Описание
  • user — Пользователь
  • ip — IP-адрес
  • action — Функция
Вернуться к предыдущему списку

Функция: notify.template

Вернуться к предыдущему списку

Уровень доступа: admin

Включить

Функция: notifytype.template.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Вернуть шаблон к исходному тексту

Функция: notifytype.template.restoredefault

Вернуть шаблон к исходному тексту

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notifytype.template.

Результат: успешное выполнение операции или сообщение об ошибке

Испытать шаблон

Функция: notifytype.template.try

Испытать шаблон

Уровень доступа: admin

Акты вып. работ


Функция: invoice

Результат: список элементов

Акты выполненных работ

Уровень доступа: admin user

  • id — Id
  • number — Номер
  • cdate — Дата
  • company — Компания
  • customer — Плательщик
  • amount_iso — Сумма
  • invoice_status — Статус
  • warning_message — Сообщение об ошибке
  • sdate — Дата отправки

Генерация актов

Функция: invoice.generate

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции invoice)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции invoice)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • invoice_status — Статус. Статус создаваемых актов
  • company — Компания. Выберите компанию, для которой создается акт выполненных работ
  • gentype — Плательщики. Выберите, для кого будет сгененерированы акты
  • profiletype — Тип плательщика. Выберите типы плательщиков для которых необходимо сгенерировать акты
  • customer — Плательщик. Плательщик, которому будет выставлен акт
  • cdate — Дата акта. Укажите дату выставления акта
  • fromdate — Расходы с даты. Укажите дату начала периода по которому выписываются акты
  • todate — Расходы по дату. Укажите дату завершения периода, по которому выписываются акты

Выставить статус "Подписан" для акта выполненных работ

Функция: invoice.status.4

Выставить статус "Подписан" для акта выполненных работ

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции invoice.

Результат: успешное выполнение операции или сообщение об ошибке

Скачать документ в формате PDF

Функция: invoice.print.pdf

Скачать документ в формате PDF

Уровень доступа: admin user

Написать запрос клиенту

Функция: ticket.write.invoice

Написать запрос клиенту

Уровень доступа: admin

Редактирование акта выполненных работ

Функция: invoice.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции invoice)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции invoice)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • number — Номер. Номер акта выполненных работ
  • cdate — Дата. Дата выставления акта выполненных работ
  • invoice_status — Статус. Статус акта выставляется вручную, если не подключен электронный документооборот

Запрос оригинала акта

Функция: invoice.request

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции invoice)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции invoice)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Наименование

Функция: invoice.history

Результат: список элементов

История изменения акта

Уровень доступа: admin user

  • changedate — Дата изменения
  • desc — Описание
  • user — Пользователь
  • ip — IP-адрес
  • action — Функция

Печать акта выполненных работ

Функция: invoice.print

Печать акта выполненных работ

Уровень доступа: admin user

Описание

Функция: invoice.item

Результат: список элементов

Выполненные работы по акту

Уровень доступа: admin user

  • id — Id
  • name — Описание
  • amount — Сумма
  • payments — Номера платежей

Пункт акта

Функция: invoice.item.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции invoice).
    • elid — уникальный идентификатор (элемент id из функции invoice.item)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции invoice).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции invoice).
    • elid — уникальный идентификатор (элемент id из функции invoice.item)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Описание. Описание услуги/работ

Установка фильтра.

invoice.item.filter

Войти в панель с правами пользователя

Функция: invoice.su

Войти в панель с правами пользователя

Уровень доступа: admin

Распечатать конверт для отправки акта почтой

Функция: invoice.envelope

Распечатать конверт для отправки акта почтой

Уровень доступа: admin

Удалить

Функция: invoice.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции invoice.

Результат: успешное выполнение операции или сообщение об ошибке

Аннулирование акта

Функция: invoice.revocation

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции invoice)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции invoice)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • revocation_comment — Комментарий. Укажите комментарий к предложению об аннулировании документа

Установить фильтр по клиенту

Функция: invoice.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Отправка актов выполненных работ

Функция: invoice.send

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции invoice)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции invoice)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • method — Способ отправки. Способ отправки актов клиентам
  • sdate — Дата отправки. Дата отправки актов будет выставлена в указанное значение
  • currency — Валюта. Валюта, в которой указана стоимость отправки и сумма актов для бесплатной отправки.
  • cost — Стоимость отправки. Если за отправление актов почтой вы хотите снимать деньги с клиента, укажите сумму в данном поле. Расход будет создан с наименованием "Операционные расходы". Если средств на счету не достаточно, то баланс окажется отрицательным.
  • freepostsum — Сумма актов для бесплатной отправки. Вы можете указать сумму актов одного клиента, при достижении которой отправка будет бесплатной

Перегенерация акта

Функция: invoice.regenerate

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции invoice)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции invoice)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • invoice_status — Статус. Статус создаваемых актов
  • cdate — Дата акта. Укажите дату выставления акта
  • fromdate — Расходы с даты. Укажите дату начала периода по которому выписываются акты
  • todate — Расходы по дату. Укажите дату завершения периода, по которому выписываются акты

Выставить статус "Создан" для акта выполненных работ

Функция: invoice.status.1

Выставить статус "Создан" для акта выполненных работ

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции invoice.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

invoice.filter

Единицы измерения


Функция: measure

Результат: список элементов

Единицы измерения

Уровень доступа: admin

  • id — Id
  • name — Наименование

Удалить

Функция: measure.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции measure.

Результат: успешное выполнение операции или сообщение об ошибке

Единица измерения

Функция: measure.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции measure)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции measure)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • intname — Внутреннее имя. Внутреннее имя, которое используется в системе
  • lessmeasure — Имеет соотношение к. Единица измерения, к которой установится соотношение
  • relation — Соотношение. Значение соотношения к выбранной единице измерения

Список нарушений


Функция: abuse_task

Результат: список элементов

Список нарушений

Уровень доступа: admin

  • id — Id
  • ticket — Запрос
  • subject — Тема
  • opendate — Дата создания
  • deadline — Срок устранения
  • account — Клиент
  • author — Инициатор
  • score — Количество баллов
  • status — Состояние
  • action — Функция

Закрыть нарушение

Функция: abuse_task.finish

Закрыть нарушение

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции abuse_task.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: abuse_task.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: abuse_task.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Нарушение

Функция: abuse_task.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции abuse_task)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции abuse_task)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • subject — Тема. Тема нарушения
  • account — Клиент. Клиент, на которого будет назначено нарушение
  • score — Количество баллов. Количество баллов за нарушение
  • action — Действие. Действие, которое необходимо выполнить при отсутствии реакции от клиента до установленного срока
  • abuse_item — Услуга. Услуга клиента, к которой относится нарушение. Также услуга будет выбрана для создаваемого запроса
  • user_responsible — Отдел. Отдел, в которой будет передан запрос при ответе клиента
  • user_deadline_responsible — Отдел. Отдел, в которой будет передан запрос при отсутствии реакции клиента
  • deadline_date — Дата устранения нарушения. Срок устранения нарушения, дата
  • deadline_time — Время устранения нарушения. Срок устранения нарушения, время
  • message — Сообщение. Сообщение, отправляемое клиенту. Так же это сообщение будет первым в создаваемом запросе
  • score_note — Комментарий. Комментарий к нарушению

Установка фильтра.

abuse_task.filter

Удалить

Функция: abuse_task.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции abuse_task.

Результат: успешное выполнение операции или сообщение об ошибке

Типы продуктов


Функция: itemtype

Результат: список элементов

Типы продуктов

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • intname — Внутреннее наименование
  • orderpriority — Сортировка

Редактирование типа продукта

Функция: itemtype.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции itemtype)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции itemtype)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование типа продукта
  • intname — Внутреннее имя. Внутреннее имя типа, которое используется для его идентификации. Также по внутреннему имени отбираются поддерживаемые обработчики
  • itemname — Шаблон наименования услуги. XSLT шаблон, на основе которого формируется наименование услуги и расходов за услуги данного типа. При отсутствии заполнения используется стандартный шаблон для типа
  • trialtype — Триальная версия. Выберите способ предоставления клиентам триальной версии услуг данного типа
  • splitexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает равномерное распределение расходов по месяцам, например: при оплате услуги за год будет создано 12 или 13 расходов за каждый месяц, в котором будет активна услуга. Удобно для актов выполненных работ, а также учета расходов будущих периодов
  • nostopholidays — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Установите опцию, если не хотите, чтобы услуги клиентов останавливались в выходные дни: субботу и воскресенье
  • open_duration_limit — Регламент на обработку. Регламент на время обработки услуг. Формат чч:мм
  • suspendperiod — Период автоудаления. Укажите, через сколько дней после остановки неоплаченную услугу необходимо удалить
  • closetype — Правила удаления услуг. Политика доступа клиентов к удалению услуг данного типа
  • closesubtype — При удалении клиентом. Правила удаления услуги, если удаляет сам клиент
  • trial — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить триальный период
  • day — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в день
  • monthly — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в месяц
  • quarterly — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в три месяца
  • semiannual — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в полгода
  • annually — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в год
  • biennial — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в два года
  • triennial — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в три года
  • quadrennial — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в четыре года
  • quinquennial — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в пять лет
  • decennial — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить период в десять лет
  • lifetime — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить единоразовую оплату
  • transfer — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить трансфер
  • orderview — Отображение тарифов. Переключает режим отображения выбора тарифа при заказе услуги клиентом. Настроить описание тарифа можно в его настройках
  • show_addon_image — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность настройки и отображение иконок ресурсов при заказе и редактировании услуг

Наименование

Функция: itemtype.detail

Результат: список элементов

Содержание типа продукта

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • intname — Внутреннее наименование
  • orderpriority — Сортировка

Переместить на одну позицию выше

Функция: itemtype.detail.up

Переместить на одну позицию выше

Уровень доступа: admin

Удалить

Функция: itemtype.detail.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.detail.

Результат: успешное выполнение операции или сообщение об ошибке

Дополнение к типу продукта

Функция: itemtype.detail.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid — уникальный идентификатор (элемент id из функции itemtype.detail)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid — уникальный идентификатор (элемент id из функции itemtype.detail)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование типа продукта
  • intname — Внутреннее имя. Внутреннее имя дополнения к типу продукта
  • description — Описание. Краткое описание дополнения для отображения в BILLmanager 6
  • orderpriority — Сортировка (в прямом порядке). Порядок сортировки дополнений на форме
  • showoninfo — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Используется при детализации услуги. Отображается только в пользовательском интерфейсе BILLmanager 6
  • select_paramgroup — Группа. Принадлежность к одной из групп. Используется при детализации услуги. Отображается только в пользовательском интерфейсе BILLmanager 6

Переместить на одну позицию ниже

Функция: itemtype.detail.down

Переместить на одну позицию ниже

Уровень доступа: admin

Наименование

Функция: itemtype.param

Результат: список элементов

Параметры услуг

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • intname — Внутреннее наименование
  • orderpriority — Сортировка

Переместить параметр услуги на одну позицию вверх

Функция: itemtype.param.up

Переместить параметр услуги на одну позицию вверх

Уровень доступа: admin

Редактирование параметра

Функция: itemtype.param.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid — уникальный идентификатор (элемент id из функции itemtype.param)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid — уникальный идентификатор (элемент id из функции itemtype.param)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • tune_pricelists — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При отключенной опции параметр подключен ко всем тарифным планам, активная опция позволяет производить настройку подключения вручную
  • intname — Внутреннее имя. Внутреннее имя параметра для использования в обработчиках услуг
  • ordervisible — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте галочку, если при заказае необходимо попросить пользователя указать этот параметр
  • openvisible — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте галочку, если параметр необходимо заполнить при открытии услуги. Заполняется автоматическим обработчиком или вручную.
  • listvisible — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте галочку, если параметр необходимо показывать в списке услуг
  • editreadlevel — Доступ на чтение. Минимальный уровень пользователя, для которого будет виден параметр
  • editwritelevel — Доступ для изменения. Минимальный уровень пользователя, которому будет доступно изменение параметра
  • needsetparam — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При изменении параметра будет вызван модуль обработки с командой setparam
  • crypted — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выставите флаг, если значение параметра необходимо хранить в зашифрованном виде
  • hint — Подсказка. Подсказка к полю, которая появляется при наведении на символ вопроса
  • description — Описание. Краткое описание параметра для отображения в BILLmanager 6
  • orderpriority — Сортировка. Сортировка параметров при отображении на форме заказа и редактирования услуги
  • select_paramgroup — Группа. Принадлежность к одной из групп. Используется при детализации услуги. Отображается только в пользовательском интерфейсе BILLmanager 6
  • selecttype — Тип отображения. Используется только в пользовательском интерфейсе BILLmanager 6
  • inputtype — Тип поля ввода. Укажите данные какого типа будут вводиться в поле
  • zoom — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает возможность ввода нескольких значений, разделенных пробелом. Выбранный валидатор будет применен к каждому значению в отдельности
  • inputrows — Количество строк ввода. Укажите количество строк ввода в текстовом поле
  • required — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить пустое значение для параметра
  • validator — Функция проверки. Выберите функцию проверки введенного значения. Это не позволит пользователю ввести значение в неправильном формате
  • select_ip — Тип адреса. Тип IP-адреса
  • num_range — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Диапазон допустимых значений
  • r_start_int — Начало диапазона. Начальное значение диапазона
  • r_end_int — Конец диапазона. Конечное значение диапазона
  • r_start_float — Начало диапазона. Начальное значение диапазона
  • r_end_float — Конец диапазона. Конечное значение диапазона

Переместить параметр услуги на одну позицию вниз

Функция: itemtype.param.down

Переместить параметр услуги на одну позицию вниз

Уровень доступа: admin

Тарифный план

Функция: itemtype.param.pricelist

Результат: список элементов

Тарифные планы

Уровень доступа: admin

  • id — Id
  • name — Тарифный план
  • status — Состояние
Подключить параметр к тарифному плану

Функция: itemtype.param.pricelist.resume

Подключить параметр к тарифному плану

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Отключить параметр от тарифного плана

Функция: itemtype.param.pricelist.suspend

Отключить параметр от тарифного плана

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: itemtype.param.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: itemtype.param.value

Результат: список элементов

Значения для параметров с типом список

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • intname — Внутреннее имя
  • tags — Тэги
  • orderpriority — Сортировка
  • status — Состояние
Подключить значение параметра ко всем тарифным планам

Функция: itemtype.param.value.resume

Подключить значение параметра ко всем тарифным планам

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.value.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование значения

Функция: itemtype.param.value.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype.param).
    • elid — уникальный идентификатор (элемент id из функции itemtype.param.value)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype.param).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype.param).
    • elid — уникальный идентификатор (элемент id из функции itemtype.param.value)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • intname — Внутреннее имя. Внутреннее имя значения. Обычно используется модулями обработки
  • tags — Тэги. Список тэгов, разделенных знаком ","
  • disablepricelists — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При активной опции значение параметра автоматически не подключается к тарифным планам, в том числе при создании нового тарифного плана
  • info — Краткая информация. Краткая информация к значению списка, которая будет показана клиенту при выборе
  • orderpriority — Сортировка. Позволяет задать порядок отображения параметра в списке выбора на форме редактирования услуги
  • valuegroup — Группа параметров. Позволяет задать группу, в которой будет отображаться параметр на форме заказа и редактирования услуги. Отображается только в пользовательском интерфейсе BILLmanager 6
Отключить значение параметра от всех тарифных планов

Функция: itemtype.param.value.suspend

Отключить значение параметра от всех тарифных планов

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.value.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить значение параметра услуги на одну позицию вниз в списке

Функция: itemtype.param.value.down

Переместить значение параметра услуги на одну позицию вниз в списке

Уровень доступа: admin

Установка фильтра.

itemtype.param.value.filter

Переместить значение параметра услуги на одну позицию вверх в списке

Функция: itemtype.param.value.up

Переместить значение параметра услуги на одну позицию вверх в списке

Уровень доступа: admin

Модуль обработки

Функция: itemtype.param.value.processing

Результат: список элементов

Обработчики услуг

Уровень доступа: admin

  • id — Id
  • name — Модуль обработки
  • status — Состояние
Выключить

Функция: itemtype.param.value.processing.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.value.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: itemtype.param.value.processing.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.value.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Тарифный план

Функция: itemtype.param.value.pricelist

Результат: список элементов

Тарифные планы

Уровень доступа: admin

  • id — Id
  • name — Тарифный план
  • status — Состояние
Включить

Функция: itemtype.param.value.pricelist.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.value.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: itemtype.param.value.pricelist.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.value.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: itemtype.param.value.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.param.value.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: itemtype.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: itemtype.orderpage

Результат: список элементов

Страницы заказа

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • intname — Внутреннее наименование
  • orderpriority — Сортировка
  • status — Состояние

Удалить

Функция: itemtype.orderpage.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.orderpage.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить страницу на одну позицию вверх

Функция: itemtype.orderpage.up

Переместить страницу на одну позицию вверх

Уровень доступа: admin

Редактирование страницы заказа

Функция: itemtype.orderpage.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid — уникальный идентификатор (элемент id из функции itemtype.orderpage)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции itemtype).
    • elid — уникальный идентификатор (элемент id из функции itemtype.orderpage)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование страницы
  • intname — Внутреннее имя. Внутреннее имя страницы, которое используется для его идентификации
  • orderpriority — Сортировка. Порядок сортировки
  • defaultpage — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Страница по умолчанию для распределения тарифов. При выборе этого пункта данный флаг у текущей страницы по умолчанию будет снят

Переместить страницу на одну позицию вниз

Функция: itemtype.orderpage.down

Переместить страницу на одну позицию вниз

Уровень доступа: admin

Переместить тип продукта на одну позицию вниз

Функция: itemtype.down

Переместить тип продукта на одну позицию вниз

Уровень доступа: admin

Переместить тип продукта на одну позицию вверх

Функция: itemtype.up

Переместить тип продукта на одну позицию вверх

Уровень доступа: admin

Уведомления


Функция: notification

Результат: список элементов

Уведомления

Уровень доступа: admin user

  • id — Id
  • subject — Заголовок
  • cdate — Дата

Удалить

Функция: notification.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notification.

Результат: успешное выполнение операции или сообщение об ошибке

Просмотр уведомления

Функция: notification.view

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции notification)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции notification)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

DNS-хостинг


Функция: dnshost

Результат: список элементов

DNS-хостинг

Уровень доступа: admin user

  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Установка фильтра.

dnshost.filter

Заказать новую услугу

Функция: dnshost.order

Заказать новую услугу

Уровень доступа: user

Открытие услуги

Функция: dnshost.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции dnshost)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции dnshost)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Удалить выделенные услуги

Функция: dnshost.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции dnshost.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: dnshost.su

Войти в панель с правами пользователя

Уровень доступа: admin

Выключить

Функция: dnshost.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции dnshost.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: dnshost.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Включить

Функция: dnshost.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции dnshost.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование услуги

Функция: dnshost.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции dnshost)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции dnshost)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Игровой хостинг


Функция: gamehost

Результат: список элементов

Игровой хостинг

Уровень доступа: admin user

  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Заказать новую услугу

Функция: gamehost.order

Заказать новую услугу

Уровень доступа: user

Выключить

Функция: gamehost.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gamehost.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: gamehost.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: gamehost.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Установка фильтра.

gamehost.filter

Включить

Функция: gamehost.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gamehost.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование услуги

Функция: gamehost.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции gamehost)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции gamehost)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: gamehost.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gamehost.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: gamehost.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции gamehost)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции gamehost)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Серверы имен


Функция: processing.nameserver

Результат: список элементов

Серверы имен

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • module — Панель управления
  • status — Состояние

Перейти в панель

Функция: processing.nameserver.gotoserver

Перейти в панель

Уровень доступа: admin

Создать

Функция: processing.nameserver.add

Создать

Уровень доступа: admin

Удалить

Функция: processing.nameserver.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.nameserver.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование сервера имен

Функция: processing.nameserver.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции processing.nameserver)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции processing.nameserver)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • project — Провайдер. Провайдер, к которому относится сервер имен
  • module — Панель управления. Выберите панель управления
  • name — Наименование. Наименование сервера имен
  • url — URL. URL панели управления
  • login — Имя пользователя. Укажите имя пользователя для доступа к панели управления (уровень пользователя для DNSmanager — реселлер или пользователь; для ISPmanager — реселлер или администратор)
  • password — Пароль. Укажите пароль для доступа к панели управления
  • freedomain — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сервер может использоваться для создания бесплатных доменных имен
  • dnsprovider — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сервер может использоваться для создания доменных имен провайдера
  • dnsprovidercount — Количество доменов. Максимальное количество доменов на учетную запись
  • dnsprivate — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сервер может использоваться для создания собственных доменных имен
  • dnsprivatecount — Количество доменов. Максимальное количество доменов на учетную запись

Журнал операций


Функция: journal

Результат: список элементов

Журнал операций

Уровень доступа: user

  • time — Время
  • user — Пользователь
  • ip — Удалённый IP-адрес
  • funcname — Функция

Установка фильтра.

journal.filter

Просмотр журнала

Функция: journal.edit

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции journal)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции journal)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • time — Время. Время выполнения операции с панелью управления
  • user — Пользователь. Пользователь, выполнивший операцию с панелью управления
  • ip — Удалённый IP-адрес. IP-адрес, с которого пользователь выполнил операцию с панелью управления
  • funcname — Функция. Имя вызванной функции панели управления
  • params — Параметры. Список параметров, переданных функции панели управления

Наименование

Функция: journal.stat

Результат: отчёт

Использование функций за период

Уровень доступа: admin+

Обработчики услуг


Функция: processing

Результат: список элементов

Обработчики услуг

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • module — Обработчик
  • datacenter_name — Дата-центр
  • pusage — Использование
  • balance_info — Баланс обработчика
  • orderpriority — Сортировка
  • status — Состояние

Наименование

Функция: processing.customparam

Результат: список элементов

Параметры модуля обработки

Уровень доступа: admin

  • id — Id
  • param — Параметр
  • value — Значение

Вы можете задать условия отбора для данного списка. Они будут применяться всякий раз при его отображении до тех пор пока фильтр не будет изменен или снят

Функция: processing.customparam.filter

Вы можете задать условия отбора для данного списка. Они будут применяться всякий раз при его отображении до тех пор пока фильтр не будет изменен или снят

Уровень доступа: admin

Редактирование параметра

Функция: processing.customparam.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid — уникальный идентификатор (элемент id из функции processing.customparam)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid — уникальный идентификатор (элемент id из функции processing.customparam)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • param — Параметр. Укажите тип параметра
  • value — Значение. Значение параметра

Удалить выбранные параметры

Функция: processing.customparam.delete

Удалить выбранные параметры

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.customparam.

Результат: успешное выполнение операции или сообщение об ошибке

Обновить конфигурацию модуля обработки

Функция: processing.updateconfig

Обновить конфигурацию модуля обработки

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Создать

Функция: processing.add

Создать

Уровень доступа: admin

Установка фильтра.

processing.filter

Переместить модуль обработки на одну позицию выше

Функция: processing.up

Переместить модуль обработки на одну позицию выше

Уровень доступа: admin

Наименование

Функция: processing.pricelist

Результат: список элементов

Тарифы, обрабатываемые модулем

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Включить

Функция: processing.pricelist.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: processing.pricelist.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить модуль обработки на одну позицию ниже

Функция: processing.down

Переместить модуль обработки на одну позицию ниже

Уровень доступа: admin

Удалить

Функция: processing.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: processing.import

Результат: список элементов

Импорт услуг

Уровень доступа: admin

  • id — Id
  • item_name — Наименование
  • expiredate — Действует до
  • account — Клиент
  • status — Статус

Очистить список услуг

Функция: processing.import.clear

Очистить список услуг

Уровень доступа: admin

Наименование

Функция: processing.import.service_profile

Результат: список элементов

Загруженные профили услуги

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • item_count — Количество услуг
Параметры контакта

Функция: service_profile.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing.import).
    • elid — уникальный идентификатор (элемент id из функции processing.import.service_profile)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing.import).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing.import).
    • elid — уникальный идентификатор (элемент id из функции processing.import.service_profile)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Название профиля. Название профиля используется для упрощения идентификации его в списке профилей услуг
  • profiletype — Тип контакта. Юридический статус контакта

Удалить выделенные услуги

Функция: processing.import.delete

Удалить выделенные услуги

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.import.

Результат: успешное выполнение операции или сообщение об ошибке

Получение списка услуг

Функция: processing.import.load

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid — уникальный идентификатор (элемент id из функции processing.import)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid — уникальный идентификатор (элемент id из функции processing.import)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • itemtype — Тип услуг. Тип услуг, для которого будут получены данные
  • search — Условие поиска. Условие, по которому будут отобраны услуги. Если необходимо импортировать все услуги, то нужно оставить пустым. Если интересует определенная услуга, то введите часть ее наименования или доменное имя. Пример: foo.bar

Назначение услуги клиенту

Функция: processing.import.assign

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid — уникальный идентификатор (элемент id из функции processing.import)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции processing).
    • elid — уникальный идентификатор (элемент id из функции processing.import)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • account — Клиент. Клиент, к которому переносится услуга

Включить

Функция: processing.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование модуля обработки

Функция: processing.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции processing)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции processing)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • datacenter — Дата-центр. Дата-центр
  • name — Наименование. Произвольное наименование обработчика для отображения в интерфейсе
  • department — Ответственный. Ответственный отдел, на который будут назначаться задачи в случае необходимости
  • orderpriority — Сортировка. Приоритет обработчика
  • threshold — Минимальный баланс обработчика. Минимальный баланс обработчика, для успешного продления услуг

Перейти в панель

Функция: gotomoduleserver

Перейти в панель

Уровень доступа: admin

Выключить

Функция: processing.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции processing.

Результат: успешное выполнение операции или сообщение об ошибке

Шаблоны документов


Функция: doctmpl

Результат: список элементов

Шаблоны документов

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • doctype — Тип
  • templatetype — Разметка
  • locale — Язык документа

Сброс на значение по умолчанию шаблона

Функция: doctmpl.restoredefault

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции doctmpl)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции doctmpl)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • doctmpl — Шаблон. Позволяет использовать один из встроенных шаблонов как основу создаваемого документа

Редактирование шаблона документа

Функция: doctmpl.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции doctmpl)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции doctmpl)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование шаблона
  • doctype — Тип документа. Тип документа используется для фильтрации списка документов при выборе его в качестве шаблона печатной формы
  • language — Язык. Язык текста документа
  • doctmpl — Шаблон. Позволяет использовать один из встроенных шаблонов как основу создаваемого документа
  • content — Содержимое шаблона документа. Содержимое шаблона документа в формате XSLT или EJS

Удалить

Функция: doctmpl.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции doctmpl.

Результат: успешное выполнение операции или сообщение об ошибке

Виртуальный хостинг


Функция: vhost

Результат: список элементов

Виртуальный хостинг

Уровень доступа: admin user

  • domain — Доменное имя
  • ip — IP-адрес
  • processingnode — Узел кластера
  • username — Имя пользователя
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Редактирование услуги

Функция: vhost.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vhost)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vhost)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: vhost.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vhost.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: vhost.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vhost.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: vhost.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vhost)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vhost)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Заказать новую услугу

Функция: vhost.order

Заказать новую услугу

Уровень доступа: user

Войти в панель с правами пользователя

Функция: vhost.su

Войти в панель с правами пользователя

Уровень доступа: admin

Выключить

Функция: vhost.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vhost.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

vhost.filter

Установить фильтр по клиенту

Функция: vhost.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Тарифные планы


Функция: pricelist

Результат: список элементов

Тарифные планы

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • itemtype_name — Тип
  • project — Провайдер
  • processingmodules — Обработчики
  • pricelist_cost — Стоимость
  • orderpriority — Сортировка
  • status — Состояние

Наименование

Функция: pricelist.history

Результат: список элементов

История изменения тарифного плана

Уровень доступа: admin

  • changedate — Дата изменения
  • desc — Описание тарифа
  • user — Пользователь
  • ip — IP-адрес
  • action — Функция

Наименование

Функция: itemtype.orderreference

Результат: список элементов

Правила заказа тарифа

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Включить

Функция: itemtype.orderreference.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: pricelist.orderreference

Результат: список элементов

Правила заказа тарифа

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние
Включить

Функция: pricelist.orderreference.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: pricelist.orderreference.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: itemtype.orderreference.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции itemtype.orderreference.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: pricelist.detail

Результат: список элементов

Содержание тарифного плана

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • price — Цены
  • orderpriority — Сортировка
  • status — Состояние

Наименование

Функция: pricelist.detail.integer

Результат: список элементов

Цены при разных количествах

Уровень доступа: admin

  • id — Id
  • value — Количество
  • price — Цены
Удалить

Функция: pricelist.detail.integer.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.detail.integer.

Результат: успешное выполнение операции или сообщение об ошибке

Специальная цена

Функция: pricelist.detail.integer.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid — уникальный идентификатор (элемент id из функции pricelist.detail.integer)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid — уникальный идентификатор (элемент id из функции pricelist.detail.integer)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • value — Количество. Количество ресурсов, при достижении которого (больше или равно) будет применяться специальная цена. Значения от до

Включить

Функция: pricelist.detail.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.detail.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: pricelist.detail.enum

Результат: список элементов

Цены

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • price — Цена
  • orderpriority — Сортировка
  • status — Состояние
Включить

Функция: pricelist.detail.enum.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.detail.enum.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: pricelist.detail.enum.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.detail.enum.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить на одну позицию вверх

Функция: pricelist.detail.enum.up

Переместить на одну позицию вверх

Уровень доступа: admin

Цены

Функция: pricelist.detail.enum.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid — уникальный идентификатор (элемент id из функции pricelist.detail.enum)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.detail).
    • elid — уникальный идентификатор (элемент id из функции pricelist.detail.enum)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • orderpriority — Сортировка. Порядок сортировки элемента перечисления в списке выбора
Переместить на одну позицию вниз

Функция: pricelist.detail.enum.down

Переместить на одну позицию вниз

Уровень доступа: admin

Переместить дополнение к тарифу на одну позицию вверх

Функция: pricelist.detail.up

Переместить дополнение к тарифу на одну позицию вверх

Уровень доступа: admin

Редактирование ресурса

Функция: pricelist.detail.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid — уникальный идентификатор (элемент id из функции pricelist.detail)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid — уникальный идентификатор (элемент id из функции pricelist.detail)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • billtype — Тип учета. Способ списания средств за дополнение с клиента
  • chargestoped — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При выключенном флаге клиент получает компенсацию за часы простоя остановленной услуги.
  • itemtype — Тип. Тип дополнения. Определяет ресурс, который регулируется данным дополнением
  • addontype — Тип значения. Способ задания значения дополнения к тарифу
  • selecttype — Тип отображения. Используется только в пользовательском интерфейсе BILLmanager 6
  • scaletype — Тип шкалы значений. Параметр используется при расчете стоимости дополнения при заданной шкале цен
  • restrictclientchange — Изменение ресурса после заказа. Политика изменение клиентом ресурса после заказа
  • minperiodtype — Мин. период заказа. Минимальный период, по истечению которого клиент сможет изменить дополнение в сторону уменьшения
  • minperiodlen — Длительность. Длина минимального периода заказа дополнения
  • manualprocessing — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для обработки ресурса будет создана задача в технический отдел
  • manualprocessing_skipdefault — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если данная опция включена, и для дополнения выбрано значение по умолчанию, то это дополнение не будет добавлено в задачу на ручную обработку.
  • manualname — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции в качестве наименования дополнения будет использовано указанное значение
  • name — Наименование. Наименование тарифного плана
  • intname — Служебное имя. Указывается при необходимости переопределения стандартного служебного имени дополнения, например для расчета статистики использования ресурсов по нескольким параметрам, или в случае если имя параметра отличается от служебного имени дополнения
  • processing_feature — Проверять возможность. При выборе дополнения с указанной возможностью будет выбран обработчик, у которого данная возможность присутствует
  • roundtype — Способ округления. Способ округления расчитанного значения
  • addonstattype — Считать превышение. Выберите, за какой период считать превышение
  • addonstatcomparison — Если параметров несколько. Выберите как считать, если параметров одного типа несколько. К примеру, трафик может быть входящим и исходящим.
  • addonstatcalculation — Цена указана. Укажите, за что указана цена. Если за единицу в месяц, то статистика будет считаться как: (превышение за день) * (цену) / (количество дней в месяце)
  • addonstatchargestoped — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При проставленной опции списание по данному дополнению будут идти и на остановленной услуге
  • allowpostpaid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает списание средств за перерасход ресурса без учета баланса клиента
  • summarizeinvoice — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Суммировать значение параметра за весь период при генерации акта выполненных работ
  • measure — Единица измерения. Единица измерения, в которой задается дополнение. При передаче значения дополнения в панель управления заказанное значение будет переведено в единицу измерения используемую панелью управления
  • addonlimit — Включено в тариф. Значение по умолчанию для дополнения
  • addonstep — Шаг. Шаг заказа дополнения
  • addonmin — Минимальное значение. Минимальное значение для заказа. Не может быть меньше чем включено в тариф.
  • addonmax — Максимальное значение. Максимальное доступное для заказа значение ресурса
  • addonlimittrial — Включено в тариф на триальном периоде. Значение по умолчанию для дополнения на триальном периоде
  • addonmaxtrial — Максимальное значение на триальном периоде. Максимальное доступное для заказа значение ресурса которое можно заказать на триальном периоде
  • enumeration — Перечисление. Перечисление, из которого будут браться значения для дополнений к услугам
  • enumerationitem — Значение по умолчанию. Элемент перечисления, включенный по умолчанию при заказе услуги
  • orderpolicy — Стоимость при изменении. Способ расчета стоимости изменения значения дополнения
  • addonbool — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Значение по умолчанию для дополнения
  • orderpriority — Сортировка (в прямом порядке). Позволяет задать приоритет дополнения тарифа при сортировке
  • description — Описание дополнения. Описание дополнения. Поддерживается простой html. Для переноса строки используйте <br/>, для выделения жирным шрифтом или курсивом <b></b> и <i></i>
  • description_markdown — Описание дополнения (markdown). Описание дополнения. Для составления описания используется markdown разметка

Удалить

Функция: pricelist.detail.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.detail.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить дополнение тарифу на одну позицию вниз

Функция: pricelist.detail.down

Переместить дополнение тарифу на одну позицию вниз

Уровень доступа: admin

Наименование

Функция: pricelist.detail.compound

Результат: список элементов

Варианты ресурса

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • price — Цены
  • orderpriority — Сортировка
  • status — Состояние
Переместить дополнение к тарифу на одну позицию вверх

Функция: pricelist.detail.compound.up

Переместить дополнение к тарифу на одну позицию вверх

Уровень доступа: admin

Выключить

Функция: pricelist.detail.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.detail.compound.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить дополнение тарифу на одну позицию вниз

Функция: pricelist.detail.compound.down

Переместить дополнение тарифу на одну позицию вниз

Уровень доступа: admin

Импорт тарифа со стороннего сервера

Функция: pricelist.import

Импорт тарифа со стороннего сервера

Уровень доступа: admin

Наименование

Функция: pricelist.reference

Результат: список элементов

Настройка зависимостей дополнений

Уровень доступа: admin

  • id — Id
  • referencedesc — Зависимость
  • reference — Соотношение

Изменение зависимости

Функция: pricelist.reference.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid — уникальный идентификатор (элемент id из функции pricelist.reference)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist).
    • elid — уникальный идентификатор (элемент id из функции pricelist.reference)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • pricelist_base — Основное дополнение. Дополнение тарифного плана, при изменении которого будет изменено значение зависимого дополнения
  • base_value — Значение. Значение основного дополнения, при котором будет изменено зависимое дополнение. Значения от до
  • enumerationitem_base — Значения. Значения, при выборе одного из которых будет изменено зависимое дополнений
  • pricelist_reference — Зависимое дополнение. Дополнение, которое будет изменено при изменении основного дополнения
  • reference_value — Значение. Значение, которое будет выставлено для зависимого дополнения. Значения от до
  • enumerationitem_reference — Значения. Значения, которые будут доступны при изменении основного дополнения

Копировать выбранную зависимость

Функция: pricelist.reference.clone

Копировать выбранную зависимость

Уровень доступа: admin

Удалить

Функция: pricelist.reference.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.reference.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: pricelist.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить тариф на одну позицию вверх

Функция: pricelist.up

Переместить тариф на одну позицию вверх

Уровень доступа: admin

Выключить

Функция: pricelist.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Создать

Функция: pricelist.add

Создать

Уровень доступа: admin

Редактирование тарифного плана

Функция: pricelist.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции pricelist)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции pricelist)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование тарифного плана
  • processingmodule — Обработчик услуг. Выберите какие обработчики услуг будут обрабатывать услуги создаваемого тарифного плана. Тарифы не подключенные к обработчикам услуг не будут доступны для заказа.
  • modulepreset — Конфигурация.
  • intname — Внутреннее наименование. Внутренее наименование служит для получения значений по умолчанию параметров создаваемых услуг из обработчика либо для идентификации базовой конфигурации при ручной обработке
  • billdaily — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенном флаге оплата за услугу будет сниматься ежедневно. Сумма будет рассчитана пропорционально стоимости одного дня в месяце расчета. Политики смены тарифа при этом не работают.
  • billhourly — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении флага клиент получает права на запуск/остановку услуг данного тарифа. В зависимости от установки флага "Списывать средства при остановке", клиент может получить компенсацию за часы простоя остановленной услуги. При этом средства списываются в начале дня полностью, возврат компенсации осуществляется на следующий день с учетом времени простоя.
  • chargestoped — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При выключенном флаге клиент получает компенсацию за часы простоя остановленной услуги. Такой же флаг есть у каждого ресурса (по умолчанию он включен). Нет никакой зависимости между флагами в самом тарифном плане и в дополнительных ресурсах.
  • autocalcday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если стоит флаг, то стоимость дня рассчитывается из стоимости месяца деленного на количество дней в месяц
  • billprorata — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении опции срок действия услуги будет выровнен по календарному месяцу в зависимости от дня, указанного в поле "Переходный день". Если клиент заказывает услугу в день месяца до указанного, срок действия услуги будет рассчитан до конца текущего месяца; если же в день указанный в настройке или позже, то до конца следующего месяца. Также пропорционально изменению периода действия услуги будет изменена стоимость заказа/продления
  • prorataday — Переходный день. Переходный день для календарного списания средств
  • quickorder — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность быстрого заказа услуг, без указания при заказе параметров
  • opennotify — Шаблон уведомления об открытии услуги. Шаблон, на основе которого будет сформирована инструкция по услуге. Отправляется на почту клиенту после обработки открытия услуги, а также доступна по кнопке в списке услуг
  • license — Условия предоставления услуг. Шаблон отображения условий предоставления услуг, при наличии которого, во время заказа услуги, клиенту будет необходимо согласиться с условиями предоставления услуг. Создать или отредактировать шаблон можно в меню 'Шаблоны документов'
  • pricelist_group — Группа тарифа. Группа тарифа служит для объединения тарифов для предоставления общих скидок и действия политик триального периода, а также для объединения тарифов по группам в отчетах
  • create_addon — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При создании тарифа будут также созданы все доступные для тарифного плана дополнения
  • show_on_dashboard — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отображать тариф на главной странице в интерфейсе BILLmanager 6
  • orderpage — Страница. Страница заказа услуги, на которой будет отображен тариф в интерфейсе BILLmanager 6
  • ostemplate — Шаблоны операционных систем. Шаблоны операционных систем, которые будут включены в тариф
  • access — Доступен для заказа. Выбор группы клиентов, для которой тариф доступен для заказа и перехода
  • minperiodtype — Минимальный период заказа. Минимальный период, по истечении которого клиент сможет отказаться от услуги. При ежедневном списании также влияет на резервирование средств на оплату заказанной услуги
  • minperiodlen — Длина минимального периода. Длина минимального периода в днях или месяцах
  • trial — Триальный период. Длина триального периода в днях. Политика предоставления триального периода определяется настройками типа продукта. Оставьте пустым, если для данного тарифа нет пробного периода
  • trial_itemmax — Количество триалов доступных для заказа. Максимальное количество триальных экземпляров услуг данного тарифного плана
  • itemmax — Количество услуг доступных для заказа. Укажите максимально количество услуг доступных для заказа одним клиентом. По достижению указанного количества клиентом, заказ дополнительных услуг данного тарифа клиенту будет недоступен
  • suspendpenaltytype — Штраф за просрочку продления. Тип штрафа за просрочку продления услуги. Штраф взимается непосредственно при оплате продления услуги
  • suspendpenaltypercent — Процент стоимости. Процент стоимости услуги за просроченный период
  • allownosuitable — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если нет свободных ресурсов или нет в наличии выделенных серверов, услуга будет доступна для заказа
  • suspendperiod — Период автоудаления. Укажите, через сколько дней после остановки неоплаченную услугу необходимо удалить. Если оставить поле пустым, будет действовать политика типа продукта
  • nostopholidays — Выключение услуг по выходным. Позволяет переопределить политику остановки услуг типа продукта
  • changepolicy — Политика смены тарифа. Политика расчетов применяемая при смене тарифа услуги
  • changeprolongpolicy — Продление с. Политика продления услуги на новый тарифный план
  • orderpolicy — Политика заказа доп. ресурсов. Способ расчета стоимости дополнительных ресурсов при заказе в период действия услуги
  • returnpolicy — Политика отказа от доп. ресурсов. Способ расчета суммы возврата при отказе от дополнительных ресурсов в период действия услуги
  • note — Заметки. Служебные заметки к тарифу для сотрудников провайдера
  • orderlink — Ссылка для заказа тарифного плана. Используйте данную ссылку для перехода к заказу с Вашего сайта
  • quickorderlinkbasket — .
  • quickorderlinkpayment — .
  • orderpriority — Сортировка. Приоритет тарифа при сортировке (в прямом порядке)
  • show_addon_image — Отображать иконки ресурсов. Включает возможность настройки и отображение иконок ресурсов при заказе и редактировании услуг
  • description — Описание тарифа.
  • description_markdown — Описание тарифа (markdown).
  • siteinfo — Информация для сайта. Любая служебная информация, требующаяся для интеграции с сайтом
  • label — Метки. Метки тарифа для фильтрации при заказе. Метки указываются с новой строки

Наименование

Функция: pricelist.processing

Результат: список элементов

Подключение к обработчикам тарифного плана

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • orderpriority — Приоритет
  • status — Состояние

Выключить

Функция: pricelist.processing.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить обработчик на одну позицию вверх

Функция: pricelist.processing.up

Переместить обработчик на одну позицию вверх

Уровень доступа: admin

Включить

Функция: pricelist.processing.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.processing.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить обработчик на одну позицию вниз

Функция: pricelist.processing.down

Переместить обработчик на одну позицию вниз

Уровень доступа: admin

Переместить тариф на одну позицию вниз

Функция: pricelist.down

Переместить тариф на одну позицию вниз

Уровень доступа: admin

Скопировать выделенный тариф

Функция: pricelist.clone

Скопировать выделенный тариф

Уровень доступа: admin

Удалить

Функция: pricelist.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

pricelist.filter

Наименование

Функция: pricelist.change

Результат: список элементов

Правила смены тарифа

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Наименование

Функция: pricelist.change.rule

Результат: список элементов

Особые правила смены тарифа

Уровень доступа: admin

  • id — Id
  • fromdate — Дата заказа с
  • todate — Дата заказа до
  • period — Период заказа
  • discount — Скидка, %
Особое правило на смену тарифа

Функция: pricelist.change.rule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.change).
    • elid — уникальный идентификатор (элемент id из функции pricelist.change.rule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.change).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции pricelist.change).
    • elid — уникальный идентификатор (элемент id из функции pricelist.change.rule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • fromdate — Дата заказа с. Начальная дата периода, в которым должна попасть дата заказа услуги для применения к ней правила
  • todate — Дата заказа до. Конечная дата периода, в которым должна попасть дата заказа услуги для применения к ней правила
  • period — Период заказа. На разных периодах заказа (вечный, месяц и т.д.) можно иметь разные правила.
  • discount — Скидка на новый тариф. Укажите скидку в процентах, с которой будет предоставлен новый товар.
Удалить

Функция: pricelist.change.rule.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.change.rule.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: pricelist.change.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.change.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: pricelist.change.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelist.change.

Результат: успешное выполнение операции или сообщение об ошибке

Почтовые уведомления


Функция: emailnotify

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

  • servertype — Тип почтового сервера. Тип почтового сервера через который будут отправляться почтовые уведомления
  • smtpserver — Адрес SMTP-сервера. Укажите адрес SMTP-сервера, с которого будет происходит отправка оповещений
  • smtpuser — Учетная запись . Укажите имя учетной записи (имя пользователя или полный адрес электронной почты, например, example@mail.com)
  • smtppassword — Пароль. Введите пароль
  • smtpport — Порт SMTP-сервера. Укажите порт, на котором работает SMTP-сервер, по умолчанию — 25-й порт
  • sendername — Имя отправителя. Имя отправителя которое по умолчанию будет добавляться в письма
  • servername_param — Имя сервера. Укажите доменное имя сервера, которое будет использоваться в почтовом сообщении
  • type_auth — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений об успешной авторизации в панели
  • type_geoip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений модуля отслеживания региона по IP-адресу. Если отключить данную опцию, будет остановлена работа всего модуля GeoIP
  • type_recovery — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений модуля восстановления пароля. Если отключить данную опцию, будет остановлена работа всего модуля восстановления пароля
  • type_dnssec — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений от расширения DNSSEC dns-сервера.

Входящие сообщения


Функция: gateway_message

Результат: список элементов

Входящие сообщения

Уровень доступа: admin

  • id — Id
  • name — Тема
  • sender — Отправитель
  • date_post — Дата получения
  • reason_code — Тип сообщения
  • identifier — Шлюз
  • project — Провайдер

Удалить

Функция: gateway_message.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway_message.

Результат: успешное выполнение операции или сообщение об ошибке

Входящее сообщение

Функция: gateway_message.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции gateway_message)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции gateway_message)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Тема. Тема сообщения
  • error_message — Сообщение об ошибке. Ошибка, из-за которой данное сообщение было помещено в список входящих
  • message — .
  • action — Действие. Действие, которое необходимо выполнить
  • account — Клиент. Клиент, от имени которого пришло сообщение
  • project — Провайдер. Провайдер, на отдел которого будет назначен запрос. Если клиент не был подключен к провайдеру, будет произведено его подключение
  • department — Отдел. Отдел, на который будет назначен запрос

Удалить сообщения и пометить отправителя как спам

Функция: gateway_message.spam

Удалить сообщения и пометить отправителя как спам

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway_message.

Результат: успешное выполнение операции или сообщение об ошибке

Все запросы


Функция: ticket_all

Результат: список элементов

Все запросы

Уровень доступа: admin

  • id — Id
  • name — Тема
  • client — Клиент
  • date_start — Дата создания
  • last_message — Последнее сообщение
  • last_activity — Последняя активность
  • responsible — Ответственный
  • project_name — Провайдер
  • tstatus — Статус
  • props — Свойства

Войти в панель с правами пользователя

Функция: ticket_all.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: ticket_all.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Наименование

Функция: ticket_all.message

Результат: список элементов

Список сообщений запроса

Уровень доступа: admin

  • id — Id
  • message — Сообщение
  • date_post — Дата написания
  • message_user — Автор

Запрос

Функция: ticket_all.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции ticket_all)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции ticket_all)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

  • name — Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item — Услуга. Услуга, к которой относится запрос
  • ticket_project_select — Провайдер. Провайдер, к которому относится тема запроса
  • client_department — Отдел. Отдел провайдера, в который будет передан запрос
  • item — Услуга. Услуга, к которой относится запрос
  • client_priority — Приоритет. Приоритет запроса
  • priority — Приоритет. Приоритет запроса
  • message — .
  • show_optional — необязательный параметр. Чтобы включить данную опцию используйте значение "on". Будут отображены дополнительные настройки запроса. Например, этот параметр используется, чтобы создать запрос с вложенным файлом. Передать файл можно только путём локального вызова cURL на сервере. Методом REST API нельзя передать файл в обращение.

    Пример команды "Создание запроса с вложенным файлом"

    curl -F 'auth=authkey' -F 'func=ticket_all.edit' -F 'subject=test' -F 'ticket_account=3' -F 'message=hello' -F 'out=json' -F 'sok=ok' -F 'show_optional=on' -F 'file_1=@/usr/local/mgr5/cgi/test_out.txt' -k https://domain.com:1500/billmgr
    CODE

    Вместо 'auth=authkey' можно использовать 'authinfo=login:pass'

  • note_message — .
  • ticket_expense — Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count — Обращения в поддержку. Количество "обращений в поддержку" списанных за запрос. При увеличении указанного количества будут списаны дополнительные "обращения", при уменьшении разница будет возвращена клиенту
  • show_abuse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score — Количество баллов. Количество баллов за нарушение
  • action — Действие. Укажите какое действие необходимо выполнить по достижению установленного срока устранения нарушения, в случае отсутствия реакции от клиента
  • deadline_date — Дата устранения нарушения. Срок устранения нарушения, дата
  • deadline_time — Время устранения нарушения. Срок устранения нарушения, время
  • score_note — Комментарий. Комментарий к нарушению

Добавить запрос в избранные и отслеживать историю по нему

Функция: ticket_all.favorite

Добавить запрос в избранные и отслеживать историю по нему

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket_all.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить запрос из системы

Функция: ticket_all.delete

Удалить запрос из системы

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket_all.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

ticket_all.filter

Модули


Функция: plugin

Уровень доступа: root admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

Страны


Функция: country

Результат: список элементов

Страны

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • iso2 — ISO2
  • phonecode — Телефонный код
  • status — Состояние

Страна

Функция: country.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции country)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции country)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование страны
  • iso2 — ISO2. Двух или пяти-буквенный код страны или региона
  • phonecode — Телефонный код. Телефонный код страны
  • phoneformat — Формат номера телефона. Формат номера телефона задается при помощи маски, без указания телефонного кода. Символ '9' в маске обозначает цифру от 0 до 9. В квадратных скобках можно указать количество необязательных знаков. Например, при маске 99-99-99 телефон может состоять из пяти или из шести цифр без учета кода.
  • doctype — Типы документов. Типы документов доступные для компаний из этой страны

Наименование

Функция: country.state

Результат: список элементов

Регионы

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • iso — ISO код

Удалить

Функция: country.state.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.state.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование региона

Функция: country.state.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • elid — уникальный идентификатор (элемент id из функции country.state)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • elid — уникальный идентификатор (элемент id из функции country.state)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование региона
  • iso — ISO код. ISO код региона

Выключить

Функция: country.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: country.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: country.profileparam

Результат: список элементов

Параметры плательщиков и компаний

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • profiletype — Статус плательщика
  • page — Блок
  • locale_hint — Описание
  • orderpriority — Сортировка (в прямом порядке)
  • props — Свойства

Переместить на одну позицию вверх

Функция: country.profileparam.up

Переместить на одну позицию вверх

Уровень доступа: admin

Включить

Функция: country.profileparam.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.profileparam.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить на одну позицию вниз

Функция: country.profileparam.down

Переместить на одну позицию вниз

Уровень доступа: admin

Удалить

Функция: country.profileparam.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.profileparam.

Результат: успешное выполнение операции или сообщение об ошибке

Сброс настроек параетров плательщиков и компаний

Функция: country.profileparam.restoredefault

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • elid — уникальный идентификатор (элемент id из функции country.profileparam)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • elid — уникальный идентификатор (элемент id из функции country.profileparam)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Выключить

Функция: country.profileparam.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.profileparam.

Результат: успешное выполнение операции или сообщение об ошибке

Параметр

Функция: country.profileparam.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • elid — уникальный идентификатор (элемент id из функции country.profileparam)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции country).
    • elid — уникальный идентификатор (элемент id из функции country.profileparam)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование параметра
  • hint — Подсказка.
  • intname — Внутреннее имя. Внутреннее наименование параметра. Значение должно быть уникальным
  • page — Блок. В каком информационном блоке будет находиться это поле
  • inputtype — Тип поля ввода. Укажите данные какого типа будут вводиться в поле
  • required — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить пустое значение для параметра
  • manual_validate_not_required — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Флаг отключает требование заполнения параметра для ручной верификации плательщика
  • profiletype — Статус плательщика. Параметр будет доступен для выбранных типов плательщиков
  • orderpriority — Сортировка (в прямом порядке). Позволяет задать приоритет поля при сортировке
  • readonly_client — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Установите флаг, если необходимо запретить изменение значения поля клиентом, после того как он уже совершил платеж
  • requiredonpay — На шаге оплаты. Выберите политику отображения поля при оплате на шаге заполнения информации о плательщике. Если не настроено, то отображение поля будет зависеть от встроенных в BILLmanager настроек
  • inputtype — Тип поля ввода. Укажите данные какого типа будут вводиться в поле
  • zoom — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает возможность ввода нескольких значений, разделенных пробелом. Выбранный валидатор будет применен к каждому значению в отдельности
  • inputrows — Количество строк ввода. Укажите количество строк ввода в текстовом поле
  • required — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить пустое значение для параметра
  • validator — Функция проверки. Выберите функцию проверки введенного значения. Это не позволит пользователю ввести значение в неправильном формате
  • select_ip — Тип адреса. Тип IP-адреса
  • num_range — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Диапазон допустимых значений
  • r_start_int — Начало диапазона. Начальное значение диапазона
  • r_end_int — Конец диапазона. Конечное значение диапазона
  • r_start_float — Начало диапазона. Начальное значение диапазона
  • r_end_float — Конец диапазона. Конечное значение диапазона

Включить

Функция: country.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции country.

Результат: успешное выполнение операции или сообщение об ошибке

Договоры


Функция: contract

Результат: список элементов

Договоры

Уровень доступа: admin user

  • id — Id
  • number — Номер
  • signdate — Дата заключения
  • senddate — Дата отправки
  • end_date — Срок действия
  • client_name — Плательщик
  • company_name — Компания
  • contract_name — Вид договора
  • contracttype — Тип договора
  • status — Состояние

Выставить договору статус "отправлен", а так же дату отправки, если она еще не была установлена

Функция: contract.status.3

Выставить договору статус "отправлен", а так же дату отправки, если она еще не была установлена

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции contract.

Результат: успешное выполнение операции или сообщение об ошибке

Аннулировать договор

Функция: contract.status.5

Аннулировать договор

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции contract.

Результат: успешное выполнение операции или сообщение об ошибке

Подписать договор

Функция: contract.status.4

Подписать договор

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции contract.

Результат: успешное выполнение операции или сообщение об ошибке

Скачать документ в формате PDF

Функция: contract.print.pdf

Скачать документ в формате PDF

Уровень доступа: admin user

Удалить

Функция: contract.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции contract.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: contract.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установка фильтра.

contract.filter

Установить фильтр по клиенту

Функция: contract.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Распечатать конверт для отправки договора почтой

Функция: contract.envelope

Распечатать конверт для отправки договора почтой

Уровень доступа: admin user

Запросить оригинал договора

Функция: contract.request

Запросить оригинал договора

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции contract.

Результат: успешное выполнение операции или сообщение об ошибке

Договор

Функция: contract.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции contract)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции contract)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • number — Номер. Номер договора
  • signdate — Дата заключения договора. Дата заключения договора
  • senddate — Дата отправки. Дата отправки договора клиенту
  • companycontract — Вид договора. Выберите образец договора, создается в меню "Компании -> Договоры"
  • status — Состояние. Выбор состояния договора
  • profile — Плательщик. Введите Id плательщика, для которого необходим договор

Открыть версию для печати

Функция: contract.print

Открыть версию для печати

Уровень доступа: admin user

Промо-акции


Функция: promotion

Результат: список элементов

Промо-акции

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • fromdate — Дата начала
  • todate — Дата окончания
  • status — Состояние
  • project_name — Провайдер

Наименование

Функция: promotion.archived

Результат: список элементов

Архив промо-акций

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • fromdate — Дата начала
  • todate — Дата окончания
  • status — Состояние
  • project_name — Провайдер

Наименование

Функция: promotion.discount

Результат: список элементов

Скидки

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • actiontype — Действует на
Удалить

Функция: promotion.discount.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.discount.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование скидки

Функция: promotion.discount.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • elid — уникальный идентификатор (элемент id из функции promotion.discount)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • elid — уникальный идентификатор (элемент id из функции promotion.discount)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип скидки. Способ предоставления скидки
  • percentage — Скидка. Скидка в % на стоимость услуги/товара
  • actiontype — Действует. Выберите на что действует скидка. Обратите внимание, что скидка на продление не будет действовать на тарифы с ежедневным списанием
  • period — Период заказа. Период заказа, на который распространяется скидка
  • validity — Срок действия. Выберите, как будет действовать скидка: без ограничений на весь период заказа или только на часть.
  • validitylength — Срок действия, месяцев. Укажите на сколько месяцев будет действовать скидка

Наименование

Функция: promotion.condition

Результат: список элементов

Условия

Уровень доступа: admin

  • id — Id
  • condition — Условие
  • cgroup — Группа условий
Удалить

Функция: promotion.condition.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.condition.

Результат: успешное выполнение операции или сообщение об ошибке

Условие участия в промо-акции

Функция: promotion.condition.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • elid — уникальный идентификатор (элемент id из функции promotion.condition)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • elid — уникальный идентификатор (элемент id из функции promotion.condition)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • ctype — Условие. Условие, по которому будет проверяться применимость акции для клиента
  • comparison — Сравнение. Условие сравнения значения
  • period — Период. Период заказа
  • periodtype — Тип периода. Тип указываемого периода
  • periodlength — Длина периода. Длина указываемого периода
  • amount — Количество. Количество услуг выбранного типа или тарифного плана
  • currency — Валюта. Валюта расчетов
  • summa — Сумма. Сумма в выбранной валюте
  • affiliate — Реферальная программа. Клиенты, пришедшие по выбранной реферальной программе, будут участвовать в промо-акции
  • account_group — Группа клиентов. Для возможности воспользоваться промо акцией клиент должен состоять в выбранной группе
  • group — Группа условий. Вы можете группировать условия. Условия в группе будут объединены оператором ИЛИ. Группы между собой связаны по оператору И. Пример: есть условия A, B и С объединенные в одну группу и есть условия D и E объединенные в другую группу. Итоговое выражение тогда будет — (A ИЛИ B ИЛИ С) И (D ИЛИ E)
  • groupname — Имя группы. Введите имя группы условий

Наименование

Функция: promotion.promocode

Результат: список элементов

Промокоды

Уровень доступа: admin

  • id — Id
  • code — Промокод
  • uselimit — Лимит использования
  • use_count — Использован, Раз
Удалить

Функция: promotion.promocode.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.promocode.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: promocode.usage

Результат: список элементов

Список активаций промокодов

Уровень доступа: admin

  • id — Код услуги
  • account — Клиент
  • status — Состояние
  • expense — Расходы
Редактирование промокода

Функция: promotion.promocode.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • elid — уникальный идентификатор (элемент id из функции promotion.promocode)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции promotion.archived).
    • elid — уникальный идентификатор (элемент id из функции promotion.promocode)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • code — Промокод. Шаблон промокода. При генерации значени символы "?" (знак вопроса) будут заменены случайными значениями.
  • count — Количество кодов. При генерации нескольких промокодов укажите необходимое количество
  • uselimit — Лимит использования. Укажите, сколько раз можно использовать одинаковый промокод
  • account_uselimit — Лимит использования на клиента. Укажите, сколько раз клиент может использовать одинаковый промокод
  • onlydigit — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При генерации случайных значений будут использоваться только цифры
  • active_time_type — Период возможной активации промокода. Период, в который промокод может быть активирован
  • fromdate — С даты. Дата, с которой начинается период действие промокода
  • todate — По дату. Дата, по которую действует промокод
  • expiretype — Срок действия скидки по промокоду. Скидка по промокоду будет действовать в течение указанного периода
  • periodtype — Тип периода. Тип указываемого периода
  • periodlength — Длина периода. Длина указываемого периода

Наименование

Функция: promotion.promocode.usage

Результат: список элементов

Список активаций промокодов

Уровень доступа: admin

  • promocode — Промокод
  • id — Код услуги
  • account — Клиент
  • status — Состояние
  • expense — Расходы

Наименование изменено с "_old_value " на " new_value_"

Функция: promotion.history

Результат: список элементов

История изменений промо-акции

Уровень доступа: admin

  • changedate — Дата изменения
  • desc — Описание
  • user — Пользователь
  • ip — IP-адрес
  • action — Функция

Удалить

Функция: promotion.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование промо-акции

Функция: promotion.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции promotion)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции promotion)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • project — Провайдер. Провайдер промо-акции
  • fromdate — Срок действия с даты. Начало периода действия промо-акции
  • todate — по дату. Окончание периода действия промо-акции (включительно указанную дату)

Переместить выбранные промо-акции в архив

Функция: promotion.archive

Переместить выбранные промо-акции в архив

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции promotion.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

promotion.filter

Расходы


Функция: expense

Результат: список элементов

Расходы

Уровень доступа: admin user

  • id — Id
  • locale_name — Наименование
  • account — Клиент
  • realdate — Дата списания
  • cdate — Дата
  • amount — Сумма
  • notpayd — Не оплачено
  • discountamount — Сумма скидки
  • payments — Оплачено платежами
  • discount — Код скидки
  • taxamount — Налог

Установить фильтр по клиенту

Функция: expense.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Установка фильтра.

expense.filter

Войти в панель с правами пользователя

Функция: expense.su

Войти в панель с правами пользователя

Уровень доступа: admin

Редактирование раcхода

Функция: expense.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции expense)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции expense)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • subaccount — Провайдер. Выберите провайдера
  • item — Услуга. Выберите услугу, за которую будет создан расход
  • operation — Операция. Операция, на основании которой будет расход
  • amount — Сумма. Сумма расхода
  • taxrate — Ставка налога. Процент налогов. Обратите внимание, что сумма налога включена в сумму расхода. Поэтому сумма налога будет высчитана по формуле СУММА — (СУММА / ((100 + СТАВКА) / 100))
  • postpaid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если опция установлена, то при нехватке средств на счете расход будет создан в долг
  • name — Наименование. Вы можете указать собсвенное наименование. Если вы не укажете наименование, то наименование будет сгенерировано автоматически на основе операции.
  • realdate — Дата. Фактическая дата списания
  • cdate — Дата оказания услуги. Дата, с которой начинается оказание услуги

Удалить

Функция: expense.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции expense.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: expense.payment

Результат: список элементов

Распределение суммы расхода по платежам

Уровень доступа: admin user

  • payment — Код платежа
  • payment_number — Платеж
  • amount_iso — Сумма
  • invoice — Код акта
  • invoice_number — Акт

Редактирование распределения

Функция: expense.payment.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции expense).
    • elid — уникальный идентификатор (элемент payment из функции expense.payment)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции expense).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции expense).
    • elid — уникальный идентификатор (элемент payment из функции expense.payment)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • payment — Платеж. Платеж, с которого будет списана часть суммы расхода
  • amount — Сумма. Сумма, которая будет списана с платежа

Удалить

Функция: expense.payment.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент payment из функции expense.payment.

Результат: успешное выполнение операции или сообщение об ошибке

Сопутствующие товары


Функция: buymore

Результат: список элементов

Сопутствующие товары

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • orderpriority — Сортировка
  • status — Состояние

Поднять приоритет показа товара

Функция: buymore.up

Поднять приоритет показа товара

Уровень доступа: admin

Выключить

Функция: buymore.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции buymore.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: buymore.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции buymore.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: buymore.condition

Результат: список элементов

Условия

Уровень доступа: admin

  • id — Id
  • condition — Условие
  • conditiongroup — Группа

Удалить

Функция: buymore.condition.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции buymore.condition.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование условия

Функция: buymore.condition.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции buymore).
    • elid — уникальный идентификатор (элемент id из функции buymore.condition)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции buymore).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции buymore).
    • elid — уникальный идентификатор (элемент id из функции buymore.condition)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип. Тип условия
  • group — Группа условий. Условия в группе будут объединены оператором ИЛИ. Группы между собой связаны по оператору И. Пример: есть условия A, B и С объединенные в одну группу и есть условия D и E объединенные в другую группу. Итоговое выражение тогда будет — (A ИЛИ B ИЛИ С) И (D ИЛИ E)
  • groupname — Имя группы. Введите имя группы условий

Снизить приоритет показа товара

Функция: buymore.down

Снизить приоритет показа товара

Уровень доступа: admin

Удалить

Функция: buymore.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции buymore.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование сопутствующего товара

Функция: buymore.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции buymore)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции buymore)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • project — Провайдер. Предложение будет отображаться клиентам только выбранного провайдера
  • language — Язык. Предложение будет отображаться только клиентам с выбранным языком. Если не выбран ни один язык, то предложение будет показываться всем клиентам
  • link — Функция. Какую функцию позвать при нажатии
  • description — Описание. HTML описание продукта
  • orderpriority — Сортировка. Порядок отображения товара в корзине

Защита от мошенничества


Функция: fraud_setting

Результат: список элементов

Настройка защиты от мошенничества

Уровень доступа: admin

  • id — Id
  • name — Провайдер
  • status — Состояние

Провайдер

Функция: fraud_setting.pricelist

Результат: список элементов

Настройка защиты от мошенничества

Уровень доступа: admin

  • id — Id
  • name — Провайдер
  • status — Состояние

Периоды, для которых будет активна проверка

Функция: period

Периоды, для которых будет активна проверка

Уровень доступа: admin

Включить

Функция: fraud_setting.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции fraud_setting.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: fraud_setting.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции fraud_setting.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Очередь уведомлений


Функция: notifytask

Результат: список элементов

Очередь уведомлений

Уровень доступа: admin

  • id — Id
  • modulename — Имя модуля
  • filename — Файл
  • createdate — Дата создания
  • priority — Приоритет
  • status — Состояние

Информация о уведомлении

Функция: notifytask.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции notifytask)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции notifytask)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • err_info — Ошибка:. Ошибка возникшая при отправке уведомления

Удалить

Функция: notifytask.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notifytask.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

notifytask.filter

Зарег. лицензии


Функция: softregistration

Результат: список элементов

Зарегистрированные лицензии

Уровень доступа: admin user

  • id — Id
  • soft — Код лицензии
  • pricelist — Тип лицензии
  • ip — IP-адрес
  • account — Клиент
  • owner_account — Владелец лицензии

Установка фильтра.

softregistration.filter

Установить фильтр по клиенту

Функция: softregistration.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Войти в панель с правами пользователя

Функция: softregistration.su

Войти в панель с правами пользователя

Уровень доступа: admin

История регистраций лицензии

Функция: softregistration.history

История регистраций лицензии

Уровень доступа: admin

Написать запрос клиенту

Функция: ticket.write.softregistration

Написать запрос клиенту

Уровень доступа: admin

Объявления


Функция: infoboard

Результат: список элементов

Объявления

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • schedule — Расписание
  • orderpriority — Сортировка
  • status — Состояние

Редактирование объявления

Функция: infoboard.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции infoboard)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции infoboard)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • blocking — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Объявление блокирует доступ к запросам. Клиент не может написать новый запрос и не может добавить сообщение в существующий запрос
  • orderpriority — Сортировка. Порядок отображения подходящих объявлений
  • timezone — Часовой пояс. Выберите часовой пояс, который будет использоваться для дат начала и окончания работ
  • start_date — Дата начала работ. Дата в формате YYYY-MM-DD
  • start_time — Время начала работ. Время в формате HH:MM
  • end_date — Планируемая дата окончания работ. Дата в формате YYYY-MM-DD
  • end_time — Планируемое время окончания работ. Время в формате HH:MM
  • subject — Заголовок. Заголовок сообщения, который будет отображаться в банере
  • message — Сообщение. Текст сообщения, который будет отображаться при нажатии кнопки подробнее. Можно использовать макросы:
    %USER% — ФИО пользователя клиента
    %SERVICE% — наименования услуг клиента, перечисленные через запятую

Наименование

Функция: infoboard.condition

Результат: список элементов

Условия

Уровень доступа: admin

  • id — Id
  • condition — Условие

Редактирование условия

Функция: infoboard.condition.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции infoboard).
    • elid — уникальный идентификатор (элемент id из функции infoboard.condition)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции infoboard).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции infoboard).
    • elid — уникальный идентификатор (элемент id из функции infoboard.condition)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип. Тип условия

Удалить

Функция: infoboard.condition.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции infoboard.condition.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: infoboard.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции infoboard.

Результат: успешное выполнение операции или сообщение об ошибке

Снизить приоритет показа объявления. Блокирующие объявления имеют приоритет над неблокирующими

Функция: infoboard.down

Снизить приоритет показа объявления. Блокирующие объявления имеют приоритет над неблокирующими

Уровень доступа: admin

Поднять приоритет показа объявления. Блокирующие объявления имеют приоритет над неблокирующими

Функция: infoboard.up

Поднять приоритет показа объявления. Блокирующие объявления имеют приоритет над неблокирующими

Уровень доступа: admin

Графики работы


Функция: working_plan

Результат: список элементов

Графики работы отделов

Уровень доступа: admin

  • id — Id
  • name — Наименование

Удалить

Функция: working_plan.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции working_plan.

Результат: успешное выполнение операции или сообщение об ошибке

График работы

Функция: working_plan.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции working_plan)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции working_plan)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование графика для отображения в списках
  • day_active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
  • day_0_allday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • day_0_begin — .
  • day_0_end — .
  • day_active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
  • day_1_allday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • day_1_begin — .
  • day_1_end — .
  • day_active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
  • day_2_allday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • day_2_begin — .
  • day_2_end — .
  • day_active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
  • day_3_allday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • day_3_begin — .
  • day_3_end — .
  • day_active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
  • day_4_allday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • day_4_begin — .
  • day_4_end — .
  • day_active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
  • day_5_allday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • day_5_begin — .
  • day_5_end — .
  • day_active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Учитывать ли данный день недели в качестве рабочего дня
  • day_6_allday — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • day_6_begin — .
  • day_6_end — .

Наименование

Функция: working_plan.day

Результат: список элементов

Выходные дни и корректировки рабочего времени

Уровень доступа: admin

  • id — Id
  • affected_date — Дата
  • description — Описание

Изменение настроек исключения

Функция: working_plan.day.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип. Тип исключения из рабочего графика
  • day_begin — Время начала. Время начала рабочего дня
  • day_end — Время окончания. Время окончания рабочего дня
  • note — Комментарий. Комментарий к исключению из рабочего графика

Копирование настроек исключения

Функция: working_plan.day.copy

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • plan — Скопировать из. Укажите график рабочего времени, из которого нужно скопировать исключения
  • first_day — Начиная датой. Укажите дату, начиная с которой будут скопированы исключения
  • last_day — Заканчивая датой. Укажите дату, заканчивая которой будут скопированы исключения

Создание

Функция: working_plan.day.create

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции working_plan).
    • elid — уникальный идентификатор (элемент id из функции working_plan.day)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • affected_date — Дата. Дата или даты, для которых действует исключение. При указании диапазона дат можно использовать разделитель ' — ', например '2001-01-01 — 2001-01-31'. Каждое значение вводится с новой строки
  • type — Тип. Тип исключения из рабочего графика
  • day_begin — Время начала. Время начала рабочего дня
  • day_end — Время окончания. Время окончания рабочего дня
  • note — Комментарий. Комментарий к исключению из рабочего графика

Удалить

Функция: working_plan.day.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции working_plan.day.

Результат: успешное выполнение операции или сообщение об ошибке

Печать акта сверки


Функция: profile.reconciliation

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

  • company — Компания. Выберите компанию, для которой необходимо распечатать акт сверки
  • currency — Валюта. Выберите валюту акта сверки
  • fromdate — Начальная дата. Укажите начальную дату расчетного периода
  • todate — Конечная дата. Укажите конечную дату расчетного периода
  • prepair_invoice — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) В печатную форму будет добавлена информация об актах выполненных работ со статусом "Предварительный"

Документооборот


Функция: docflow_connection

Результат: список элементов

Документооборот

Уровень доступа: admin

  • id — Id
  • company — Компания
  • module — Модуль подключения

Удалить

Функция: docflow_connection.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции docflow_connection.

Результат: успешное выполнение операции или сообщение об ошибке

Отправить документы стоящие в очереди на отправку, а так же получить статусы уже отправленных документов

Функция: docflow_connection.doc_sync

Отправить документы стоящие в очереди на отправку, а так же получить статусы уже отправленных документов

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции docflow_connection.

Результат: успешное выполнение операции или сообщение об ошибке

Плательщик

Функция: docflow_connection.counteragent

Результат: список элементов

Список контрагентов

Уровень доступа: admin

  • id — Id
  • name — Плательщик
  • vatnum — ИНН
  • status — Состояние

Выключить

Функция: docflow_connection.counteragent.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции docflow_connection.counteragent.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: docflow_connection.counteragent.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции docflow_connection.counteragent.

Результат: успешное выполнение операции или сообщение об ошибке

Функция: docflow_connection.counteragent.docflow_box

Уровень доступа: admin

Загрузка списка контрагентов

Функция: docflow_connection.customer_search_all

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции docflow_connection).
    • elid — уникальный идентификатор (элемент id из функции docflow_connection.counteragent)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции docflow_connection).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции docflow_connection).
    • elid — уникальный идентификатор (элемент id из функции docflow_connection.counteragent)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Обновление списка контрагентов

Функция: docflow_connection.customer_sync_all

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции docflow_connection).
    • elid — уникальный идентификатор (элемент id из функции docflow_connection.counteragent)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции docflow_connection).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции docflow_connection).
    • elid — уникальный идентификатор (элемент id из функции docflow_connection.counteragent)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Наименование

Функция: docflow_connection.docflow_box

Результат: список элементов

Ящики

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • box_id — Код ящика
  • status — Состояние

Включить

Функция: docflow_connection.docflow_box.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции docflow_connection.docflow_box.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование подключения

Функция: docflow_connection.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции docflow_connection)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции docflow_connection)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • profile — Компания. Компания подключенная к электронному документообороту
  • module — Модуль подключения. Модуль подключения к электронному документообороту
  • document_type — Тип документов. Тип отправляемых документов по умолчанию
  • group_items — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Позиции УПД будут сгруппированы по тарифному плану, периоду оплаты и сумме позиции
  • autoassign — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Автоматически искать в системе электронного документооборота плательшика при подключении к компании

Создать

Функция: docflow_connection.add

Создать

Уровень доступа: admin

Шлюзы сообщений


Функция: gateway

Результат: список элементов

Шлюзы отправки и получения сообщений

Уровень доступа: admin

  • id — Id
  • module — Тип шлюза
  • gateway_type — Назначение шлюза
  • identifier — Идентификатор
  • project — Провайдер
  • status — Состояние

Параметры шлюза

Функция: gateway.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции gateway)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции gateway)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • gateway_type — Использовать для. Тип использования шлюза
  • user — Отдел. Отдел, на который будут назначаться запросы, полученные на указанный почтовый адрес
  • abuse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает перемещение полученных сообщений в раздел нарушений
  • active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать шлюз

Создание шлюза

Функция: gateway.create

Создание шлюза

Уровень доступа: admin

Включить

Функция: gateway.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: gateway.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway.

Результат: успешное выполнение операции или сообщение об ошибке

Удаление шлюза

Функция: gateway.delete

Удаление шлюза

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway.

Результат: успешное выполнение операции или сообщение об ошибке

Открытые запросы


Функция: ticket_open

Результат: список элементов

Открытые запросы

Уровень доступа: admin

  • id — Id
  • name — Тема
  • client — Клиент
  • date_start — Дата создания

Закрыть запрос (удалить из очереди)

Функция: ticket_open.delete

Закрыть запрос (удалить из очереди)

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket_open.

Результат: успешное выполнение операции или сообщение об ошибке

Запрос

Функция: ticket_open.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции ticket_open)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции ticket_open)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item — Услуга. Услуга, к которой относится запрос
  • ticket_project_select — Провайдер. Провайдер, к которому относится тема запроса
  • client_department — Отдел. Отдел провайдера, в который будет передан запрос
  • item — Услуга. Услуга, к которой относится запрос
  • client_priority — Приоритет. Приоритет запроса
  • priority — Приоритет. Приоритет запроса
  • message — .
  • show_optional — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message — .
  • ticket_expense — Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count — .
  • show_abuse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score — Количество баллов. Количество баллов за нарушение
  • action — Функция.
  • deadline_date — .
  • deadline_time — .
  • score_note — Комментарий. Комментарий к нарушению

SSL-сертификаты


Функция: certificate

Результат: список элементов

SSL cертификаты

Уровень доступа: admin user

  • id — Id
  • CN — Домен
  • account — Клиент
  • pricelist — Тариф
  • project — Провайдер
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Перезапуск обработки сертификата

Функция: certificate.retry

Перезапуск обработки сертификата

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Перевыпуск сертификата

Функция: certificate.reissue

Перевыпуск сертификата

Уровень доступа: admin user

Включить

Функция: certificate.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: certificate.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Заказать сертификат

Функция: certificate.order

Заказать сертификат

Уровень доступа: user

Открытие услуги

Функция: certificate.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции certificate)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции certificate)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • crt — Сертификат. DER представление сертификата
  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Войти в панель с правами пользователя

Функция: certificate.su

Войти в панель с правами пользователя

Уровень доступа: admin

Получение статуса сертификата

Функция: certificate.sync

Получение статуса сертификата

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

certificate.filter

Удалить выделенные записи

Функция: certificate.delete

Удалить выделенные записи

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Сертификат

Функция: certificate.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции certificate)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции certificate)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • service_status — .
  • custom_order_id — Идентификатор. Идентификатор сертификата в центре выдачи
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов
  • CN — Домен. Если сертификат защищает 1 домен, введите www.example.com.

Если он защищает поддомены, укажите как *.example.com Если вы покупаете мультидоменный сертификат, введите 1 домен вида www.example.com. Дополнительные домены вы введете на следующем шаге.

  • field_country — Страна. Выберите страну из списка
  • ST — Регион. Укажите регион — область, край, республика, город федерального значения и т.д. Допускается использование только символов латиницы
  • L — Город или местность. Укажите город или местность, которая будет отображена в сертификате. Допускается использование только символов латиницы
  • O — Организация. Укажите полное название организации так, как оно указано в Свидетельстве о регистрации юридического лица либо ФИО, если сертификат будет выписан на физическое лицо. Для сертификатов с расширенной проверкой (EV) также необходимо указать юридическую форму. Допускается использование только символов латиницы
  • OU — Подразделение. Укажите подразделение организации, если необходимо. Допускается использование только символов латиницы

emailAddress — Email. Укажите контактный Email, если вы хотите что бы он отображался в свойствах сертификата

Скачивание сертификата

Функция: certificate.file

Уровень доступа: admin.

Функция для скачивания файлов сертификата.

Параметры:

  • elid — уникальный идентификатор (элемент id из функции certificate)
  • Type — тип файла, может принимать значения: csr, key.

Редактирование сертификата/запроса на сертификат

Функция: certificate.file.edit

Уровень доступа: admin.

Функция для скачивания файлов сертификата.

Параметры:

  • elid — уникальный идентификатор (элемент id из функции certificate)
  • type — тип файла, может принимать значения: csr, crt.
  • data — новые данные сертификата, если type = crt или новые данные запроса, если type = csr.

Модули ISPsystem


Функция: addition

Результат: список элементов

Модули ISPsystem

Уровень доступа: admin user

  • item — Лицензия
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Заказать новую услугу

Функция: addition.order

Заказать новую услугу

Уровень доступа: user

Открытие услуги

Функция: addition.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции addition)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции addition)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Выключить

Функция: addition.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции addition.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить выделенные услуги

Функция: addition.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции addition.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: addition.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Редактирование услуги

Функция: addition.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции addition)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции addition)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Включить

Функция: addition.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции addition.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

addition.filter

Войти в панель с правами пользователя

Функция: addition.su

Войти в панель с правами пользователя

Уровень доступа: admin

SSL ключи


Функция: sslkey

Результат: список элементов

SSL ключи

Уровень доступа: user

  • server — Адрес панели
  • user — Пользователь
  • cert — Сертификат
  • start — Дата создания
  • expire — Дата окончания
  • props — Свойства

Вы можете скачать ключ. Данная операция может быть выполнена только один раз. После скачивания, файл ключа будет удален

Функция: sslkey.download

Вы можете скачать ключ. Данная операция может быть выполнена только один раз. После скачивания, файл ключа будет удален

Уровень доступа: user

Новый SSL ключ

Функция: sslkey.edit

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент key из функции sslkey)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент key из функции sslkey)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • server — Адрес панели. Различные адреса панели могут использовать различные SSL сертификаты для авторизации. Новый ключ будет действителен только для сертификата, используемого на данном адресе
  • self — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Вы можете создать ключ для текущего пользователя или для любого другого пользователя, владельцем которого является текущий
  • username — Имя пользователя. Введите имя пользователя, для которого вы намереваетесь создать ключ. Вы должны быть владельцем этого пользователя
  • type — Действие. Вы можете создать новый ключ, использовать уже существующий, использовать текущий ключ (в случае, если для текущего подключения вы использовали ключ, не зарегистрированный в панели) или получить подписанный сертификат, чтобы сформировать ключ вручную
  • name — Имя ключа. Произвольное имя, которое будет отображаться при выборе сертификата
  • period — Срок действия (дней). Новый ключ будет действителен в течении указанного количества дней начиная с текущего дня
  • passwd — . Пароль, которым будет закрыт созданный SSL ключ
  • confirm — Подтверждение.
  • subject — Имя ключа. Укажите имя имеющегося у вас ключа. Внимание, ваш ключ должен быть подписан сертификатом, указанным в настройках HTTP сервера
  • request — Запрос SSL сертификата. В этом случае вы получите подписанный сертификат, для того, чтобы сформировать ключ, вам необходимо запаковать его в формате PKCS#12. Например, это может быть сделано следующей командой: openssl pkcs12 -export -in my.crt -inkey my.key -certfile ca.crt -out my.p12 -passout pass:ваш пароль

Удалить

Функция: sslkey.delete

Удалить

Уровень доступа: user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции sslkey.

Результат: успешное выполнение операции или сообщение об ошибке

Контакты доменов


Функция: service_profile

Результат: список элементов

Контакты доменов

Уровень доступа: user

  • id — Id
  • name — Наименование
  • profiletype — Тип контакта
  • spusage — Использование
  • fullname — Имя
  • domains -

Удалить

Функция: service_profile.delete

Удалить

Уровень доступа: user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции service_profile.

Результат: успешное выполнение операции или сообщение об ошибке

Копии документов

Функция: service_profile.doc

Копии документов

Уровень доступа: user

Дата-центры


Функция: datacenter

Результат: список элементов

Дата-центры

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • orderpriority — Сортировка

Переместить на одну позицию вниз

Функция: datacenter.down

Переместить на одну позицию вниз

Уровень доступа: admin

Дата-центр

Функция: datacenter.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции datacenter)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции datacenter)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • orderpriority — Порядок сортировки. Порядок сортировки дата-центров

Переместить на одну позицию вверх

Функция: datacenter.up

Переместить на одну позицию вверх

Уровень доступа: admin

Удалить

Функция: datacenter.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции datacenter.

Результат: успешное выполнение операции или сообщение об ошибке

Сторонние лицензии


Функция: softexternal

Результат: список элементов

Сторонние лицензии

Уровень доступа: admin user

  • licname — Название лицензии
  • ip — IP-адрес
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Войти в панель с правами пользователя

Функция: softexternal.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: softexternal.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Включить

Функция: softexternal.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции softexternal.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

softexternal.filter

Открытие услуги

Функция: softexternal.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции softexternal)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции softexternal)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Редактирование услуги

Функция: softexternal.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции softexternal)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции softexternal)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Выключить

Функция: softexternal.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции softexternal.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить выделенные услуги

Функция: softexternal.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции softexternal.

Результат: успешное выполнение операции или сообщение об ошибке

Заказать новую услугу

Функция: softexternal.order

Заказать новую услугу

Уровень доступа: user

Компании


Функция: company

Результат: список элементов

Компании

Уровень доступа: admin

  • id — Id
  • name — Наименование

Создать

Функция: company.add

Создать

Уровень доступа: admin

Наименование

Функция: company.project

Результат: список элементов

Обслуживаемые провайдеры

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Включить

Функция: company.project.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции company.project.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: company.project.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции company.project.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: company.contract

Результат: список элементов

Образцы договоров

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • contracttype — Тип договора
  • doctmpl_name — Шаблон

Наименование

Функция: company.contract.appendix

Результат: список элементов

Образцы приложения для договора

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • doctmpl_name -
Редактирование образца приложения

Функция: company.contract.appendix.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции company.contract).
    • elid — уникальный идентификатор (элемент id из функции company.contract.appendix)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции company.contract).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции company.contract).
    • elid — уникальный идентификатор (элемент id из функции company.contract.appendix)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование образца приложения к договору
  • project — Провайдер. При наличие услуг у выбранного провайдера у клиента появится приложение
  • itemtype — Тип продукта. При наличии услуг выбранного типа у клиента появится данное приложение
  • nocheck — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отключает необходимость наличия услуг указанного типа у клиента, для генерации приложения к договору
  • doctmpl — Шаблон. Шаблон приложения к договору. Создается и редактируется в резделе 'Шаблоны документов'
Удалить

Функция: company.contract.appendix.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции company.contract.appendix.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование образца договора

Функция: company.contract.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции company).
    • elid — уникальный идентификатор (элемент id из функции company.contract)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции company).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции company).
    • elid — уникальный идентификатор (элемент id из функции company.contract)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Вид договора. Наименование вида образца договора
  • contracttype — Тип договора. Выберите тип договора
  • accepttype — Порядок принятия оферты. Порядок принятия и отображения оферты клиентом
  • itemtype — Типы продуктов. Договор будет предложен для подписания, если у клиента будут услуги соответствующих типов
  • accountgroup — Группа клиентов. Группа клиентов, которой будет доступен данный договор
  • profiletype — Статус плательщика. Юридический статус плательщика
  • doctmpl — Шаблон договора. Шаблон договора. Создается и редактируется в резделе 'Шаблоны документов'
  • suffix — Суффикс в номере договора. Добавляется к номеру договора при его создании. Номер договора формируется в виде КОД_ПЛАТЕЛЬШИКА + СУФФИКС. Т.е. для плательщика с кодом 1 при суффиксе '/договор', номер договора будет выглядеть как '1/договор'
  • start_date — Дата начала действия. Дата, с которой вступает в силу договор. Срок действия договора с клиентом выбирается по наибольшему значению: дата создания плательщика клиета в BILLmanager, дата основания компании, для которой создан образец договора, дата начала действия договора
  • end_date — Дата окончания действия. После указанной даты договор перестанет генерироваться клиентам автоматически

Удалить

Функция: company.contract.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции company.contract.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: company.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции company.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование компании

Функция: company.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции company)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции company)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование компании
  • email — Email. Основной Email компании
  • www — URL сайта. URL сайта компании. Может быть использован в шаблонах печати документов
  • fax — Факс. Номер факса
  • phone — Телефон. Контактный номер телефона
  • payment_description — Назначение авансового платежа. Будет отображаться в качестве наименования авансового платежа в списке платежей
  • country_legal — Страна. Страна регистрации компании
  • state_legal — Регион. Регион регистрации компании
  • postcode_legal — Индекс. Индекс, по адресу регистрации компании
  • city_legal — Город. Город регистрации компании
  • address_legal — Адрес. Адрес регистрации компании. Включает в себя улицу, дом и номер офиса при наличии
  • country_physical — Страна. Страна физического размещения
  • state_physical — Регион. Регион физического размещения
  • postcode_physical — Индекс. Индекс для физического адреса размещения
  • city_physical — Город. Город физического размещения
  • address_physical — Адрес. Адрес физического размещения. Включает в себя улицу, дом и номер офиса/квартиры при наличии
  • regdate — Дата основания. Дата основания компании
  • locale — Локализация документов. Язык, на котором выписываются документы
  • doctmpl_payment — Шаблон счета. Шаблон печати счета, выставленного компанией. Может быть переопределен в настройках метода оплаты
  • numtmpl_payment — Шаблон номера счета. Шаблон формирования номера счета, можно использовать макросы {id} — код платежа и {num} — порядковый номер платежа, получателем которого является компания. При отсутствии обоих макросов в шаблоне номера счета к шаблону будет добавлен макрос {num}
  • nextnum_payment — Следующий порядковый номер счета. Следующий порядковый номер платежа, получаетелем которого является компания. Учитывается только при условии заполнения шаблона номера счета и не заполненном шаблоне у метода оплаты
  • doctmpl_invoice — Шаблон акта. Шаблон печати акта выполненых работ, выставленного компанией
  • numtmpl_invoice — Шаблон номера акта. Шаблон формирования номера акта, можно использовать макросы {id} — код акта и {num} — порядковый номер акта, выписанного от имени компании. При отсутствии обоих макросов в шаблоне номера счета к шаблону будет добавлен макрос {num}
  • nextnum_invoice — Следующий порядковый номер акта. Следующий порядковый номер акта, выписанного от имени компании. Учитывается только при условии заполнения шаблона номера акта
  • doctmpl_envelope — Шаблон конверта. Шаблон печати конверта для отправки корреспонденции
  • doctmpl_reconciliation — Шаблон акта сверки. Выберите шаблон акта сверки. Создать или отредактировать его можно в меню "Шаблоны документов". Если не задать шаблон, то клиентам будет недоступна возможность создания акта сверки.
  • sendcostcurrency — Валюта стоимости отправки документов. Укажите валюту, в которой указана стоимость отправки актов сверки.
  • sendcost — Стоимость отправки. Стоимость отправки акта сверки почтой. На указанную сумму при отправке акта будет создан расход

Блокировка регистрации


Функция: blacklist

Результат: список элементов

Список блокировки регистраций

Уровень доступа: admin

  • id — Id
  • type — Тип блокировки
  • name — Фильтр

Удалить

Функция: blacklist.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции blacklist.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование фильтра блокировки регистрации

Функция: blacklist.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции blacklist)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции blacklist)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип.
  • ip — Адрес сети. Определенный IP-адрес или адрес сети в формате x.x.x.x/x или ::/x. При добалении в список блокировки можно указать несколько значений через пробел
  • domain — Домен email адреса. Доменное имя почтового сервера или домен верхнего уровня, адреса в котором будут недоступны для использования при регистрации. При добавлении доменов в список блокировки можно указать несколько доменов через пробел

Правила возврата


Функция: refundrule

Результат: список элементов

Правила возврата средств клиенту

Уровень доступа: admin

  • id — Id
  • name — Наименование

Свойства правила

Функция: refundrule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции refundrule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции refundrule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование правила возврата
  • fixedsum — Сумма комиссии. Укажите фиксированную сумму комиссии. Сумма указывается в валюту счета, с которого будет производиться вывод средств. При использовании фиксированной суммы и % порядок расчета комиссии будет зависить от настройки правила
  • percent — % от суммы возврата. Укажите, какой % от суммы возврата будет списан в счет комиссии
  • calcorder — Порядок расчета. Укажте порядок расчета суммы комиссии. % + сумма — сначала будет расчитан % от выводимой суммы, к ней будет прибавлена фикссированная сумма комиссии; сумма + % — сначала от выводимой суммы будет отнята фиксированная сумма комисси, после чего от остатка будет расчитан %
  • expensename — Наименование расхода. Укажите наименование расхода, которое будет указано при списании комиссии

Удалить

Функция: refundrule.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции refundrule.

Результат: успешное выполнение операции или сообщение об ошибке

Рассылки


Функция: notificationlist

Результат: список элементов

Рассылки

Уровень доступа: admin

  • id — Id
  • subject — Заголовок
  • type — Тип уведомления
  • selectclients — Сегмент клиентов
  • project — Провайдер
  • status — Состояние
  • progress — Прогресс

Включить автоматическую отправку рассылки

Функция: notificationlist.resume

Включить автоматическую отправку рассылки

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить выбранные рассылки в архив

Функция: notificationlist.archive

Переместить выбранные рассылки в архив

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.

Результат: успешное выполнение операции или сообщение об ошибке

Имя

Функция: notificationlist.users

Результат: список элементов

Рассылку получили

Уровень доступа: admin

  • name — Имя
  • senddate — Дата

Создать

Функция: notificationlist.create

Создать

Уровень доступа: admin

Наименование

Функция: notificationlist.archived

Результат: список элементов

Архив рассылок

Уровень доступа: admin

  • id — Id
  • subject — Заголовок
  • type — Тип уведомления
  • selectclients — Сегмент клиентов
  • project — Провайдер

Просмотр архивной рассылки

Функция: notificationlist.archived.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции notificationlist).
    • elid — уникальный идентификатор (элемент id из функции notificationlist.archived)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции notificationlist).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции notificationlist).
    • elid — уникальный идентификатор (элемент id из функции notificationlist.archived)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • selectclients — Сегмент клиентов. Выберите, по каким условиям должны быть отобраны клиенты для уведомления
  • template — Шаблон уведомления. Шаблон, на основе которого будет сгенерировано итоговое сообщение
  • lang — Язык пользователя. Выберите, необходимо или нет точное соответствие языка клиента
  • subject — Заголовок. Заголовок уведомления
  • summary — Аннотация. Введите текст аннотации, которая будет отображаться в списке уведомлений в BILLmanager 6
  • message — Текст уведомления. Введите текст уведомления, которое будет отправлено клиентам

Удалить

Функция: notificationlist.archived.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.archived.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование рассылки

Функция: notificationlist.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции notificationlist)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции notificationlist)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • selectclients — Сегмент клиентов. Выберите, по каким условиям должны быть отобраны клиенты для уведомления
  • template — Шаблон уведомления. Шаблон, на основе которого будет сгенерировано итоговое сообщение
  • unsubscribed — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправить рассылку клиентам, отписавшимся от новостных уведомелений
  • lang — Язык пользователя. Выберите, необходимо или нет точное соответствие языка клиента
  • email_from — Обратный адрес. На этот адрес будут приходить ответы клиентов на рассылку
  • repeat_period — Период повтора. Как часто рассылать сообщение клиентам, в днях
  • send_now — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сообщение будет сразу отправлено адресатам
  • active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Активные рассылки отправляются автоматически
  • check — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправить письмо с рассылкой на email тестирования
  • test_email — Email тестирования. Введите адрес электронной почты на который будет отправлено тестовое письмо
  • subject — Заголовок. Заголовок уведомления
  • summary — Аннотация. Введите текст аннотации, которая будет отображаться в списке уведомлений в BILLmanager 6
  • message — Текст уведомления. Введите текст уведомления, которое будет отправлено клиентам

Имя

Функция: notificationlist.check

Результат: список элементов

Аудитория рассылки

Уровень доступа: admin

  • id — Id
  • name — Имя
  • account — Клиент

Отправка сообщения

Функция: notificationlist.send

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции notificationlist)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции notificationlist)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Выключить автоматическую отправку рассылки

Функция: notificationlist.suspend

Выключить автоматическую отправку рассылки

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: notificationlist.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.

Результат: успешное выполнение операции или сообщение об ошибке

Клиенты


Функция: account

Результат: список элементов

Клиенты

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • project — Провайдер
  • balance — Баланс
  • account_status — Статус клиента
  • tz_registration_date — Дата регистрации
  • status — Свойства

Регистрация клиента

Подробнее см. в статье Интеграция с сайтом.

Чтобы зарегистрировать клиента в BILLmanager, выполняется перенаправление пользователя с сайта на форму регистрации:

Регистрация в BILLmanager

https://DOMAIN/billmgr?func=register
XML

Для регистрации клиента на сайте, без перехода в BILLmanager, используется функция register, удаленный вызов которой зарегистрирует клиента в биллинговой платформе. Функция имеет следующие параметры:

  • sok со значением ok — признак сохранения данных;
  • email — логин и E-mail нового клиента;
  • passwd — пароль нового клиента;
  • realname — ФИО клиента;
  • phone — номер телефона;
  • conditions_agree со значением on, если для регистрации необходимо принятие условий использования;
  • offer_xxx со значение on, если используется принятие договора-оферты при регистрации;
  • country — код страны в соответствии со справочником BILLmanager, необязательный параметр;
  • state — код страны в соответствии со справочником BILLmanager, необязательный параметр;
  • project — код провайдера. В редакции "BILLmanager" имеет значение 1;
  • recovery со значением on, если необходимо в письме о регистрации отправить клиенту ссылку на сброс пароля;
  • _ga — код привязки к Google Analytics, необязательный параметр;
  • partner — при использовании реферальной программы сайт должен запоминать 'PARTNER_ID' (код партнера), если клиент пришел по реферальной ссылке. Обычно этот параметр сохраняют в cookies;
  • sesid — если используется реферальная программа. Идентификатор клика;
  • tzoffset — смещение часового пояса клиента относительно GMT, необязательный параметр, в BILLmanager выставляется через JavaScirpt.

Написать запрос клиенту

Функция: ticket.write.account

Написать запрос клиенту

Уровень доступа: admin

Наименование

Функция: account.payment

Результат: список элементов

Платежи

Уровень доступа: admin

  • id — Id
  • number — Номер
  • create_date — Дата
  • pay_date — Дата оплаты
  • sender_name — Плательщик
  • recipient_name — Получатель
  • project — Провайдер
  • account_name — Клиент
  • paymethod_name — Метод оплаты
  • subaccountamount_iso — Сумма
  • paymethodamount_iso — Сумма в валюте платежа
  • status — Статус

Свойства платежа

Функция: payment.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.payment)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.payment)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • number — Номер счета. Номер счета для оплаты
  • createdate — Дата и время создания. Дата и время создания счета на оплату
  • paydate — Дата оплаты. Дата оплаты счета или зачисления платежа
  • documentnumber — № платежного документа. № платежного документа
  • documentdate — Дата платежного документа. Дата платежного документа
  • description — Назначение платежа. Назначение платежа
  • sender — Плательщик. Плательщик клиента, от имени которого совершена оплата
  • subaccountamount — Сумма платежа. Сумма платежа, зачисляемая на счет клиента
  • usedamount — Израсходовано. Сумма израсходованных средств
  • paymethodamount — Сумма в валюте платежа. Сумма в валюте платежной системы
  • commissionamount — Комиссия. Комиссия, добавляемая к сумме платежа при оплате
  • taxamount_readonly — Налог. Сумма налога
  • status — Статус платежа. Статус платежа
  • paymethod — Метод оплаты. Метод оплаты
  • restrictrefund — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запретить возврат средств с данного платежа
  • info — Информация о платеже. Дополнительная информация о платеже, полученная от платежной системы
  • note — Комментарий. Комментарий сотрудника

Зачислить платеж на лицевой счет клиента

Функция: payment.setpaid

Зачислить платеж на лицевой счет клиента

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.payment.

Результат: успешное выполнение операции или сообщение об ошибке.
Пример API вызова для зачисления платежа на лицевой счет клиента:

Пример API вызова

https://<адрес BILLmamager>?authinfo=username:password&elid=3&func=payment.setpaid&out=xml
CODE

Отправить счёт на e-mail

Функция: payment.send

Отправить счёт на e-mail

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.payment.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

account.payment.filter

Отмена платежа

Функция: payment.refund

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.payment)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.payment)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • amount — Сумма возврата. Сумма в валюте метода оплаты, которая будет возвращена клиенту
  • description — Причина возврата. Причина возврата для передачи в платежную систему

Наименование

Функция: payment.history

Результат: список элементов

История изменения платежа с номером

Уровень доступа: admin

  • changedate — Дата изменения
  • desc — Изменение
  • user — Пользователь
  • ip — IP-адрес
  • action — Функция

Вывод информации о платежа в виде удобном для печати

Функция: payment.print

Вывод информации о платежа в виде удобном для печати

Уровень доступа: admin

Скачать документ в формате PDF

Функция: payment.print.pdf

Скачать документ в формате PDF

Уровень доступа: admin

Наименование

Функция: payment.expense

Результат: список элементов

Распределение суммы расхода по платежам

Уровень доступа: admin

  • expense — Код расхода
  • expense_locale_name — Расход
  • amount_iso — Сумма
  • invoice — Код акта
  • invoice_number — Акт
Редактирование распределения

Функция: payment.expense.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment).
    • elid — уникальный идентификатор (элемент expense из функции payment.expense)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment).
    • elid — уникальный идентификатор (элемент expense из функции payment.expense)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • expense — .
  • amount — Сумма. Сумма, которая будет списана с платежа
Удалить

Функция: payment.expense.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент expense из функции payment.expense.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить выбранные платежи. Доступно только для еще неоплаченных платежей

Функция: payment.delete

Удалить выбранные платежи. Доступно только для еще неоплаченных платежей

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.payment.

Результат: успешное выполнение операции или сообщение об ошибке

Создать

Функция: payment.add

Создать

Уровень доступа: admin user

Наименование

Функция: payment.orderinfo

Результат: список элементов

Содержание счета

Уровень доступа: admin

  • id — Id
  • info — Предмет счета
  • cost — Стоимость
Изменение содержания счета

Функция: payment.orderinfo.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment).
    • elid — уникальный идентификатор (элемент id из функции payment.orderinfo)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account.payment).
    • elid — уникальный идентификатор (элемент id из функции payment.orderinfo)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Описание. Описание позиции счета

Написать запрос клиенту

Функция: ticket.write.payment

Написать запрос клиенту

Уровень доступа: admin

Наименование

Функция: account.group

Результат: список элементов

Группы клиента

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Статус

Включить

Функция: account.group.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.group.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: account.group.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.group.

Результат: успешное выполнение операции или сообщение об ошибке

Лицевые счета

Функция: subaccount

Результат: список элементов

Лицевые счета

Уровень доступа: admin

  • id — Id
  • project — Провайдер
  • balance — Баланс
  • creditlimit — Кредитный лимит
  • status — Состояние

Редактирование лицевого счета

Функция: subaccount.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции subaccount)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции subaccount)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • subaccount_project — Провайдер. Провайдер создаваемого счета
  • subaccount_currency — Валюта. Валюта создаваемого счета
  • allowpostpaid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает возможность клиенту оплачивать с данного счета услуги в долг и производить оплату услуг по факту их использования
  • creditlimit — Кредитный лимит. Кредитный лимит позволяет клиенту уходить в долг в пределах указанной суммы
  • referer — Привлечен клиентом. Укажите код клиента, который привел клиента по реферальной программе
  • active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Счет клиента активен. У клиента может быть только один активный счет у провайдера
  • incident_limit — Максимальное использование обращений в поддержку клиентом. Лимит использования обращений в поддержку клиентом за все время

Выключить

Функция: subaccount.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции subaccount.

Результат: успешное выполнение операции или сообщение об ошибке

Вывод средств со счета

Функция: subaccount.refund

Вывод средств со счета

Уровень доступа: admin

Включить

Функция: subaccount.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции subaccount.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: account.discount

Результат: список элементов

Скидки

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • actiontype — Действует на
  • project — Провайдер
  • discount_type — Тип скидки
  • period — Срок действия

Создать

Функция: account.discount.add

Создать

Уровень доступа: admin

Удалить

Функция: account.discount.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ".

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование скидки

Функция: account.discount.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент idname из функции account.discount)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент idname из функции account.discount)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

  • fromdate — С даты. Первый день действия скидки
  • todate — По дату. Последний день действия скидки
  • type — Тип скидки. Способ предоставления скидки
  • percentage — Скидка. Скидка в % на стоимость услуги/товара
  • priority — Приоритет скидки. По умолчанию скидки заданные клиенту персонально имеют больший приоритет чем скидки указанные в промо-акциях. Если задать скидке отрицательный приоритет, то она будет применена, только при отсутствии подходящих скидок из промо-акций
  • actiontype — Действует. Выберите на что действует скидка. Обратите внимание, что скидка на продление не будет действовать на тарифы с ежедневным списанием
  • period — Период заказа. Период заказа, на который распространяется скидка
  • note — Комментарий. Комментарий к скидке

Отправка СМС сообщения

Функция: account.sms

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции account)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции account)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Выбор номера телефона. Тип номера телефона, на который будет отправлено сообщение
  • phone — Номер. Номер телефона, на который будет отправлено сообщение
  • message — Сообщение. Отправляемое сообщение

Установить фильтр по клиенту

Функция: account.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Установка фильтра.

account.filter

Наименование

Функция: account.currencyrate

Результат: список элементов

Курс валют

Уровень доступа: admin

  • id — Id
  • currency_base — Валюта
  • rate — Курс
  • ratedate — Дата курса

Курс валют

Функция: account.currencyrate.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.currencyrate)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.currencyrate)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • currency_base — Базовая валюта. Базовая валюта, в которую проводится конвертация
  • currency_relate — Конвертируемая валюта. Валюта, которая конвертируется в базовую
  • rate — Курс. Значение курса влюты на указанную дату за указанное количество единиц
  • amount — Количество. Количество единиц базовой валюты, за которое указан курс конвертации
  • ratedate — Дата. Дата с которой действует курс

Удалить

Функция: account.currencyrate.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.currencyrate.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: subaccount.expense

Результат: список элементов

Расходы

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • realdate — Дата
  • cdate — Дата
  • amount — Сумма
  • notpayd — Не оплачено
  • discountamount — Сумма скидки
  • payments — Оплачено платежами
  • discount — Код скидки
  • taxamount — Налог

Установка фильтра.

subaccount.expense.filter

Редактирование раcхода

Функция: subaccount.expense.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции subaccount.expense)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции subaccount.expense)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • subaccount — Провайдер. Выберите провайдера
  • item — Услуга. Выберите услугу, за которую будет создан расход
  • operation — Операция. Операция, на основании которой будет расход
  • amount — Сумма. Сумма расхода
  • taxrate — Ставка налога. Процент налогов. Обратите внимание, что сумма налога включена в сумму расхода. Поэтому сумма налога будет высчитана по формуле СУММА — (СУММА / ((100 + СТАВКА) / 100))
  • postpaid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если опция установлена, то при нехватке средств на счете расход будет создан в долг
  • name — Наименование. Вы можете указать собсвенное наименование. Если вы не укажете наименование, то наименование будет сгенерировано автоматически на основе операции.
  • realdate — Дата. Фактическая дата списания
  • cdate — Дата оказания услуги. Дата, с которой начинается оказание услуги

Удалить

Функция: subaccount.expense.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции subaccount.expense.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: account.taxrule

Результат: список элементов

Ставки налогов

Уровень доступа: admin

  • id — Id
  • type — Тип
  • project — Провайдер
  • company — Компания
  • country — Страна плательщика
  • taxrate — Ставка налога
  • itemtype — Тип продукта

Удалить правило

Функция: account.taxrule.delete

Удалить правило

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.taxrule.

Результат: успешное выполнение операции или сообщение об ошибке

Специальное правило

Функция: account.taxrule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.taxrule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции account).
    • elid — уникальный идентификатор (элемент id из функции account.taxrule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • project — Провайдер. Наименование провайдера
  • taxrate — Ставка налога. Укажите налоговую ставку для выбранной страны
  • specialitemtype — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Налогообложению подвергаются не все типы продуктов
  • itemtype — Типы продуктов. Укажите какие типы продуктов облагаются налогами

Редактирование информации о клиенте

Функция: account.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции account)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции account)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • email — Email. Email адрес клиента, также будет использоваться как логин для авторизации в BILLmanager
  • verify_email — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • project — Провайдер. Провайдер, к которому будет привязан клиент
  • country — Страна. Страна клиента
  • state — Регион. Выберите регион
  • realname — Контактное лицо. ФИО клиента или контактного лица организации, для которой создается учетная запись
  • name — Наименование. Наименование клиента
  • settingurl — URL настроек. URL получения настроек панелями ISPmanager
  • valid_phone — Проверенный номер телефона. Проверенный номер телефона клиента
  • try_phone — Номер телефона. Номер телефона клиента
  • label — Метка. Служебная информация, доступная в фильтре
  • selfview — Свое пространство имен. Позволяет подменить указываемые в настройках панели сервера имен
  • passwd — . Пароль доступа в личный кабинет
  • confirm — Подтверждение.
  • products_page — Страница. Страница
  • registration_date — Дата регистрации. Дата регистрации
  • registration_ip — IP-адрес регистрации. IP-адрес, с которого произведена регистрация клиента
  • attitude — Характеристика клиента. Характеристика клиента
  • employee — Сотрудник. Сотрудник, зарегистрировавший клиента
  • nocalcstat — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Услуги клиента не будут отображаться в статистике
  • note — Комментарий. Комментарий к клиенту
  • notify — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправить клиенту уведомление о регистрации в BILLmanager
  • recovery — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Добавить в уведомление данные для сброса пароля

Войти в панель с правами пользователя

Функция: account.su

Войти в панель с правами пользователя

Уровень доступа: admin

Удалить

Функция: account.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: account.project

Результат: список элементов

Провайдеры, доступные клиенту

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Статус

Включить

Функция: account.project.resume

Включить

Уровень доступа: admin

Параметры:

  • plid — уникальный идентификатор родительского списка (элемент id из функции user).
  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.project.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: account.project.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции account.project.

Результат: успешное выполнение операции или сообщение об ошибке

Профиль клиента


Функция: clientoption

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

Провайдеры


Функция: project

Результат: список элементов

Провайдеры

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • currency_str — Валюта
  • site — URL сайтa
  • billurl — URL биллинга

Восстановление

Функция: project.support

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции project)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции project)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • support_require — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает использование платных обращений в поддержку
  • new_account_count — Количество новым клиентам. Количество доступных обращений в поддержку, начисляемое при подключении к провайдеру
  • first_payment_count — Количество за первый платеж. Количество доступных обращений в поддержку, начисляемых за первый платеж
  • first_expense_count — Количество за первое списание. Количество доступных обращений в поддержку, начисляемых за первое списание средств с лицевого счета
  • paid_amount_count — Количество при оплате. Количество доступных обращений в поддержку, начисляемое при оплате
  • paid_amount_amount — Сумма пополнения. Сумма пополнения
  • support_over_limit — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает сотрудникам провайдера списывать с клиента обращения "в долг". При превышении лимита клиент не сможет писать сообщения в поддержку до погашения долга по обращениям

Удалить

Функция: project.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование провайдера

Функция: project.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции project)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции project)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование провайдера, используется в уведомлениях, а также при формировании имени счета клиентов
  • notifyemail — Email для отправки уведомлений. Email адрес, с которого будут отправляться уведомления
  • supportemail — Email поддержки. Используется в сообщениях об активации пользователя/плательщика и восстановлении пароля
  • site — URL сайтa. URL адрес Вашего сайта. Может быть ипользован в уведомлениях, отправляемых клиентам
  • billurl — URL биллинга. URL адрес доступа к BILLmanager. Может быть использован в уведомлениях, отправляемых клиентам
  • clienthelp — URL справки. URL страницы, которая будет открыта при выборе пункта меню "Вызов справки" в интерфейсе пользователя. Макрос {lang} позволяет открывать разные страницы в зависимости от выбранной у клиента локализации
  • currency — Валюты. Используемые валюты счетов
  • country_default — Страна по умолчанию. Страна клиентов по умолчанию. Используется в случае невозможности определить страну по IP адресу или по сохраненному значению
  • state_default — Регион по умолчанию. Регион клиентов по умолчанию. Используется в случае невозможности определить регион по сохраненному значению
  • billmgr6 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить пользовательский интерфейс BILLmanager 6
  • def_billmgr6 — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) BILLmanager 6 будет отображаться клиентам по умолчанию
  • disable_orion — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отключить клиентам возможность возврата в старый интерфейс
  • disable_banner — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отключить предупреждение для нового пользователя о тестировании пользовательского интерфейса BILLmanager 6
  • supportphone — Телефон поддержки. Телефон поддержки для отображения клиенту в интерфейсе BILLmanager 6
  • supportphonedesc — Описание телефона. Описание, которое будет отображаться под номером телефона в интерфейсе BILLmanager 6
  • head_bill6 — Заголовок. Указанный в данном поле код будет добавлен в заголовок (HEAD) для клиента в новой теме
  • body_bill6 — Тело. Указанный в данном поле код будет добавлен в тело (BODY) для клиента в новой теме
  • licenseserverprovider — Сервер лицензий. Укажите сервер лицензий для заказа панелей управления к услугам
  • autoassignitem — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включении данной опции клиентам при присоединении к провайдеру будет автоматически и бесплатно назначаться выбранная услуга
  • autoassignpricelist — Тариф. Тариф подключаемой услуги
  • autoassignperiod — Период. Период, на который подключается услуга
  • closeaccounts — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает закрытие счетов клиентов по прошествию выбранного промежутка времени
  • period_lenght — Период бездействия. Укажите период, по прошествию которого будут закрываться счета клиентов
  • period_type — Тип периода. Тип периода
  • description — Описание расхода. Описание расхода
  • activeitem — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает закрытие счетов клиентов даже при наличии активных услуг
  • ga_counter — Tracking ID. Google Analytics Tracking ID
  • ga_userid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает отправку в Google код клиента в качестве User ID
  • ga_type — Тип экспорта. Строить экспорт по расходам или по услугам. По расходам — выгружается информация о всех расходах совершенных клиентами. По услугам — по каждой услуге заказанной клиентом выгрузка происходит только один раз, не зависимо от того сколько по ней было расходов
  • ga_trial — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает возможность выгрузки информации о триальных услуги
  • recaptcha_type — reCAPTCHA на форме регистрации. Настройка использования reCAPTCHA на форме регистрации для провайдера
  • recaptcha_publickey — Ключ. Публичный ключ сервиса reCAPTCHA
  • recaptcha_privatekey — Секретный ключ. Секретный ключ сервиса reCAPTCHA
  • recaptcha_auth_type — reCAPTCHA на форме авторизации. Настройка использования reCAPTCHA на форме авторизации для провайдера
  • recaptcha_auth_publickey — Ключ. Публичный ключ сервиса reCAPTCHA
  • recaptcha_auth_privatekey — Секретный ключ. Секретный ключ сервиса reCAPTCHA
  • ym_counter — Код счетчика. Id счетчика для Яндекс.Метрики
  • support_require — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает использование платных обращений в поддержку
  • new_account_count — Количество новым клиентам. Количество доступных обращений в поддержку, начисляемое при подключении к провайдеру
  • first_payment_count — Количество за первый платеж. Количество доступных обращений в поддержку, начисляемых за первый платеж
  • first_expense_count — Количество за первое списание. Количество доступных обращений в поддержку, начисляемых за первое списание средств с лицевого счета
  • paid_amount_count — Количество при оплате. Количество доступных обращений в поддержку, начисляемое при оплате
  • paid_amount_amount — Сумма пополнения. Сумма пополнения
  • support_over_limit — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает сотрудникам провайдера списывать с клиента обращения "в долг". При превышении лимита клиент не сможет писать сообщения в поддержку до погашения долга по обращениям

Включить

Функция: project.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: project.currency

Результат: список элементов

Валюты доступные у провайдера

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • iso — ISO
  • status — Состояние

Выключить

Функция: project.currency.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.currency.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: project.currency.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.currency.

Результат: успешное выполнение операции или сообщение об ошибке

Изменить валюту для новых клиентов по умолчанию

Функция: project.currency.projectdefault

Изменить валюту для новых клиентов по умолчанию

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.currency.

Результат: успешное выполнение операции или сообщение об ошибке

Налоги

Функция: project.taxrule

Результат: список элементов

Правила налогообложения

Уровень доступа: admin

  • id — Id
  • company — Компания
  • country — Страна плательщика
  • taxrate — Ставка налога
  • itemtype — Тип продукта

Удалить правило

Функция: project.taxrule.delete

Удалить правило

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.taxrule.

Результат: успешное выполнение операции или сообщение об ошибке

Настройки налогообложения

Функция: project.taxrule.settings

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.taxrule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.taxrule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • taxexclusive — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включите параметр, если хотите, чтобы цены на товары/услуги увеличивались на величину налога. При этом нельзя будет использовать налоговые ставки с ограничением по компании в которую платит плательщик
  • taxcustompay — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отображать налог при авансовом пополнение счета. В некоторых странах это необходимо, в некоторых нет. Сверьтесь с системой налогообложения в вашей стране.

Редактирование правила

Функция: project.taxrule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.taxrule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.taxrule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • company — Компания.
  • country — Страна плательщика. Выберите страну, для плательщиков которой будет действовать правило налогообложения
  • state — Регион. Если используется двухуровневая система налогообложения, вы можете задать федеральный налог (все) и налог региона. Эти налоги будут суммироваться.
  • taxrate — Ставка налога. Укажите налоговую ставку для выбранной страны
  • specialitemtype — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Налогообложению подвергаются не все типы продуктов
  • itemtype — Типы продуктов. Укажите какие типы продуктов облагаются налогами

Выключить

Функция: project.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.

Результат: успешное выполнение операции или сообщение об ошибке

Группа

Функция: project.group

Результат: список элементов

Группы провайдеров

Уровень доступа: admin

  • id — Id
  • name — Группа
  • status — Состояние

Редактирование группы

Функция: project.group.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.group)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.group)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • allow_same_phone — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция разрешает использовать для верификации учетной записи один и тот же номер телефона на разных учетных записях

Удаление группы

Функция: project.group.delete

Удаление группы

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.group.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: project.group.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.group.

Результат: успешное выполнение операции или сообщение об ошибке

Восстановление

Функция: project.group.resume_ext

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.group)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.group)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Наименование

Функция: project.company

Результат: список элементов

Обслуживающие компании

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Включить

Функция: project.company.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.company.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: project.company.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.company.

Результат: успешное выполнение операции или сообщение об ошибке

Настройка взаимодействия провайдера и компании

Функция: project.company.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.company)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.company)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • payment_description — Назначение авансового платежа. Будет отображаться в качестве наименования авансового платежа в списке платежей

Сервера имен

Функция: project.nsprovider

Результат: список элементов

Провайдеры серверов имён

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Удалить

Функция: project.nsprovider.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.nsprovider.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: project.nsprovider.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.nsprovider.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование провайдера серверов имён

Функция: project.nsprovider.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.nsprovider)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции project).
    • elid — уникальный идентификатор (элемент id из функции project.nsprovider)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование провайдера серверов имён

Включить

Функция: project.nsprovider.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции project.nsprovider.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: project.itemtype

Результат: список элементов

Список типов продуктов

Уровень доступа: admin

  • name — Наименование
  • orderpriority — Приоритет

Переместить тип продукта на одну позицию вверх

Функция: project.itemtype.up

Переместить тип продукта на одну позицию вверх

Уровень доступа: admin

Переместить тип продукта на одну позицию вниз

Функция: project.itemtype.down

Переместить тип продукта на одну позицию вниз

Уровень доступа: admin

Сегменты клиентов


Функция: selectclients

Результат: список элементов

Сегменты клиентов

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • project — Провайдер

Наименование

Функция: selectclients.try

Результат: список элементов

Проверка фильтра

Уровень доступа: admin

  • id — Id
  • name — Наименование

Наименование

Функция: selectclients.archived

Результат: список элементов

Архив сегментов клиентов

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • project — Провайдер

Наименование

Функция: selectclients.rule

Результат: список элементов

Условия

Уровень доступа: admin

  • id — Id
  • rule — Условие
  • rulegroup — Группа
Создать

Функция: selectclients.rule.add

Создать

Уровень доступа: admin

Удалить

Функция: selectclients.rule.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции selectclients.rule.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование условия

Функция: selectclients.rule.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции selectclients.archived).
    • elid — уникальный идентификатор (элемент id из функции selectclients.rule)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции selectclients.archived).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции selectclients.archived).
    • elid — уникальный идентификатор (элемент id из функции selectclients.rule)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Переместить выбранные сегменты в архив

Функция: selectclients.archive

Переместить выбранные сегменты в архив

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции selectclients.

Результат: успешное выполнение операции или сообщение об ошибке

Сегмент клиентов

Функция: selectclients.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции selectclients)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции selectclients)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • project — Провайдер. Провайдер, для которого создается отбор клиентов

Удалить

Функция: selectclients.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции selectclients.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

selectclients.filter

Настройка уведомлений


Функция: mainsubscribe

Результат: список элементов

Настройка уведомлений

Уровень доступа: user

  • type — Тип

Наименование

Функция: subscribe

Результат: список элементов

Настройка уведомлений

Уровень доступа: user

  • notice — Тип сообщения
  • status — Состояние

Выключить

Функция: subscribe.suspend

Выключить

Уровень доступа: user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент notice_id из функции subscribe.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: subscribe.resume

Включить

Уровень доступа: user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент notice_id из функции subscribe.

Результат: успешное выполнение операции или сообщение об ошибке

Загрузка платежей


Функция: paymentupload

Результат: список элементов

Загрузка платежей

Уровень доступа: admin

  • id — Id
  • ppid — № П.П.
  • ppdate — Дата П.П.
  • recipient — Получатель
  • sender — Плательщик
  • amount — Сумма
  • payment — Платеж
  • cnum — № счета
  • cstate — Состояние

Загрузка платежей

Функция: paymentupload.load

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • ignoreinn — Игнорировать платежи от плательщиков со следующими ИНН. Укажите ИНН плательщиков, платежи от которых вы хотите игнорировать

Удалить

Функция: paymentupload.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymentupload.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: paymentupload.su

Войти в панель с правами пользователя

Уровень доступа: admin

Плательщик

Функция: paymentupload.profile

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Зачислить платеж, найденный по загруженным данным

Функция: paymentupload.setpaid

Зачислить платеж, найденный по загруженным данным

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymentupload.

Результат: успешное выполнение операции или сообщение об ошибке

Установить везде фильтр по клиенту, соответвующему найденым платежам

Функция: paymentupload.setfilter

Установить везде фильтр по клиенту, соответвующему найденым платежам

Уровень доступа: admin

Восстановление

Функция: paymentupload.payment

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Платежное поручение

Функция: paymentupload.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paymentupload)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Установка фильтра.

paymentupload.filter

Отчет по IP-адресу


Функция: report.mvd

Уровень доступа: admin

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

  • statdate — Дата. Дата
  • ip_or_domain — Тип данных. Вести поиск по IP или по Домену
  • ip — IP-адрес. Введите IP-адрес для поиска
  • domain — Домен. Введите домен для поиска

Автоплатеж


Функция: payment.recurring.settings

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

Валюты


Функция: currency

Результат: список элементов

Валюты

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • iso — ISO код
  • code — ISO номер
  • status — Состояние

Наименование

Функция: currency.relate

Результат: список элементов

Отношения валют

Уровень доступа: admin

  • relate — Наименование
  • iso — Код
  • ratedate — Дата последнего обновления
  • rate — Текущий курс
  • status — Автоматическая загрузка валют

Наименование

Функция: currencyrate

Результат: список элементов

Динамика курса

Уровень доступа: admin

  • id — Id
  • ratedate — Дата
  • rate — Курс
Значение курса

Функция: currencyrate.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции currency.relate).
    • elid — уникальный идентификатор (элемент id из функции currencyrate)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции currency.relate).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции currency.relate).
    • elid — уникальный идентификатор (элемент id из функции currencyrate)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • ratedate — Дата. Дата с которой действует курс
  • amount — Количество. Количество единиц базовой валюты, за которое указан курс конвертации
  • rate — Курс. Значение курса влюты на указанную дату за указанное количество единиц
Удалить

Функция: currencyrate.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции currencyrate.

Результат: успешное выполнение операции или сообщение об ошибке

Загрузка курса валют

Функция: currencyrate.upload

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции currency.relate).
    • elid — уникальный идентификатор (элемент id из функции currencyrate)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции currency.relate).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции currency.relate).
    • elid — уникальный идентификатор (элемент id из функции currencyrate)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • autoupload — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Курс валют будет загружаться автоматически в указанное время
  • autotime — Время загрузки. Время загрузки указывается в формате чч:мм. Задание обновления курса валют будет запускаться каждый день в указанное время
  • upload — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будет запущен процесс обновления курса валют с указанными параметрами
  • multi — Поправочный коэффициент. Умножить загруженный курс на значение указанное в данном поле
  • sum — Увеличить на. Увеличить загруженный курс на значение указанное в данном поле
  • fromdate — С даты. Будут загружены данные начиная с указанной даты. Если значение не указано, загрузка будет произведена начиная с даты последнего обновления курсов валюты
  • rewrite — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает перезапись значений уже сохраненных в системе при совпадении даты

Включить

Функция: currency.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции currency.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование валюты

Функция: currency.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции currency)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции currency)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование валюты
  • iso — ISO код. ISO код
  • symbol — Символ. UTF символ валюты
  • code — ISO номер. ISO номер

Выключить

Функция: currency.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции currency.

Результат: успешное выполнение операции или сообщение об ошибке

Обновление курсов валют

Функция: currency.upload

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции currency)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции currency)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Удалить

Функция: currency.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции currency.

Результат: успешное выполнение операции или сообщение об ошибке

Группы параметров


Функция: paramgroup

Результат: список элементов

Группы параметров

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • intname — Внутреннее наименование
  • orderpriority — Сортировка

Переместить тип продукта на одну позицию вверх

Функция: paramgroup.up

Переместить тип продукта на одну позицию вверх

Уровень доступа: admin

Переместить тип продукта на одну позицию вниз

Функция: paramgroup.down

Переместить тип продукта на одну позицию вниз

Уровень доступа: admin

Редактирование группы параметров

Функция: paramgroup.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paramgroup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paramgroup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование группы параметров
  • intname — Внутреннее имя. Внутреннее имя группы, которое используется для его идентификации
  • orderpriority — Сортировка. Приоритет типа продукта при сортировке (в прямом порядке)

Удалить

Функция: paramgroup.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paramgroup.

Результат: успешное выполнение операции или сообщение об ошибке

FAQ


Функция: faqgroup

Результат: список элементов

Группы FAQ

Уровень доступа: admin

  • id — Id
  • name — Название

Название

Функция: faq

Результат: список элементов

FAQ

Уровень доступа: admin

  • id — Id
  • subject — Заголовок
  • location — Расположение
  • project — Провайдер
  • orderpriority — Сортировка

Редактирование вопроса FAQ

Функция: faq.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции faqgroup).
    • elid — уникальный идентификатор (элемент id из функции faq)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции faqgroup).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции faqgroup).
    • elid — уникальный идентификатор (элемент id из функции faq)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • creation — Создание вопроса.
  • copyfrom — Скопировать из.
  • project — Провайдер. Наименование провайдера
  • language — Язык. FAQ будет отображаться только у клиентов с выбранным языком в сессии
  • location — Расположение. Расположение
  • orderpriority — Сортировка. Порядок сортировки
  • subject — .
  • type — Тип ответа. Ответ в виде текста или ссылки
  • text — Текст.
  • link — Ссылка. Ссылка на ответ

Переместить на одну позицию вверх

Функция: faq.up

Переместить на одну позицию вверх

Уровень доступа: admin

Удалить

Функция: faq.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции faq.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить на одну позицию вниз

Функция: faq.down

Переместить на одну позицию вниз

Уровень доступа: admin

Архив запросов


Функция: clientticket_archive

Результат: список элементов

Архив запросов

Уровень доступа: user

  • id — Id
  • name — Тема
  • last_message — Последнее сообщение
  • create_user — Автор
  • props — Свойства

Запрос

Функция: clientticket_archive.edit

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции clientticket_archive)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции clientticket_archive)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item — Услуга. Услуга, к которой относится запрос
  • ticket_project_select — Провайдер. Провайдер, к которому относится тема запроса
  • client_department — Отдел. Отдел провайдера, в который будет передан запрос
  • item — Услуга. Услуга, к которой относится запрос
  • client_priority — Приоритет. Приоритет запроса
  • priority — Приоритет. Приоритет запроса
  • message — .
  • show_optional — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message — .
  • ticket_expense — Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count — .
  • show_abuse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score — Количество баллов. Количество баллов за нарушение
  • action — Функция.
  • deadline_date — .
  • deadline_time — .
  • score_note — Комментарий. Комментарий к нарушению

Установка фильтра.

clientticket_archive.filter

Выделенные серверы


Функция: dedic

Результат: список элементов

Выделенные серверы

Уровень доступа: admin user

  • domain — Доменное имя
  • ip — IP-адрес
  • ostempl — Шаблон ОС
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Войти в панель с правами пользователя

Функция: dedic.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установка фильтра.

dedic.filter

Выключить

Функция: dedic.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции dedic.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: dedic.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции dedic)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции dedic)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Заказать новую услугу

Функция: dedic.order

Заказать новую услугу

Уровень доступа: user

Установить фильтр по клиенту

Функция: dedic.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Включить

Функция: dedic.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции dedic.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование услуги

Функция: dedic.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции dedic)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции dedic)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: dedic.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции dedic.

Результат: успешное выполнение операции или сообщение об ошибке

Внешнее FTP хранилище


Функция: storage

Результат: список элементов

Внешнее FTP хранилище

Уровень доступа: admin user

  • addr — FTP сервер
  • processingnode — Узел кластера
  • user — Пользователь
  • quota — Диск (MiB)
  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Войти в панель с правами пользователя

Функция: storage.su

Войти в панель с правами пользователя

Уровень доступа: admin

Удалить выделенные услуги

Функция: storage.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции storage.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: storage.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции storage)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции storage)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Заказать новую услугу

Функция: storage.order

Заказать новую услугу

Уровень доступа: user

Включить

Функция: storage.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции storage.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

storage.filter

Редактирование услуги

Функция: storage.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции storage)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции storage)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Выключить

Функция: storage.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции storage.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: storage.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Группы клиентов


Функция: accountgroup

Результат: список элементов

Группы клиентов

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • props — Параметры

Удалить

Функция: accountgroup.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции accountgroup.

Результат: успешное выполнение операции или сообщение об ошибке

Клиент

Функция: accountgroup.account

Результат: список элементов

Восстановление

Уровень доступа: admin

  • id — Id
  • name — Клиент
  • status — Статус

Включить

Функция: accountgroup.account.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции accountgroup.account.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

accountgroup.account.filter

Выключить

Функция: accountgroup.account.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции accountgroup.account.

Результат: успешное выполнение операции или сообщение об ошибке

Тарифный план

Функция: accountgroup.pricelist

Результат: список элементов

Восстановление

Уровень доступа: admin

  • id — Id
  • name — Тарифный план
  • status — Статус

Установка фильтра.

accountgroup.pricelist.filter

Включить

Функция: accountgroup.pricelist.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции accountgroup.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: accountgroup.pricelist.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции accountgroup.pricelist.

Результат: успешное выполнение операции или сообщение об ошибке

Восстановление

Функция: accountgroup.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции accountgroup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции accountgroup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование группы
  • allowsuspenditem — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции члены данной группы могут приостанавливать и включать свои услуги
  • allowdeleteitem — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции члены данной группы могут удалять свои услуги
  • ignoreitemmax — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции члены данной группы могут создавать любое количество услуг, независимо от настроек тарифа
  • ignoreabuserate — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) При включенной опции к членам данной группы не будут применяться штрафные санкции за нарушения

Имя пользователя

Функция: accountgroup.condition

Результат: список элементов

Условия автовключения в группу

Уровень доступа: admin

  • id — Id
  • condition — Условие
  • conditiongroup — Группа

Условие автовключения в группу

Функция: accountgroup.condition.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции accountgroup).
    • elid — уникальный идентификатор (элемент id из функции accountgroup.condition)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции accountgroup).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции accountgroup).
    • elid — уникальный идентификатор (элемент id из функции accountgroup.condition)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • comparison — Сравнение. Условие сравнения значения
  • country_select — Страны. Список стран
  • country_geoip_select — Страны. Список стран
  • project_select — Провайдер. Провайдер, подключенный при регистрации
  • social_network_select — Соц.сеть. Соц.сеть, через которую произведена регистрация
  • param — Имя параметра. Имя параметра в запросе на регистрацию клиента
  • value — Значение. Значение полученное для параметра указанного выше
  • type — Тип. Тип условия
  • group — Группа условий. Условия в группе будут объединены оператором ИЛИ. Группы между собой связаны по оператору И. Пример: есть условия A, B и С объединенные в одну группу и есть условия D и E объединенные в другую группу. Итоговое выражение тогда будет — (A ИЛИ B ИЛИ С) И (D ИЛИ E)
  • groupname — Имя группы. Введите имя группы условий

Удалить

Функция: accountgroup.condition.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции accountgroup.condition.

Результат: успешное выполнение операции или сообщение об ошибке

Отделы


Функция: department

Результат: список элементов

Отделы

Уровень доступа: admin

  • id — Id
  • locale_name — Наименование
  • orderpriority — Сортировка
  • status — Параметры

Сотрудник

Функция: department.employee

Результат: список элементов

Сотрудники, которые входят в отдел

Уровень доступа: admin

  • id — Id
  • employee — Сотрудник
  • realname — ФИО
  • status — Состояние

Исключить сотрудника из отдела

Функция: department.employee.suspend

Исключить сотрудника из отдела

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции department.employee.

Результат: успешное выполнение операции или сообщение об ошибке

Включить сотрудника в отдел

Функция: department.employee.resume

Включить сотрудника в отдел

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции department.employee.

Результат: успешное выполнение операции или сообщение об ошибке

Создать задачу

Функция: task.simple.create

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции department)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции department)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • specification — Описание. Описание задачи

Наименование

Функция: department.rights

Результат: список элементов

Права

Уровень доступа: admin

  • access — Доступ
  • caption — Наименование
  • access — Доступ

Частично ограничить доступ к элементам списка. Устанавливать фильтр для списка. Отфильтрованные (исключенные) записи будут недоступны

Функция: department.rights.hardfilter

Частично ограничить доступ к элементам списка. Устанавливать фильтр для списка. Отфильтрованные (исключенные) записи будут недоступны

Уровень доступа: admin

Установка фильтра.

department.rights.filter

Включить

Функция: department.rights.resume

Включить

Уровень доступа: admin

Выключить

Функция: department.rights.suspend

Выключить

Уровень доступа: admin

Переместить отдел вверх в списке выбора

Функция: department.up

Переместить отдел вверх в списке выбора

Уровень доступа: admin

Удалить

Функция: department.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции department.

Результат: успешное выполнение операции или сообщение об ошибке

Переместить отдел вниз в списке выбора

Функция: department.down

Переместить отдел вниз в списке выбора

Уровень доступа: admin

Редактирование отдела

Функция: department.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции department)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции department)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование отдела
  • working_plan — График. График работы отдела. Если не установлено, считается что отдел работает 24х7
  • support_department — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включает отображение отдела клиенту при создании запроса
  • language — Локализация задач. Выберите локализацию, в которой будут формироваться автоматически генерируемые сообщения, отображаемые в задачах, назначаемых на данный отдел
  • project — Показывать клиенту у провайдеров. Провайдеры, у которых клиент будет видеть отдел в списке выбора при создании запроса
  • head — Глава отдела. Глава отдела технической поддержки
  • realname — Описание категории запроса. Наименование, отображаемое клиенту при создании запроса. Указывается в случае необходимости
  • orderpriority — Сортировка. Порядок отображения отдела в списке выбора при написании запроса
  • support_require — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает автоматическое списание обращений с клиентов при направлении запроса в данный отдел. В случае отсутствия не потраченных обращений и невозможности их приобретения отдел не будет отображен в списке

Установка фильтра.

department.filter

Скидки


Функция: account.discountinfo

Результат: список элементов

Информация о скидках

Уровень доступа: user

  • id — Id
  • name — Наименование
  • value — Величина скидки / спец. цена
  • actiontype — Действует на
  • discount_type — Тип скидки
  • period — Период действия

Текущие операции


Функция: runningoperation

Результат: список элементов

Текущие операции

Уровень доступа: admin

  • id — Id
  • desc — Описание
  • item — Услуга/товар
  • itemtype — Тип продукта
  • client — Клиент
  • cdate — Дата создания
  • trycount — Кол-во попыток
  • processingmodule — Обработчик
  • task — Задача
  • status — Статус

Создать задачу для текущей операции

Функция: runningoperation.taskcreate

Создать задачу для текущей операции

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции runningoperation.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: runningoperation.errorhistory

Результат: список элементов

История запуска операции

Уровень доступа: admin

  • id — Id
  • createdate — Дата
  • item — Услуга
  • task — Задача

Открыть лог ошибки

Функция: errorhistory.showlog

Открыть лог ошибки

Уровень доступа: admin

Установка фильтра.

runningoperation.filter

Текущие операции

Функция: runningoperation.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции runningoperation)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции runningoperation)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • intname — Тип операции. Тип операции
  • item — Услуга/товар. Id услуги
  • trycount — Кол-во попыток. Количество попыток запуска
  • cdate — Дата создания. Время создания операции
  • manual — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выключает автоматический перезапуск операции по расписанию
  • comment — Комментарий. Комментарий сотрудника

Удалить

Функция: runningoperation.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции runningoperation.

Результат: успешное выполнение операции или сообщение об ошибке

Остановить выполнение операции

Функция: runningoperation.stop

Остановить выполнение операции

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции runningoperation.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: runningoperation.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Запустить обработку операции

Функция: runningoperation.start

Запустить обработку операции

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции runningoperation.

Результат: успешное выполнение операции или сообщение об ошибке

Перейти в панель

Функция: runningoperationgotoserver

Перейти в панель

Уровень доступа: admin

Войти в панель с правами пользователя

Функция: runningoperation.su

Войти в панель с правами пользователя

Уровень доступа: admin

Резервное копирование


Функция: billmgr.backup

Результат: список элементов

Резервное копирование

Уровень доступа: admin

  • id — Id
  • date — Дата
  • size — Размер, MiB

Запуск резервного копирования

Функция: billmgr.backup.create

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Скачать резервную копию на локальный компьютер

Функция: backups.download

Скачать резервную копию на локальный компьютер

Уровень доступа: admin

Восстановление

Функция: backups.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • behavior — Поведение. Выбор поведения при восстановлении существующих данных. "Пропустить существующие данные" означает, что сущности, которые есть в системе, не будут восстановлены. Также не будут восстановлены их зависимые элементы. "Изменить существующие данные" означает, что все данные из бэкапа будут восстановлены.

Например, в системе есть web домен, но файлы из его домашней директории были удалены. Если при восстановлении домена отметить "Пропустить существующие данные", то файлы не восстановятся. Если при восстановлении домена отметить "Изменить существующие данные", то файлы домена восстановятся, а также восстановятся и все настройки домена.

Добавить хранилище и план резервного копирования

Функция: billmgr.backup.setup

Добавить хранилище и план резервного копирования

Уровень доступа: admin

Сохраненные данные

Функция: backupdata

Результат: список элементов

Сохраненные данные

Уровень доступа: admin

  • type — Тип данных

Имя данных

Функция: backupdata.names

Результат: список элементов

Содержимое

Уровень доступа: admin

  • name — Имя данных
  • owner — Владелец
Восстановление

Функция: backupdata.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
    • elid — уникальный идентификатор (элемент id из функции backupdata.names)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata).
    • elid — уникальный идентификатор (элемент id из функции backupdata.names)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • version — Версия. Выбрать дату резервной копии
  • behavior — Поведение. Выбор поведения при восстановлении существующих данных. "Пропустить существующие данные" означает, что сущности, которые есть в системе, не будут восстановлены. Также не будут восстановлены их зависимые элементы. "Изменить существующие данные" означает, что все данные из бэкапа будут восстановлены.

Например, в системе есть web домен, но файлы из его домашней директории были удалены. Если при восстановлении домена отметить "Пропустить существующие данные", то файлы не восстановятся. Если при восстановлении домена отметить "Изменить существующие данные", то файлы домена восстановятся, а также восстановятся и все настройки домена.

Наименование

Функция: backupdata.files

Результат: список элементов

Файлы

Уровень доступа: admin

  • dname — Имя
Восстановление

Функция: backupdata.files.restore

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
    • elid — уникальный идентификатор (элемент name из функции backupdata.files)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции backupdata.names).
    • elid — уникальный идентификатор (элемент name из функции backupdata.files)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • version — Версия. Выбрать дату резервной копии

Закачать резервную копию

Функция: backups.upload

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип файла. Укажите, откуда вы хотите закачать файл: с локального компьютера или с использованием ссылки на файл, расположенный на другом сервере
  • url — URL. Укажите ссылку на файл, который вы хотите закачать в текущий каталог, например, http://example.com/dir/file.html
  • name — Имя файла. Укажите, с каким именем файл должен быть сохранён в текущем каталоге. Если вы оставите это поле пустым, имя файла будет выделено из URL
  • storage — Хранилище. Выберите хранилище, в которое будет загружена резервная копия

Удаление резервной копии

Функция: backups.delete

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • clean_storages — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Нужно ли удалять архивы и листинги из хранилищ

Восстановление

Функция: billmgr.backup.settings

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции billmgr.backup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • dropsettings — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут удалены настройки резервного копирования и информация о резервных копиях. Данные с хранилищ не удаляются

Плательщики


Функция: profile

Результат: список элементов

Плательщики

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • account — Клиент
  • profiletype — Статус плательщика

Плательщик

Функция: profile.docflow_counteragent

Результат: список элементов

Подключения к системам документооборота

Уровень доступа: admin user

  • id — Id
  • company — Компания
  • module — Система документооборота
  • status — Состояние

Включить

Функция: profile.docflow_counteragent.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции profile.docflow_counteragent.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: profile.docflow_counteragent.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции profile.docflow_counteragent.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: profile.company

Результат: список элементов

Компании плательщика

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • status — Состояние

Включить

Функция: profile.company.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции profile.company.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: profile.company.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции profile.company.

Результат: успешное выполнение операции или сообщение об ошибке

Поиск плательщика в системах электронного докуметооборота и проверка отношений с подключенными компаниями

Функция: profile.docflow

Поиск плательщика в системах электронного докуметооборота и проверка отношений с подключенными компаниями

Уровень доступа: admin+

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции profile.

Результат: успешное выполнение операции или сообщение об ошибке

Написать запрос клиенту

Функция: ticket.write.profile

Написать запрос клиенту

Уровень доступа: admin

Создать

Функция: profile.add

Создать

Уровень доступа: user

Печать конверта

Функция: envelope.print

Печать конверта

Уровень доступа: admin user

Войти в панель с правами пользователя

Функция: profile.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: profile.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Редактирование плательщика

Функция: profile.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции profile)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции profile)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • profiletype — Статус плательщика. Юридический статус плательщика
  • name — Наименование. Наименование компании
  • person — Контактное лицо. Укажите контактное лицо
  • phone — Телефон. Контактный номер телефона
  • fax — Факс. Номер факса
  • email — Email. Основной Email компании
  • maildocs — Получать документы. Способ получения оригиналов финансовых документов
  • docflow_box — Ящик (_company ). Ящик для входящих документов ( company_)
  • docflow_department — Подразделение (_company ). Подразделение для входящих документов ( company_)
  • document_type — Тип документов. Тип отправляемых по системе электронного документооборота документов
  • id1c — Код в бухгалтерской системе. Код для интеграции с бухгалтерской системой
  • invoicetype — Тип генерации актов. Выберите способ, которым будут генерироваться акты выполненных работ
  • postcompany — Компания акта. Компания, от имени которой будет выставлен акт
  • postcurrency — Валюта акта. Валюта, в которой будет выставлен акт. При наличии неоплченных расходов, закрытых актом, авансовый платеж может быть выписан только на компанию, от имени которой выставлен акт, и только в валюту акта
  • invoicedesc — Описание услуг. При автоматической генерации акта выполненных работ по авансовым платежам это значение будет использовано как описание услуг.
  • payment_description — Назначение авансового платежа. Будет отображаться в качестве наименования авансового платежа в списке платежей
  • note — Комментарий. Комментарий к плательщику
  • wrongaddress — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Признак означает, что для данного плательщика были возвраты отправленной корреспонденции. Отправка документов на адреса таких плательщиков не рекомендуется
  • returnreason — Причина возврата. Причина, по которой был возврат корреспонденции
  • country_legal — Страна. Страна регистрации компании
  • state_legal — Регион. Регион регистрации компании
  • postcode_legal — Индекс. Индекс, по адресу регистрации компании
  • city_legal — Город. Город регистрации компании
  • address_legal — Адрес. Адрес регистрации компании. Включает в себя улицу, дом и номер офиса при наличии
  • legaleqphysical — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Опция включает сохранение адреса регистрации в соответствии с юридическим адресом
  • country_physical — Страна. Страна физического размещения
  • state_physical — Регион. Регион физического размещения
  • postcode_physical — Индекс. Индекс для физического адреса размещения
  • city_physical — Город. Город физического размещения
  • address_physical — Адрес. Адрес физического размещения. Включает в себя улицу, дом и номер офиса/квартиры при наличии

Удалить

Функция: profile.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции profile.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: profile.history

Результат: список элементов

История изменения параметров плательщика

Уровень доступа: admin user

  • changedate — Дата изменения
  • desc — Описание
  • user — Пользователь
  • ip — IP-адрес
  • action — Функция

Установка фильтра.

profile.filter

Фиксация цен


Функция: tool.fixedprices

Результат: список элементов

Фиксация цен

Уровень доступа: admin

  • id — Id
  • project — Провайдер
  • pricelist — Тариф
  • fixdate — Дата фиксации
  • itemcount — Количество услуг

Удалить

Функция: tool.fixedprices.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции tool.fixedprices.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: tool.fixedprices.detail

Результат: список элементов

Цены на ресурсы

Уровень доступа: admin

  • id — Id
  • name — Наименование

Цены на ресурс

Функция: tool.fixedprices.detail.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции tool.fixedprices).
    • elid — уникальный идентификатор (элемент id из функции tool.fixedprices.detail)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции tool.fixedprices).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции tool.fixedprices).
    • elid — уникальный идентификатор (элемент id из функции tool.fixedprices.detail)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Создать

Функция: tool.fixedprices.add

Создать

Уровень доступа: admin

Фиксация цены

Функция: tool.fixedprices.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции tool.fixedprices)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции tool.fixedprices)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Наименование

Функция: tool.fixedprices.item

Результат: список элементов

Список услуг привязанных к фиксации

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • itemtype — Тип продукта
  • account_name — Владелец

Установить фильтр по клиенту

Функция: tool.fixedprices.item.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Войти в панель с правами пользователя

Функция: tool.fixedprices.item.su

Войти в панель с правами пользователя

Уровень доступа: admin

Отменить фиксацию цен для выбранных услуг

Функция: tool.fixedprices.item.delete

Отменить фиксацию цен для выбранных услуг

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции tool.fixedprices.item.

Результат: успешное выполнение операции или сообщение об ошибке

Партнеры ISPsystem


Функция: hostingpartner

Результат: список элементов

Хостинг-партнеры ISPsystem

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • brand — Бренд
  • level — Уровень

Редактирование хостинг-партнера

Функция: hostingpartner.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции hostingpartner)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции hostingpartner)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • account — Клиент. Клиент ISPsystem
  • level — Уровень. Уровень хостинг-партнера
  • set_autogroup — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировать изменение уровня
  • autogroup — Новый уровень. Новый укровень, который будет установлен в назначенный день
  • autogroup_date — Дата. Дата, в которую нужно выставить новый уровень
  • minimal_paymentamount — Минимальный платеж. Минимальная сумма затрат на покупку партнерских лицензий в месяц
  • creditlimit — Кредитный лимит. Кредитный лимит клиента у провайдера
  • licurl — URL сайта партнера. URL сайта для покупки лицензии
  • free_ipchange — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить свободную смену IP
  • auto_purchase — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить автопокупку
  • incidentcount — Доб. обращений в поддержку. Количество добавляемых обращений в поддержку
  • eur_rate — Специальный курс EUR. Отношение EUR к RUB (сколько RUB стоит 1 EUR)
  • iprange — Диапазон IP-адресов. Диапазон разрешенных IP-адресов
  • brand — Бренд. Наименование бренда
  • domainsource — Источник доменов. Источник доменов
  • billmgrurl — URL для заказа плагинов. URL сервиса с API BILLmanager 5 для заказа плагинов к лицензиям
  • islandingpage — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Указанный URL биллинга является посадочной страницей
  • sshkey — SSH ключ. SSH ключ

Удалить

Функция: hostingpartner.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции hostingpartner.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: hostingpartner.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: hostingpartner.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Вы можете задать условия отбора для данного списка. Они будут применяться всякий раз при его отображении до тех пор пока фильтр не будет изменен или снят

Функция: hostingpartner.filter

Вы можете задать условия отбора для данного списка. Они будут применяться всякий раз при его отображении до тех пор пока фильтр не будет изменен или снят

Уровень доступа: admin

Методы оплаты


Функция: paymethod

Результат: список элементов

Методы оплаты

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • module — Платежная система
  • currency_name — Валюта
  • projects — Провайдеры
  • companies — Компании
  • note — Комментарий
  • orderpriority — Сортировка (в прямом порядке)
  • status — Состояние

Установка фильтра.

paymethod.filter

Переместить метод оплаты на одну позицию вверх

Функция: paymethod.up

Переместить метод оплаты на одну позицию вверх

Уровень доступа: admin

Создать

Функция: paymethod.add

Создать

Уровень доступа: admin

Переместить метод оплаты на одну позицию вниз

Функция: paymethod.down

Переместить метод оплаты на одну позицию вниз

Уровень доступа: admin

Включить

Функция: paymethod.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.

Результат: успешное выполнение операции или сообщение об ошибке

Настройки метода оплаты

Функция: paymethod.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции paymethod)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции paymethod)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование метода оплаты
  • minamount — Минимальная сумма платежа. Минимальная сумма, на которую можно выписать платеж с помощью данного метода оплаты
  • maxamount — Максимальная сумма платежа. Максимальная сумма, на которую можно выписать платеж с помощью данного метода оплаты
  • commissionamount — Фиксированная часть комисcии. Фиксированная часть комиссии, снимаемой с клиента при зачислении платежа
  • commissionpercent — Процентная часть комиссии. Процентная часть комисcии, снимаемой с клиента при зачислении платежа
  • doctmpl — Шаблон печати. Шаблон печати счета. Если не указан используется настройка компании, на которую выставлен счет
  • numtmpl_payment — Шаблон номера счета. Шаблон формирования номера счета, можно использовать макросы {id} — код платежа и {num} — порядковый номер платежа, созданного с использованием метода оплаты. При отсутствии обоих макросов в шаблоне номера счета к шаблону будет добавлен макрос {num}
  • nextnum_payment — Следующий порядковый номер счета. Следующий порядковый номер счета, созданного с использованием метода оплаты. Учитывается только при условии заполнения шаблона номера счета
  • payment_description — Назначение авансового платежа. Будет отображаться в качестве наименования авансового платежа в списке платежей
  • autoclearperiod — Период удаления неоплаченных платежей. Период в днях, по истечении которого со дня создания платежа он будет удален в случае неоплаты
  • orderpriority — Сортировка (в прямом порядке). Позволяет задать приоритет метода оплаты при сортировке
  • successpage — Страница возврата при успешном платеже. Страница, на которую будет перенаправлен плательщик при успешном платеже
  • failpage — Страница возврата при неудачном платеже. Страница, на которую будет перенаправлен плательщик при неудачном платеже
  • pendingpage — Страница возврата при платеже в обработке. Страница, на которую будет перенаправлен плательщик при платеже в статусе "обрабатывается"
  • note — Комментарий. Комментарий к методу оплаты
  • profiletype — Статус плательщика. Метод оплаты будет доступен для плательщиков с указанным статусом
  • accountgroup — Группы клиентов. Позволяет ограничить использование метода оплаты только клиентами из выбранных групп
  • deny_accountgroup — Запретить группам клиентов. Позволяет запретить использование метода оплаты клиентам из выбранных групп
  • language — Язык клиента. Если язык интерфейса у клиента соответствует одному из указанных, то метод оплаты будет доступен. Если не выбрать ни одного языка, то метод оплаты будет доступен на всех языках.
  • recurring — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включить использование рекурентных платежей
  • successpage_recurring — Страница возврата при успешном автоплатеже. Страница, на которую будет перенаправлен плательщик при успешном автоплатеже
  • failpage_recurring — Страница возврата при неудачном автоплатеже. Страница, на которую будет перенаправлен плательщик при неудачном автоплатеже
  • pendingpage_recurring — Страница возврата при автоплатеже в обработке. Страница, на которую будет перенаправлен плательщик при автоплатеже в статусе "обрабатывается"
  • allowrefund — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить полный или частичный возврат платежей совершенных методом оплаты
  • description_markdown — Описание метода оплаты (markdown).
  • description — Описание метода оплаты. Описание метода оплаты клиент увидит на первом шаге при оплате услуги. Разрешено использование HTML.

Наименование

Функция: paymethod.company

Результат: список элементов

Подключение метода оплаты к компаниям

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Включить

Функция: paymethod.company.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.company.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: paymethod.company.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.company.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: paymethod.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.

Результат: успешное выполнение операции или сообщение об ошибке

Наименование

Функция: paymethod.project

Результат: список элементов

Подключение метода оплаты к провайдерам

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • status — Состояние

Включить

Функция: paymethod.project.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.project.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: paymethod.project.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.project.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: paymethod.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции paymethod.

Результат: успешное выполнение операции или сообщение об ошибке

Уведомления


Функция: problems

Результат: список элементов

Уведомления

Уровень доступа: user

Войти в панель с правами пользователя

Функция: problems.su

Войти в панель с правами пользователя

Уровень доступа: user

Установить фильтр по клиенту

Функция: problems.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Корзина


Функция: basket

Уровень доступа: 8 user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров
    Пример API вызова для просмотра списка услуг в корзине:

    Пример API вызова

    https://<адрес BILLmamager>?authinfo=username:password&func=basket&out=xml
    CODE

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке
    Пример API вызова для удаления услуги из корзины:

    Пример API вызова

    https://<адрес BILLmamager>?authinfo=username:password&clicked_button=delete&func=basket&id=<id услуги>&sok=ok&out=xml
    CODE

Список параметров или дополнительных параметров запроса (см.выше):

Пользователи


Функция: user

Результат: список элементов

Пользователи

Уровень доступа: admin user

  • id — Id
  • name — Имя пользователя
  • realname — ФИО
  • email — Email
  • account — Клиент
  • status — Состояние

Установка фильтра.

user.filter

Написать запрос клиенту

Функция: ticket.write.user

Написать запрос клиенту

Уровень доступа: admin

Установить фильтр по клиенту

Функция: user.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Имя пользователя изменено с "_old_value " на " new_value_"

Функция: user.history

Результат: список элементов

История изменения параметров пользователя

Уровень доступа: admin user

  • changedate — Дата изменения
  • desc — Описание
  • user — Пользователь
  • ip — IP-адрес
  • action — Функция

Выключить

Функция: user.suspend

Выключить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: user.delete

Удалить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Отправка СМС сообщения

Функция: user.sms

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции user)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции user)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Выбор номера телефона. Тип номера телефона, на который будет отправлено сообщение
  • phone — Номер. Номер телефона, на который будет отправлено сообщение
  • message — Сообщение. Отправляемое сообщение

Войти в панель с правами пользователя

Функция: user.su

Войти в панель с правами пользователя

Уровень доступа: admin

Включить

Функция: user.resume

Включить

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции user.

Результат: успешное выполнение операции или сообщение об ошибке

Реклама


Функция: advertisement

Результат: список элементов

Реклама

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • selectclients — Сегмент клиентов
  • project — Провайдер
  • weight — Вес
  • state — Статус

Редактирование рекламы

Функция: advertisement.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции advertisement)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции advertisement)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • project — Провайдер. Реклама будет отображаться клиентам только выбранного провайдера
  • language — Язык. Реклама будет отображаться только клиентам с выбранным языком. Если не выбран ни один язык, то реклама будет показываться всем клиентам
  • weight — Вес. Вес влияет на частоту отображения баннера
  • url — Адрес баннера. URL адрес баннера, по которому он будет загружен для отображения клиентам
  • selectclients — Сегмент клиентов. Реклама будет показываться клиентам, которые были отобраны выбранным сегментом

Удалить

Функция: advertisement.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции advertisement.

Результат: успешное выполнение операции или сообщение об ошибке

Выключить

Функция: advertisement.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции advertisement.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: advertisement.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции advertisement.

Результат: успешное выполнение операции или сообщение об ошибке

Платежи


Функция: payment

Результат: список элементов

Платежи

Уровень доступа: admin user

  • id — id, уникальный идентификатор платежа;
  • number — номер платежа согласно нумерации компании или метода оплаты;
  • create_date — дата создания платежа;
  • sender_name — плательщик, совершивший платёж;
  • recipient_name — получатель. Нет, если метод оплаты не связан ни с одной компанией;
  • paymethod_name — метод оплаты, связанный с этим платежом;
  • subaccountamount_iso — сумма
  • paymethodamount_iso — сумма в валюте платежа выбранного метода оплаты
  • status — Статус. Может принимать значения:
    • 1 — новый;
    • 2 — оплачивается;
    • 3 — обещанный платёж;
    • 4 — зачислен;
    • 5 — ожидает возврата;
    • 6 — возвращён клиенту полностью;
    • 7 — мошеннический.

Пример API вызова для получения списка платежей со статусом "Новый" за период:

Пример API вызова

https://<адрес BILLmamager>?authinfo=username:password&func=payment&filter=on&status=1&createdate=other&createdateend=2020-07-03&createdatestart=2020-06-03&out=xml
CODE

createdatestart — дата начала периода для фильтрации;

createdateend — дата окончания периода для фильтрации.

В примере выше при вызове функции в ответ будет получен список платежей со статусом "Новый" начиная с 3 июня 2020 г до 3 июля 2020 г.

Установить фильтр по клиенту

Функция: payment.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Установка фильтра.

payment.filter

Оплата

Функция: payment.add.redirect

Уровень доступа: user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции payment)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции payment)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • amount_currency — Сумма платежа. Сумма к оплате

Войти в панель с правами пользователя

Функция: payment.su

Войти в панель с правами пользователя

Уровень доступа: admin user

Домены верхнего уровня


Функция: tld

Результат: список элементов

Домены верхнего уровня

Уровень доступа: admin

  • id — Id
  • name — Наименование

Удалить

Функция: tld.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции tld.

Результат: успешное выполнение операции или сообщение об ошибке

Домен верхнего уровня

Функция: tld.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции tld)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции tld)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование домена верхнего уровня
  • whois_host — Хост whois. Доменное имя сервиса получения информации о домене
  • whois_find_string — Строка поиска. Строка, при нахождении которой в ответе whois сервера домен будет считаться доступным для заказа
  • whois_timeout — Таймаут опроса. Таймаут на получение ответа от whois сервера, по истечении которого будет выдана ошибка получения whois данных домена. Значение по умолчанию 5 секунд
  • idn_type — Поддерживаются символы. Тип поддерживаемых доменной зоной символов. Латиница включает в себя символы от a-z, арабские цифры 0-9 и дефис (minus)
  • min_lenght — Минимальная длина имени. Минимальная длина доменного имени доступная для регистрации
  • max_lenght — Максимальная длина имени. Максимальная длина доменного имени после перевода Punycode, доступная для регистрации

Наименование

Функция: tld.idntable

Результат: список элементов

Таблицы символов

Уровень доступа: admin

  • name — Наименование
  • status — Состояние

Выключить

Функция: tld.idntable.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции tld.idntable.

Результат: успешное выполнение операции или сообщение об ошибке

Содержимое таблицы символов

Функция: tld.idntable.view

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции tld).
    • elid — уникальный идентификатор (элемент key из функции tld.idntable)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции tld).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции tld).
    • elid — уникальный идентификатор (элемент key из функции tld.idntable)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

Включить

Функция: tld.idntable.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции tld.idntable.

Результат: успешное выполнение операции или сообщение об ошибке

Размещение серверов


Функция: colocation

Результат: список элементов

Размещение серверов

Уровень доступа: admin user

  • id — Id
  • pricelist — Тариф
  • account — Клиент
  • project — Провайдер
  • datacentername — Дата-центр
  • processingmodule — Модуль обработки
  • createdate — Дата создания
  • expiredate — Действует до
  • autoprolong — Автопродление
  • status_msg -
  • item_status - статус услуги. Может принимать значения: 
    • 1 — заказана; 
    • 2 — активна; 
    • 3 — остановлена;
    • 4 — удалена; 
    • 5 — обрабатывается; 
  • cost — Стоимость

Выключить

Функция: colocation.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции colocation.

Результат: успешное выполнение операции или сообщение об ошибке

Редактирование услуги

Функция: colocation.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции colocation)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции colocation)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки
  • autoprolong — Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
  • createdate — Дата заказа. Дата заказа услуги
  • opendate — Дата создания. Дата фактического начала действия услуги
  • expiredate — Действует до. Срок действия услуги
  • scheduledclose — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
  • reboot — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
  • note — Комментарий. Комментарий к услуге, виден только сотрудникам провайдера
  • noexpense — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Установка фильтра.

colocation.filter

Включить

Функция: colocation.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции colocation.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: colocation.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Наименование

Функция: colocation.hardware

Результат: список элементов

Список оборудования

Уровень доступа: admin user

  • id — Id
  • hardware — Описание
  • receivingdate — Дата приемки
  • returndate — Дата возврата
  • status — Статус

Возврат оборудования

Функция: colocation.hardware.return

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • elid — уникальный идентификатор (элемент id из функции colocation.hardware)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • elid — уникальный идентификатор (элемент id из функции colocation.hardware)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • returnemployee — Передающий. ФИО сотрудника, передающего оборудование клиенту
  • returnuser — Принимающий. ФИО представителя клиента принимающего оборудование
  • returndate — Дата возврата. Дата возврата оборудования клиенту

Акт возврата оборудования клиенту

Функция: colocation.hardware.return_print

Акт возврата оборудования клиенту

Уровень доступа: admin

Акт приемки оборудования на площадку провайдера

Функция: colocation.hardware.receiving_print

Акт приемки оборудования на площадку провайдера

Уровень доступа: admin

Параметры оборудования

Функция: colocation.hardware.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • elid — уникальный идентификатор (элемент id из функции colocation.hardware)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • elid — уникальный идентификатор (элемент id из функции colocation.hardware)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • unit — Размещение. Размещение оборудования (номер стойки и номер юнита размещения оборудования)
  • hardware — Описание. Описание оборудования
  • note — Комментарий. Комментарий к оборудованию
  • receiveemployee — Принял. ФИО сотрудника принявшего оборудование
  • receiveuser — Передал. ФИО представителя клиента передавшего оборудование
  • receivingdate — Дата приемки. Дата приемки оборудования на площадку провайдера
  • returnemployee — Передал. ФИО сотрудника, передавшего оборудование клиенту
  • returnuser — Принял. ФИО представителя клиента принявшего оборудование
  • returndate — Дата возврата. Дата возврата оборудования клиенту

Удалить

Функция: colocation.hardware.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции colocation.hardware.

Результат: успешное выполнение операции или сообщение об ошибке

Войти в панель с правами пользователя

Функция: colocation.su

Войти в панель с правами пользователя

Уровень доступа: admin

Открытие услуги

Функция: colocation.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции colocation)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции colocation)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Наименование

Функция: colocation.port

Результат: список элементов

Сетевые подключения

Уровень доступа: admin user

  • id — Id
  • name — Наименование
  • linked_port — Используемое подключение от другого размещения
  • vlan — Виртуальная сеть

Сетевое подключение

Функция: colocation.port.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • elid — уникальный идентификатор (элемент id из функции colocation.port)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции colocation).
    • elid — уникальный идентификатор (элемент id из функции colocation.port)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • type — Тип подключения. Тип добавляемого сетевого подключения
  • linked_port — Подключение от другого размещения. Подключение от другой услуги размещения оборудования клиента
  • note — Комментарий. Комментарий к подключению

Удалить

Функция: colocation.port.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции colocation.port.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить выделенные услуги

Функция: colocation.delete

Удалить выделенные услуги

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции colocation.

Результат: успешное выполнение операции или сообщение об ошибке

Заказать новую услугу

Функция: colocation.order

Заказать новую услугу

Уровень доступа: user

Задачи


Функция: task

Результат: список элементов

Задачи

Уровень доступа: admin

  • id — Id
  • type — Тип задачи
  • department — Ответственный отдел
  • item — Услуга/товар
  • itemstatus — Статус услуги
  • itemtype — Тип продукта
  • pricelist — Тарифный план
  • client — Клиент
  • performer — Исполнитель
  • runningoperation — Операция
  • opendate — Дата создания
  • status — Статус задачи

Установить фильтр по клиенту

Функция: task.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Войти в панель с правами выбранного пользователя

Функция: task.su

Войти в панель с правами выбранного пользователя

Уровень доступа: admin

Написать запрос клиенту

Функция: ticket.write.task

Написать запрос клиенту

Уровень доступа: admin

Удалить

Функция: task.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции task.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

task.filter

Перезапуск связанной с задачей текущей операции

Функция: task.start

Перезапуск связанной с задачей текущей операции

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции task.

Результат: успешное выполнение операции или сообщение об ошибке

Задача

Функция: task.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции task)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции task)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • department — Ответственный отдел. Отдел на который назначено выполнение задачи
  • specification — Описание задачи:. Подробное описание задачи и действий которые необходимо выполнить
  • closeaction — Действия при закрытии задачи. Описание действий, которые будут произведены при закрытии задачи
  • item_info — Описание услуги:. Информация об услуге и ее параметрах над которой необходимо выполнить задачу
  • error_info — Описание ошибки:. Информация об ошибках которе произошли во время попытки автоматического выполнения задачи
  • message — произвольный комментарий сотрудника. При изменении комментария добавьте к запросу параметр sv_field=postmessgae. 
  • itemnote — Комментарий к услуге. Комментарий к услуге, виден только сотрудникам провайдера


Перерасчет


Функция: tool.recalculationlist

Результат: список элементов

Перерасчеты расходов за услуги

Уровень доступа: admin

  • id — Id
  • recalcdate — Дата перерасчета
  • username — Имя пользователя
  • request_ip — IP-адрес
  • itemcount — Количество услуг
  • discount — Скидка
  • oldsum — Удалено на сумму
  • newsum — Создано на сумму
  • notecol — Комментарий

Пересчитать расходы за услуги

Функция: tool.recalculation

Пересчитать расходы за услуги

Уровень доступа: admin

Наименование

Функция: tool.recalculationlist.item

Результат: список элементов

Список услуг, для которых был совершен перерасчет

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • fromdate — Расходы с даты
  • todate — Расходы по дату
  • oldsum — Удалено на сумму
  • newsum — Создано на сумму

Установка фильтра.

tool.recalculationlist.filter

Группы тарифов


Функция: pricelistgroup

Результат: список элементов

Группы тарифов

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • project — Провайдер
  • itemtype — Тип продукта

Редактирование тарифного плана

Функция: pricelistgroup.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции pricelistgroup)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции pricelistgroup)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование группы
  • project — Провайдер. Провайдер, к которому привязана группа
  • itemtype — Тип продукта. Тип продукта, к которому привязана группа
  • itemmax — Количество услуг доступных для заказа. Укажите максимально количество услуг доступных для заказа одним клиентом. По достижению указанного количества клиентом, заказ дополнительных услуг данного тарифа клиенту будет недоступен
  • trial_itemmax — Количество триалов доступных для заказа. Максимальное количество триальных экземпляров услуг данного тарифного плана

Удалить

Функция: pricelistgroup.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции pricelistgroup.

Результат: успешное выполнение операции или сообщение об ошибке

Избранные запросы


Функция: ticket_favorite

Результат: список элементов

Избранные запросы

Уровень доступа: admin

  • id — Id
  • name — Тема
  • client — Клиент
  • last_message — Последнее сообщение
  • responsible — Ответственный
  • project_name — Провайдер
  • tstatus — Статус
  • props — Свойства

Убрать запрос из списка избранных

Функция: ticket_favorite.delete

Убрать запрос из списка избранных

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ticket_favorite.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

ticket_favorite.filter

Запрос

Функция: ticket_favorite.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции ticket_favorite)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции ticket_favorite)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Тема запроса. Тема запроса. Содержит краткое описание вопроса
  • ticket_item — Услуга. Услуга, к которой относится запрос
  • ticket_project_select — Провайдер. Провайдер, к которому относится тема запроса
  • client_department — Отдел. Отдел провайдера, в который будет передан запрос
  • item — Услуга. Услуга, к которой относится запрос
  • client_priority — Приоритет. Приоритет запроса
  • priority — Приоритет. Приоритет запроса
  • message — .
  • show_optional — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Будут отображены дополнительные настройки запроса
  • note_message — .
  • ticket_expense — Списать со счета. Сумма средств, которая будет списана со счета клиента
  • high_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поместить запрос в верх очереди
  • low_priority — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Для запроса будет сброшен признак повышенного приоритета
  • incident_count — Обращения в поддержку. Количество "обращений в поддержку" списанных за запрос. При увеличении указанного количества будут списаны дополнительные "обращения", при уменьшении разница будет возвращена клиенту
  • show_abuse — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать параметры регистрации нарушения
  • score — Количество баллов. Количество баллов за нарушение
  • action — Действие. Укажите какое действие необходимо выполнить по достижению установленного срока устранения нарушения, в случае отсутствия реакции от клиента
  • deadline_date — Дата устранения нарушения. Срок устранения нарушения, дата
  • deadline_time — Время устранения нарушения. Срок устранения нарушения, время
  • score_note — Комментарий. Комментарий к нарушению

Войти в панель с правами пользователя

Функция: ticket_favorite.su

Войти в панель с правами пользователя

Уровень доступа: admin

Установить фильтр по клиенту

Функция: ticket_favorite.setfilter

Установить фильтр по клиенту

Уровень доступа: admin

Настройки пользователя


Функция: usrparam

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):

  • name — Имя пользователя. Текущее имя пользователя, для которого вы изменяете настройки панели управления
  • timezone — Часовой пояс. Выберите часовой пояс, в котором вы находитесь

Защита от мошенничества


Функция: fraud_gateway

Результат: список элементов

Системы проверки номера телефона

Уровень доступа: admin

  • id — Id
  • name — Наименование
  • identifier — Идентификатор
  • module — Модуль
  • priority — Приоритет
  • status — Состояние

Включить

Функция: fraud_gateway.resume

Включить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции fraud_gateway.

Результат: успешное выполнение операции или сообщение об ошибке

Удалить

Функция: fraud_gateway.delete

Удалить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции fraud_gateway.

Результат: успешное выполнение операции или сообщение об ошибке

Создать

Функция: fraud_gateway.create

Создать

Уровень доступа: admin

Выключить

Функция: fraud_gateway.suspend

Выключить

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции fraud_gateway.

Результат: успешное выполнение операции или сообщение об ошибке

Настройки шлюза

Функция: fraud_gateway.edit

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции fraud_gateway)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции fraud_gateway)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

  • name — Наименование. Наименование
  • phone_filter — Фильтр номеров. В качестве фильтра номера телефона указывается регулярное выражение
  • verify_type — Способ проверки номера. Доступный клиенту для выбора способ проверки номера телефона
  • priority — Приоритет. Приоритет, по которому сортируются шлюзы при проверке номера телефона клиентом. БОльшая цифра имеет высший приоритет.
  • retry_timeout — Таймаут. Таймаут в минутах на повторную отправку кода
  • code_lifetime — Срок действия кода. Срок в минутах, после которого код будет считаться недействительным
  • active — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Активирует шлюз после его создания

Заказы


Функция: order

Уровень доступа: user

Данная функция одновременно используется для просмотра и изменения данных формы

Просмотр данных:

  • Результат: список параметров

Изменение данных:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров или дополнительных параметров запроса (см.выше):