API customer UK

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Дії с абонентами. Большинство дій актуально для ручних білінгів.

Додаткові параметри:
action - підкатегорія запиту (можливе значення: див. нижче)

Підкатегорії

add

Доопрацьовано у: 3.13.25 (додано параметр is_corporate)

Опис: Додавання абонента
Необов'язкові параметри:
 fio - найменування абонента
 codeti - id абонента в білінгу
 is_potential - прапорець - потенційний абонент
 is_corporate - прапорець - юридична особа
 billing_id - id білінгу (є обов'язковим, якщо це не потенційний абонент)
 billing_customer_id - id абонента в білінгу (є обов'язковим, якщо це не потенційний абонент)

abon_hist

Доопрацьовано у: 3.17dev1 (виключено параметр usercode, додано параметр customer_id)

Опис: Виведення операций с абонентом (фінансові і прочие)
Обов'язкові параметри:
 usercode - (для версії 3.16 і раніше) ID абонента
 customer_id - (для версії 3.17 і пізніше) ID абонента

change_balance

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Доопрацьовано у: 3.13.22 (додано параметр operator_id)

Опис: Зміна баланса (операция прихода/расхода)
Обов'язкові параметри:
 customer_id - ID абонента
 amount - Сума
 comment - Нотатки к операції
Необов'язкові параметри:
 employee_id - ID співробітника
 operator_id - ID оператора (до версії 3.16dev2)

change_billing

Доопрацьовано у: 3.16.23 (додано параметр billing_user_id)

Додано у: 3.12.48

Опис: Зміна білінгу
Обов'язкові параметри:
 customer_id - id абонента
 billing_id - id білінгу
Необов'язкові параметри:
 billing_user_id - id абонента в білінгу

change_date_connect

Додано у: 3.12.80

Опис: Зміна дати подключения
Обов'язкові параметри:
 customer_id - ID абонента
 value - дата

delete

Додано у: 3.14.21

Опис: Видалення абонента
Обов'язкові параметри:
 id - id абонента

edit

Доопрацьовано у: 3.20.10 (додано параметр coordinates)

Доопрацьовано у: 3.16dev3 (додано параметр group_id)

Доопрацьовано у: 3.13.56 (додано параметр manager_id)

Додано у: 3.12rc2

Опис: Редагування абонента
Обов'язкові параметри:
 id - id абонента
Необов'язкові параметри:
 account_number - номер лицевого рахунку
 agreement_date - дата договора
 agreement_number - номер договора
 apartment_number - номер квартири
 comment - нотатки
 coordinates - координати в текстовом виде через кому (пример: 47.839628,35.140553)
 date_activity - дата активности в сети
 date_activity_inet - дата активности в интернете
 date_connect - дата подключения
 email - адрес електронної пошти
 entrance - номер під'їзда
 flag_corporate - прапорець - юридична особа
 floor - поверх
 group_id - id групи
 house_id - id будинока
 is_potential - прапорець - потенційний абонент
 login - логін
 manager_id - id співробітника-менеджера
 name - найменування абонента
 parent_id - id батьківського абонента (для дочернего абонента)
 phone0 - номер мобильного телефона
 phone1 - номер будинокашнего телефона
 phone2 - номер дополнительного телефона 1
 phone3 - номер дополнительного телефона 2
 phone4 - номер дополнительного телефона 3

get_activity_counter

Додано у: 3.12.81

Опис: Отримання счетчика активних абонентів
Обов'язкові параметри:
 type - тип лічильника (Можливі значення: net, internet, personal_area)

get_abon_id

Доопрацьовано у: 3.14.34 (для параметра data_typer додано можливе значення account)

Опис: Отримання ID абонента за вхідними даними
Обов'язкові параметри:
 data_typer - тип даних, які перевіряємо (можливі значення: account, billing_uid, codeti, dognumber, ip, login, mac, mail, phone)
 data_value - значення
Необов'язкові параметри:
 is_skip_old - прапорець - не виконувати пошук серед колишніх абонентів

get_customer_group

Додано у: 3.19beta1

Опис: Отримання списку груп абонентів
Обов'язкові параметри:
 немає
Необов'язкові параметри:
 немає

get_customers_id

Доопрацьовано у: 3.19.31 (додано параметр account_number)

Доопрацьовано у: 3.19.15 (додано параметр billing_uuid)

Доопрацьовано у: 3.18.36 (додано параметр manager_id)

Доопрацьовано у: 3.18.10 (додано параметр is_corporate)

Доопрацьовано у: 3.16dev3 (додано параметри name, limit, is_like)

Доопрацьовано у: 3.15.26 (додано параметр is_ex)

Доопрацьовано у: 3.14.71 (додано параметр dependence_device_id)

Доопрацьовано у: 3.14.58 (додано параметри balance_from, balance_to, state_id)

Доопрацьовано у: 3.14.41 (додано параметри date_connect_from і date_connect_to)

Доопрацьовано у: 3.14.5 (додано параметр address_unit_id)

Доопрацьовано у: 3.13.48 (додано параметр tariff_id)

Доопрацьовано у: 3.13.35 (додано параметр mark_id)

Додано у: 3.12.8

Опис: Отримання списку ID абонентів за вхідними умовами
Обов'язкові параметри:
 немає
Необов'язкові параметри (але має бути вказана хоча б одна умова):
 account_number - номер лицевого рахунку
 address_unit_id - id адресної одиниці
 appartment - номер квартири
 balance_from - баланс (з)
 balance_to - баланс (до)
 billing_id - id номера білінгу
 billing_uuid - id абонента в білінгу
 date_connect_from - дата подключения (з)
 date_connect_to - дата подключения (до)
 dependence_device_id - id пристрою, від якого залежать абоненти
 house_id - id будинока
 is_corporate - прапорець - юридична особа
 is_ex - прапорець - колишні абоненти
 manager_id - id менеджера (0 для поиска без менеджера)
 mark_id - id мітки
 name - ПІБ/назва абонента
 state_id - id статуса
 tariff_id - id тарифа
 limit - максимальное кількість записів, що вернуть в ответе
 is_like - прапорець - використовувати порівняння підрядка там, де це можливо (а не повний збіг)

get_data

Опис: Отримання информации за абонентом
Обов'язкові параметри:
 customer_id - ID абонента
 або
 account_number - номер лицевого счета абонента
 +
 billing_id - ID білінгу

get_ip_port_device_commutation

Додано у: 3.12beta35

Опис: Отримання IP,MAC-адрес абонентів с привязкой к коммутаторам (в т.ч. для роботи с DHCP)

get_last_ip

Опис: Отримання останньої використаної IP-адреси для абонентів

get_mac_history

Додано у: 3.16dev8

Опис: Отримання истории изменения MAC-адрес за абонентом
Обов'язкові параметри:
 customer_id - id абонента

get_max_agreement_number

Додано у: 3.12.3

Опис: Отримання максимального занятого номера договора (числового)
Необов'язкові параметри:
 billing_id - id білінгу абонентів, среди яких виконувати вибірку

ip_add

Доопрацьовано у: 3.17.36 (додано параметр mac)

Додано у: 3.12.83

Опис: Додавання IP-адреса
Обов'язкові параметри:
 customer_id - ID абонента
 value - IP
Необов'язкові параметри:
 mac - MAC абонента

ip_delete

Доопрацьовано у: 3.19beta1 (до параметра value додано можливе значення all)

Додано у: 3.12.83

Опис: Видалення IP-адреса
Обов'язкові параметри:
 customer_id - id абонента
 value - ip або "-1" для записів без IP-адреси (тільки з MAC-адресою) або "all" для всіх адрес

ip_subnet_add

Додано у: 3.14.71

Опис: Додавання подсети IP-адрес для абонента
Обов'язкові параметри:
 customer_id - id абонента
 ip - початковий ip-адрес
 subnet - маска подсети/VLSM (наприклад: 24)

ip_subnet_delete

Додано у: 3.14.71

Опис: Видалення подсети IP-адрес у абонента
Обов'язкові параметри:
 customer_id - id абонента
 ip - початковий ip-адрес

list_tarif_available

Виключено у: 3.13

Опис: Список тарифов, доступних абоненту для зміни
Обов'язкові параметри:
 usercode - id абонента

mark_add

Додано у: 3.12.82

Опис: Додавання мітки на абоненте
Обов'язкові параметри:
 customer_id - id абонента
 mark_id - id мітки

mark_delete

Додано у: 3.12.82

Опис: Видалення мітки с абонента
Обов'язкові параметри:
 customer_id - id абонента
 mark_id - id мітки

merge

Додано у: 3.19.33

Опис: Об'єднання абонентів
Обов'язкові параметри:
 dst_id - id основного абонента
 src_id - id вторинного абонента (інформацію якого переносимо до основного)

msg

Доопрацьовано у: 3.20.18 (додано параметри is_answer, is_archive)

Доопрацьовано у: 3.17dev1 (виключено параметр usercode, додано параметр customer_id)

Доопрацьовано у: 3.16dev3 (параметр usercode зроблено необов'язковим)

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Доопрацьовано у: 3.14.53 (додано параметри date_add_from, date_add_to, operator_id)

Опис: Виведення переписки с абонентом
Необов'язкові параметри (але має бути щось одне):
 usercode - (для версії 3.16 і раніше) ID абонента
 customer_id - (для версії 3.17 і пізніше) ID абонента
 date_add_from - дата повідомлення (з)
 date_add_to - дата повідомлення (до)
 is_answer - був ли ответ на сообщение (1 - був ответ, 0 - не було ответа)
 is_archive - в архиве ли сообщение
 employee_id - id співробітника-автора повідомлення
 operator_id - id оператора-автора повідомлення (до версії 3.16dev2)

msg_add

Доопрацьовано у: 3.18.40 (додано параметр is_arc)

Додано у: 3.13.25

Опис: Додавання повідомлення от абонента
Обов'язкові параметри:
 customer_id - id абонента
 text - Текст повідомлення
Необов'язкові параметри:
 is_arc - прапорець - поместить сообщение в архив

msg_add_to_customer

Додано у: 3.19.45

Опис: Додавання повідомлення от співробітника к абоненту
Обов'язкові параметри:
 employee_id - id співробітника
 customer_id - id абонента
 text - Текст повідомлення
Необов'язкові параметри:
 is_arc - прапорець - поместить сообщение в архив

pass_change

Доопрацьовано у: 3.17dev1 (виключено параметр usercode, додано параметр customer_id)

Доопрацьовано у: 3.15.23 (параметр pass_old став необов'язковим)

Опис: Смена пароля на вход в ЛК
Обов'язкові параметри:
 usercode - (для версії 3.16 і раніше) ID абонента
 customer_id - (для версії 3.17 і пізніше) ID абонента
 pass_new - новий пароль
Додаткові параметри:
 pass_old - текущий пароль

service_add

Додано у: 3.18beta1

Опис: Додавання доп.услуги
Обов'язкові параметри:
 customer_id - id абонента
 service_id - id доп.услуги
Необов'язкові параметри:
 price - индивидуальная стоимость
 comment - нотатки

service_remove

Додано у: 3.18beta1

Опис: Видалення доп.услуги
Обов'язкові параметри:
 customer_id - id абонента
 service_id - id доп.услуги

set_mac_by_ip

Додано у: 3.12beta35

Опис: указание MAC-адреса для IP-адреса абонента
Обов'язкові параметри:
 ip - IP-адрес абонента (наприклад: 192.168.0.1)
 mac - MAC-адрес абонента (наприклад: 00:11:22:33:44:55)

state_change

Доопрацьовано у: 3.17dev1 (виключено параметр usercode, додано параметр customer_id)

Додано у: 3.12.8

Опис: зміна статуса роботи у абонента
Обов'язкові параметри:
 usercode - (для версії 3.16 і раніше) ID абонента
 customer_id - (для версії 3.17 і пізніше) ID абонента
 state_id - ID статуса абонента (0 - стоп, 1 - пауза, 2 - активен)

tarif_change

Доопрацьовано у: 3.17dev1 (виключено параметр usercode, додано параметр customer_id)

Опис: смена тарифа абоненту
Обов'язкові параметри:
 usercode - (для версії 3.16 і раніше) ID абонента
 customer_id - (для версії 3.17 і пізніше) ID абонента
 tarif - ID нового тарифа

to_ex

Доопрацьовано у: 3.17dev1 (виключено параметр usercode, додано параметр customer_id)

Додано у: 3.12.69

Опис: перевод абонента в категорию "Колишні абоненти"
Обов'язкові параметри:
 usercode - (для версії 3.16 і раніше) ID абонента
 customer_id - (для версії 3.17 і пізніше) ID абонента

to_normal

Доопрацьовано у: 3.17dev1 (виключено параметр usercode, додано параметр customer_id)

Додано у: 3.12.90

Опис: перевод абонента в в звичайний статус (из "Колишніх абонентів")
Обов'язкові параметри:
 usercode - (для версії 3.16 і раніше) ID абонента
 customer_id - (для версії 3.17 і пізніше) ID абонента