API customer UK
Розділ 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 абонента