API customer: различия между версиями
Admin (обсуждение | вклад) (→edit) |
Admin (обсуждение | вклад) |
||
(не показано 38 промежуточных версий этого же участника) | |||
Строка 9: | Строка 9: | ||
==== add ==== | ==== add ==== | ||
''Доработано в: 3.13.25 (добавлен параметр is_corporate)'' | |||
Описание: Добавление абонента | Описание: Добавление абонента | ||
Необязательные параметры: | Необязательные параметры: | ||
fio - | fio - наименование абонента | ||
codeti - id абонента в биллинге | codeti - id абонента в биллинге | ||
is_potential - флаг - потенциальный абонент | is_potential - флаг - потенциальный абонент | ||
is_corporate - флаг - юридическое лицо | |||
billing_id - id биллинга | billing_id - id биллинга | ||
==== abon_hist ==== | ==== abon_hist ==== | ||
Описание: Вывод операций с абонентом (финансовые и прочие) | Описание: Вывод операций с абонентом (финансовые и прочие) | ||
Обязательные параметры: | Обязательные параметры: | ||
usercode - ID абонента | usercode - ID абонента | ||
Дополнительно возвращаемые данные: | Дополнительно возвращаемые данные: | ||
перечень тарифов | перечень тарифов | ||
Строка 29: | Строка 27: | ||
[Id] - ID_ТИП операции | [Id] - ID_ТИП операции | ||
[DateDo] - дата операции | [DateDo] - дата операции | ||
[OperID] - ID оператора | [OperID] - ID оператора | ||
[BalansBefore] - баланс абонента до операции | [BalansBefore] - баланс абонента до операции | ||
[Amount] - сумма операции | [Amount] - сумма операции | ||
Строка 38: | Строка 36: | ||
==== change_balance ==== | ==== change_balance ==== | ||
Описание: Изменение баланса | ''Доработано в: 3.13.22 (добавлен параметр operator_id)'' | ||
Описание: Изменение баланса (операция прихода/расхода) | |||
Обязательные параметры: | Обязательные параметры: | ||
customer_id - ID абонента | customer_id - ID абонента | ||
amount - Сумма | amount - Сумма | ||
comment - Заметки к операции | comment - Заметки к операции | ||
Необязательные параметры: | |||
operator_id - ID оператора | |||
==== change_billing ==== | |||
''Добавлено в: 3.12.48'' | |||
Описание: Изменение биллинга | |||
Обязательные параметры: | |||
customer_id - ID абонента | |||
billing_id - ID биллинга | |||
==== change_date_connect ==== | |||
''Добавлено в: 3.12.80'' | |||
Описание: Изменение даты подключения | |||
Обязательные параметры: | |||
customer_id - ID абонента | |||
value - дата | |||
==== delete ==== | |||
''Добавлено в: 3.14.21'' | |||
Описание: Удаление абонента | |||
Обязательные параметры: | |||
id - id абонента | |||
==== edit ==== | ==== edit ==== | ||
''Доработано в: 3.13.56 (добавлен параметр manager_id)'' | |||
''Добавлено в: 3.12rc2'' | ''Добавлено в: 3.12rc2'' | ||
Описание: Редактирование абонента | Описание: Редактирование абонента | ||
Обязательные параметры: | Обязательные параметры: | ||
id - id абонента | id - id абонента | ||
Необязательные параметры: | Необязательные параметры: | ||
account_number - номер лицевого счёта | |||
agreement_date - дата договора | agreement_date - дата договора | ||
agreement_number - номер договора | agreement_number - номер договора | ||
apartment_number - номер квартиры | apartment_number - номер квартиры | ||
manager_id - id сотрудника-менеджера | |||
comment - заметки | |||
date_activity - дата активности в сети | |||
date_activity_inet - дата активности в интернете | date_activity_inet - дата активности в интернете | ||
date_connect - дата подключения | |||
email - адрес электронной почты | email - адрес электронной почты | ||
entrance - номер подъезда | |||
flag_corporate - флаг - юридическое лицо | |||
floor - этаж | floor - этаж | ||
house_id - id дома | house_id - id дома | ||
Строка 60: | Строка 95: | ||
login - логин | login - логин | ||
name - наименование | name - наименование | ||
parent_id - id родительского абонента ''(для дочернего абонента)'' | |||
phone0 - номер мобильного телефона | phone0 - номер мобильного телефона | ||
phone1 - номер домашнего телефона | phone1 - номер домашнего телефона | ||
==== get_activity_counter ==== | |||
''Добавлено в: 3.12.81'' | |||
Описание: Получение счетчика активных абонентов | |||
Обязательные параметры: | |||
type - тип счетчика ''(Возможные значения: net, internet, personal_area)'' | |||
==== get_abon_id ==== | ==== get_abon_id ==== | ||
''Доработано в: 3.14.34 (для параметра data_typer добавлено возможное значение account)'' | |||
Описание: Получение ID абонента по входящим данным | Описание: Получение ID абонента по входящим данным | ||
Обязательные параметры: | Обязательные параметры: | ||
data_typer - тип данных, которые проверяем ( | data_typer - тип данных, которые проверяем ''(возможные значения: account, billing_uid, codeti, dognumber, ip, login, mac, mail, phone)'' | ||
data_value - значение | data_value - значение | ||
Необязательные параметры: | Необязательные параметры: | ||
is_skip_old - флаг - не выполнять поиск среди бывших абонентов | is_skip_old - флаг - не выполнять поиск среди бывших абонентов | ||
==== get_customers_id ==== | ==== get_customers_id ==== | ||
''Доработано в: 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'' | ''Добавлено в: 3.12.8'' | ||
Описание: Получение списка ID абонентов по входящим условиям | Описание: Получение списка ID абонентов по входящим условиям | ||
Необязательные параметры (но должно быть указано хотя бы одно условие): | Обязательные параметры: | ||
нет | |||
Необязательные параметры ''(но должно быть указано хотя бы одно условие)'': | |||
address_unit_id - id адресной единицы | |||
appartment - номер квартиры | appartment - номер квартиры | ||
billing_id - | balance_from - баланс ''(с)'' | ||
balance_to - баланс ''(до)'' | |||
billing_id - id номера биллинга | |||
date_connect_from - дата подключения ''(с)'' | |||
date_connect_to - дата подключения ''(до)'' | |||
dependence_device_id - id устройства, от которого зависят абоненты | |||
house_id - id дома | |||
mark_id - id метки | |||
state_id - id статуса | |||
tariff_id - id тарифа | |||
==== get_data ==== | ==== get_data ==== | ||
Строка 101: | Строка 163: | ||
==== get_max_agreement_number ==== | ==== get_max_agreement_number ==== | ||
''Добавлено в: 3.12.3'' | ''Добавлено в: 3.12.3'' | ||
Описание: Получение максимального занятого номера договора (числового) | Описание: Получение максимального занятого номера договора ''(числового)'' | ||
Необязательные параметры: | Необязательные параметры: | ||
billing_id - id биллинга абонентов, среди которых выполнять выборку | billing_id - id биллинга абонентов, среди которых выполнять выборку | ||
==== ip_add ==== | |||
''Добавлено в: 3.12.83'' | |||
Описание: Добавление IP-адреса | |||
Обязательные параметры: | |||
customer_id - ID абонента | |||
value - IP | |||
==== ip_delete ==== | |||
''Добавлено в: 3.12.83'' | |||
Описание: Удаление IP-адреса | |||
Обязательные параметры: | |||
customer_id - id абонента | |||
value - ip | |||
==== 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 ==== | ==== list_tarif_available ==== | ||
''Исключено в: 3.13'' | |||
Описание: Список тарифов, доступных абоненту для смены | Описание: Список тарифов, доступных абоненту для смены | ||
Обязательные параметры: | Обязательные параметры: | ||
usercode - | usercode - id абонента | ||
==== mark_add ==== | |||
''Добавлено в: 3.12.82'' | |||
Описание: Добавление метки на абоненте | |||
Обязательные параметры: | |||
customer_id - id абонента | |||
mark_id - id метки | |||
==== mark_delete ==== | |||
''Добавлено в: 3.12.82'' | |||
Описание: Удаление метки с абонента | |||
Обязательные параметры: | |||
customer_id - id абонента | |||
mark_id - id метки | |||
==== msg ==== | ==== msg ==== | ||
''Доработано в: 3.14.53 (добавлены параметры date_add_from, date_add_to, operator_id)'' | |||
Описание: Вывод переписки с абонентом | Описание: Вывод переписки с абонентом | ||
Обязательные параметры: | Обязательные параметры: | ||
usercode - ID абонента | usercode - ID абонента | ||
Необязательные параметры: | |||
date_add_from - дата сообщения (с) | |||
date_add_to - дата сообщения (до) | |||
operator_id - ID оператора-автора сообщения | |||
==== msg_add ==== | |||
''Добавлено в: 3.13.25'' | |||
Описание: Добавление сообщения от абонента | |||
Обязательные параметры: | |||
customer_id - Id абонента | |||
text - Текст сообщения | |||
==== pass_change ==== | ==== pass_change ==== | ||
Описание: Смена пароля на вход в ЛК | Описание: Смена пароля на вход в ЛК | ||
Обязательные параметры: | Обязательные параметры: | ||
usercode - ID абонента | usercode - ID абонента | ||
pass_old - текущий пароль | pass_old - текущий пароль | ||
pass_new - новый пароль | pass_new - новый пароль | ||
Строка 162: | Строка 268: | ||
Описание: смена тарифа абоненту | Описание: смена тарифа абоненту | ||
Обязательные параметры: | Обязательные параметры: | ||
usercode - ID абонента '' | usercode - ID абонента | ||
tarif - ID нового тарифа | |||
==== to_ex ==== | |||
''Добавлено в: 3.12.69'' | |||
Описание: перевод абонента в категорию "Бывшие абоненты" | |||
Обязательные параметры: | |||
usercode - ID абонента | |||
==== to_normal ==== | |||
''Добавлено в: 3.12.90'' | |||
Описание: перевод абонента в в обычный статус (из "Бывших абонентов") | |||
Обязательные параметры: | |||
usercode - ID абонента |
Версия от 11:29, 19 июня 2020
Раздел API ERP "UserSide"
Назначение: Действия с абонентами. Большинство действий актуально для ручных биллингов.
Дополнительные параметры: subcat - подкатегория запроса (возможное значение: см.ниже)
Подкатегории
add
Доработано в: 3.13.25 (добавлен параметр is_corporate)
Описание: Добавление абонента Необязательные параметры: fio - наименование абонента codeti - id абонента в биллинге is_potential - флаг - потенциальный абонент is_corporate - флаг - юридическое лицо billing_id - id биллинга
abon_hist
Описание: Вывод операций с абонентом (финансовые и прочие) Обязательные параметры: usercode - ID абонента Дополнительно возвращаемые данные: перечень тарифов array( [Id] - ID_ТИП операции [DateDo] - дата операции [OperID] - ID оператора [BalansBefore] - баланс абонента до операции [Amount] - сумма операции [PKO] - номер приходного кассового ордера [Comment] - описание операции [BillingDopData] - дополнительные данные по операции из биллинга (используется при импорте данных из сторонних биллингов) )
change_balance
Доработано в: 3.13.22 (добавлен параметр operator_id)
Описание: Изменение баланса (операция прихода/расхода) Обязательные параметры: customer_id - ID абонента amount - Сумма comment - Заметки к операции Необязательные параметры: operator_id - ID оператора
change_billing
Добавлено в: 3.12.48
Описание: Изменение биллинга Обязательные параметры: customer_id - ID абонента billing_id - ID биллинга
change_date_connect
Добавлено в: 3.12.80
Описание: Изменение даты подключения Обязательные параметры: customer_id - ID абонента value - дата
delete
Добавлено в: 3.14.21
Описание: Удаление абонента Обязательные параметры: id - id абонента
edit
Доработано в: 3.13.56 (добавлен параметр manager_id)
Добавлено в: 3.12rc2
Описание: Редактирование абонента Обязательные параметры: id - id абонента Необязательные параметры: account_number - номер лицевого счёта agreement_date - дата договора agreement_number - номер договора apartment_number - номер квартиры manager_id - id сотрудника-менеджера comment - заметки date_activity - дата активности в сети date_activity_inet - дата активности в интернете date_connect - дата подключения email - адрес электронной почты entrance - номер подъезда flag_corporate - флаг - юридическое лицо floor - этаж house_id - id дома is_potential - флаг - потенциальный абонент login - логин 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_customers_id
Доработано в: 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 абонентов по входящим условиям Обязательные параметры: нет Необязательные параметры (но должно быть указано хотя бы одно условие): address_unit_id - id адресной единицы appartment - номер квартиры balance_from - баланс (с) balance_to - баланс (до) billing_id - id номера биллинга date_connect_from - дата подключения (с) date_connect_to - дата подключения (до) dependence_device_id - id устройства, от которого зависят абоненты house_id - id дома mark_id - id метки state_id - id статуса tariff_id - id тарифа
get_data
Описание: Получение информации по абоненту Обязательные параметры: customer_id - ID абонента
get_ip_port_device_commutation
Добавлено в: 3.12beta35
Описание: Получение IP,MAC-адресов абонентов с привязкой к коммутаторам (в т.ч. для работы с DHCP)
get_last_ip
Описание: Получение последнего используемого IP-адреса для абонентов Дополнительно возвращаемые данные: array( [ip] => используемый IP-адрес в hex-формате )
get_max_agreement_number
Добавлено в: 3.12.3
Описание: Получение максимального занятого номера договора (числового) Необязательные параметры: billing_id - id биллинга абонентов, среди которых выполнять выборку
ip_add
Добавлено в: 3.12.83
Описание: Добавление IP-адреса Обязательные параметры: customer_id - ID абонента value - IP
ip_delete
Добавлено в: 3.12.83
Описание: Удаление IP-адреса Обязательные параметры: customer_id - id абонента value - ip
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 метки
msg
Доработано в: 3.14.53 (добавлены параметры date_add_from, date_add_to, operator_id)
Описание: Вывод переписки с абонентом Обязательные параметры: usercode - ID абонента Необязательные параметры: date_add_from - дата сообщения (с) date_add_to - дата сообщения (до) operator_id - ID оператора-автора сообщения
msg_add
Добавлено в: 3.13.25
Описание: Добавление сообщения от абонента Обязательные параметры: customer_id - Id абонента text - Текст сообщения
pass_change
Описание: Смена пароля на вход в ЛК Обязательные параметры: usercode - ID абонента pass_old - текущий пароль pass_new - новый пароль
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.12.8
Описание: изменение статуса работы у абонента Обязательные параметры: usercode - ID абонента state_id - ID статуса абонента (0 - стоп, 1 - пауза, 2 - активен)
tarif_change
Описание: смена тарифа абоненту Обязательные параметры: usercode - ID абонента tarif - ID нового тарифа
to_ex
Добавлено в: 3.12.69
Описание: перевод абонента в категорию "Бывшие абоненты" Обязательные параметры: usercode - ID абонента
to_normal
Добавлено в: 3.12.90
Описание: перевод абонента в в обычный статус (из "Бывших абонентов") Обязательные параметры: usercode - ID абонента