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 абонента