API customer: различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) |
||
| (не показано 10 промежуточных версий этого же участника) | |||
| Строка 6: | Строка 6: | ||
Дополнительные параметры: | Дополнительные параметры: | ||
action - подкатегория запроса ''(возможное значение: см.ниже)'' | |||
== Подкатегории == | == Подкатегории == | ||
| Строка 18: | Строка 18: | ||
is_potential - флаг - потенциальный абонент | is_potential - флаг - потенциальный абонент | ||
is_corporate - флаг - юридическое лицо | is_corporate - флаг - юридическое лицо | ||
billing_id - id биллинга | billing_id - id биллинга ''(является обязательным, если это не потенциальный абонент)'' | ||
billing_customer_id - id абонента в биллинге ''(является обязательным, если это не потенциальный абонент)'' | |||
==== abon_hist ==== | ==== abon_hist ==== | ||
| Строка 115: | Строка 116: | ||
Необязательные параметры: | Необязательные параметры: | ||
is_skip_old - флаг - не выполнять поиск среди бывших абонентов | is_skip_old - флаг - не выполнять поиск среди бывших абонентов | ||
==== get_customer_group ==== | |||
''Добавлено в: 3.19beta1'' | |||
Описание: Получение списка групп абонентов | |||
Обязательные параметры: | |||
нет | |||
Необязательные параметры: | |||
нет | |||
==== get_customers_id ==== | ==== get_customers_id ==== | ||
''Доработано в: 3.19.31 (добавлен параметр account_number)'' | |||
''Доработано в: 3.19.15 (добавлен параметр billing_uuid)'' | |||
''Доработано в: 3.18.36 (добавлен параметр manager_id)'' | |||
''Доработано в: 3.18.10 (добавлен параметр is_corporate)'' | ''Доработано в: 3.18.10 (добавлен параметр is_corporate)'' | ||
| Строка 140: | Строка 157: | ||
нет | нет | ||
Необязательные параметры ''(но должно быть указано хотя бы одно условие)'': | Необязательные параметры ''(но должно быть указано хотя бы одно условие)'': | ||
account_number - номер лицевого счёта | |||
address_unit_id - id адресной единицы | address_unit_id - id адресной единицы | ||
appartment - номер квартиры | appartment - номер квартиры | ||
| Строка 145: | Строка 163: | ||
balance_to - баланс ''(до)'' | balance_to - баланс ''(до)'' | ||
billing_id - id номера биллинга | billing_id - id номера биллинга | ||
billing_uuid - id абонента в биллинге | |||
date_connect_from - дата подключения ''(с)'' | date_connect_from - дата подключения ''(с)'' | ||
date_connect_to - дата подключения ''(до)'' | date_connect_to - дата подключения ''(до)'' | ||
| Строка 151: | Строка 170: | ||
is_corporate - флаг - юридическое лицо | is_corporate - флаг - юридическое лицо | ||
is_ex - флаг - бывшие абоненты | is_ex - флаг - бывшие абоненты | ||
manager_id - id менеджера ''(0 для поиска без менеджера)'' | |||
mark_id - id метки | mark_id - id метки | ||
name - ФИО/название абонента | name - ФИО/название абонента | ||
| Строка 202: | Строка 222: | ||
==== ip_delete ==== | ==== ip_delete ==== | ||
''Доработано в: 3.19beta1 (в параметр value добавлено возможное значение all)'' | |||
''Добавлено в: 3.12.83'' | ''Добавлено в: 3.12.83'' | ||
| Строка 208: | Строка 230: | ||
Обязательные параметры: | Обязательные параметры: | ||
customer_id - id абонента | customer_id - id абонента | ||
value - ip | value - ip или "-1" для записей без IP-адреса ''(только с MAC-адресом)'' или "all" для всех адресов | ||
==== ip_subnet_add ==== | ==== ip_subnet_add ==== | ||
| Строка 250: | Строка 272: | ||
customer_id - id абонента | customer_id - id абонента | ||
mark_id - id метки | mark_id - id метки | ||
==== merge ==== | |||
''Добавлено в: 3.19.33'' | |||
Описание: Объединение абонентов | |||
Обязательные параметры: | |||
dst_id - id основного абонента | |||
src_id - id вторичного абонента ''(информацию которого переносим к основному)'' | |||
==== msg ==== | ==== msg ==== | ||
| Строка 270: | Строка 300: | ||
==== msg_add ==== | ==== msg_add ==== | ||
''Доработано в: 3.18.40 (добавлен параметр is_arc)'' | |||
''Добавлено в: 3.13.25'' | ''Добавлено в: 3.13.25'' | ||
Описание: Добавление сообщения от абонента | Описание: Добавление сообщения от абонента | ||
Обязательные параметры: | Обязательные параметры: | ||
customer_id - | customer_id - id абонента | ||
text - Текст сообщения | text - Текст сообщения | ||
Необязательные параметры: | |||
is_arc - флаг - поместить сообщение в архив | |||
==== pass_change ==== | ==== pass_change ==== | ||
Текущая версия от 18:04, 20 ноября 2024
Раздел 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.16dev3 (добавлен параметр group_id)
Доработано в: 3.13.56 (добавлен параметр manager_id)
Добавлено в: 3.12rc2
Описание: Редактирование абонента Обязательные параметры: id - id абонента Необязательные параметры: account_number - номер лицевого счёта agreement_date - дата договора agreement_number - номер договора apartment_number - номер квартиры comment - заметки 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 - номер домашнего телефона
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.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 - дата сообщения (до) employee_id - id сотрудника-автора сообщения operator_id - id оператора-автора сообщения (до версии 3.16dev2)
msg_add
Доработано в: 3.18.40 (добавлен параметр is_arc)
Добавлено в: 3.13.25
Описание: Добавление сообщения от абонента Обязательные параметры: 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 абонента