API customer

Раздел API ERP "UserSide"

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

Дополнительные параметры:
subcat - подкатегория запроса (возможное значение: см.ниже)

Подкатегории

add

Описание: Добавление абонента
Необязательные параметры:
 fio - Наименование абонента
 codeti - id абонента в биллинге
 is_potential - флаг - потенциальный абонент
 billing_id - id биллинга
Дополнительно возвращаемые данные:
 array(
  [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 - дата

edit

Добавлено в: 3.12rc2

Описание: Редактирование абонента
Обязательные параметры:
 id - id абонента
Необязательные параметры:
 agreement_date - дата договора
 agreement_number - номер договора
 apartment_number - номер квартиры
 date_activity_inet - дата активности в интернете
 email - адрес электронной почты
 floor - этаж
 house_id - id дома
 is_potential - флаг - потенциальный абонент
 login - логин
 name - наименование
 phone0 - номер мобильного телефона
 phone1 - номер домашнего телефона

get_activity_counter

Добавлено в: 3.12.81

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

get_abon_id

Описание: Получение ID абонента по входящим данным
Обязательные параметры:
 data_typer - тип данных, которые проверяем (Возможные значения: codeti, billing_uid, dognumber, ip, mac, phone, mail, login)
 data_value - значение
Необязательные параметры:
 is_skip_old - флаг - не выполнять поиск среди бывших абонентов

get_customers_id

Добавлено в: 3.12.8

Описание: Получение списка ID абонентов по входящим условиям
Необязательные параметры (но должно быть указано хотя бы одно условие):
 house_id - ID дома
 appartment - номер квартиры
 billing_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

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

Описание: Вывод переписки с абонентом
Обязательные параметры:
 usercode - ID абонента

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