API customer

Раздел API ERP "UserSide"

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

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

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

add

Описание: Добавление абонента
Необязательные параметры:
 fio - Наименование абонента
 codeti - id абонента в биллинге
 is_potential - флаг - потенциальный абонент
 billing_id - id биллинга
Дополнительно возвращаемые данные:
 array(
  [Id] => ID нового абонента в случае успеха
 )

abon_hist

Описание: Вывод операций с абонентом (финансовые и прочие)
Обязательные параметры:
 usercode - ID абонента (tbl_base.CODE)
Дополнительно возвращаемые данные:
 перечень тарифов
 array(
  [Id] - ID_ТИП операции
  [DateDo] - дата операции
  [OperID] - ID оператора (tbl_oper.CODE)
  [BalansBefore] - баланс абонента до операции
  [Amount] - сумма операции
  [PKO] - номер приходного кассового ордера
  [Comment] - описание операции
  [BillingDopData] - дополнительные данные по операции из биллинга (используется при импорте данных из сторонних биллингов)
 )

change_balance

Описание: Изменение баланса
Обязательные параметры:
 customer_id - ID абонента
 amount - Сумма
 comment - Заметки к операции

change_billing

Описание: Изменение биллинга
Обязательные параметры:
 customer_id - ID абонента
 amount - Сумма
 comment - Заметки к операции

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_abon_id

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

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 биллинга абонентов, среди которых выполнять выборку

list_tarif_available

Исключено в: 3.13

Описание: Список тарифов, доступных абоненту для смены
Обязательные параметры:
 usercode - ID абонента (tbl_base.CODE)
Дополнительно возвращаемые данные:
 перечень тарифов
 array(
  [TarifList] => array(
   [Id] - ID тарифа (tbl_group.CODE)
   [Name] - Название тарифа
   [Price] - Стоимость тарифа
   [IsDayPrice] - Флаг - ежедневная ли стоимость
  )
 )

msg

Описание: Вывод переписки с абонентом
Обязательные параметры:
 usercode - ID абонента (tbl_base.CODE)
Дополнительно возвращаемые данные:
 перечень тарифов
 array(
  [Id] - ID сообщения (tbl_trouble.CODE)
  [DateMsg] - дата сообщения
  [MsgTyper] - (OperMsg/UserMsg) - тип сообщения. Сообщения от абонента или от оператора
  [Text] - текст сообщения
  [Attach] = array( - массив с прикрепленными файлами
   [Id] - ID файла (tbl_attach.CODE)
   [FilePath] - URL к файлу
   [RealName] - изначальное имя файла
  )
 )

pass_change

Описание: Смена пароля на вход в ЛК
Обязательные параметры:
 usercode - ID абонента (tbl_base.CODE)
 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 абонента (tbl_base.CODE)
 tarif - ID нового тарифа (tbl_group.CODE)