Користувальницькькі налаштування

Налаштування сайту


remoteapi

Розбіжності

Тут показані розбіжності між вибраною ревізією та поточною версією сторінки.

Посилання на цей список змін

Порівняння попередніх версій Попередня ревізія
Наступна ревізія
Попередня ревізія
Наступна ревізія По сторонах наступні версії
remoteapi [2023/06/15 17:31]
nightfly [API віддаленого виклику процедур]
remoteapi [2023/06/15 17:51]
nightfly
Рядок 52: Рядок 52:
   * **whydoyoucall** - Отримує дані з Askozia PBX про пропущені дзвінки.   * **whydoyoucall** - Отримує дані з Askozia PBX про пропущені дзвінки.
   * **whydoyoucallstats** - Записує статистику пропущених дзвінків за день у БД.   * **whydoyoucallstats** - Записує статистику пропущених дзвінків за день у БД.
-  * **asterisk + [param login]** - дозволяє отримати логін клієнта за номером телефону +  * **nasmon** - здійснює опитування серверів NAS з довідника на тему їхньої живості. 
-  * **asterisk + [param realname]** - дозволяє отримати логін та ПІБ клієнта за номером телефону у вигляді **[login]-[ПІБ]**; +  * **mtsigmonpoll** - проводить опитування MikrotikUBNT та інших бездротових пристроївдля отримання рівнів сигналу. 
-  * **asterisk + [param swstatus]** - дозволяє отримати стан обладнання, до якого прив'язаний клієнт у білінгу за номером телефону (Відповідь буде: OK або DIE) +  * **sormcast** - проводить вивантажування даних в [[sormyahont|ИС СОРМ Яхонт]]. 
-  * **asterisk** - можливий наступний запит: **/?module=remoteapi&key=[ubserial]&action=asterisk&number=[mobile_number]&param=[login|realname|swstatus|userstatus|setcredit|paycardpay|setpause|setunpause|getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|addusermobile|getvservicescount|getonlinedaysleft|getcontragentdata|getuserspends]** +  * **askozianum + [param mobilenumber]** - повертає стан користувача за номером його мобільного номера: 0 - не знайдено, 1 - знайдено і з ним все добре, 2 - боржник, 3 - відморозок. 
-    * //**&param=userstatus**// - дозволяє використовувати два цілком собі "self explanationary" додаткові параметри: **&ignorecache**=true и **&getmoney**=true +  * **freezedayscharge + [param debug2ublog]** - запускає процес обробки заморожених користувачів при увімкненому обмеженні кількості днів заморозки. Списує або нараховує доступні дні заморозки, а також відключає заморожування тим, хто вичерпав свої доступні дні заморозки. Необов'язковий параметр //debug2ublog// включає дебаг-режим та запис тогощо відбувається в веблог. [[frozenchargedays|Докладніше]] 
-    * //**&param=setcredit**// - **зобов'язує** використовувати додаткові параметри: **&login**=some_user_login, **&money**=123.45 и **&expiredays**=7.      +  * **mikrotikdnshaper + [param downshift]** - запускає обробку правил динамічного шейпера для [[mikrotikapi|Mikrotik NAS]]. Опціональний параметр **downshift** вказує обробникові повернути користувачам швидкості відповідно до їх тарифних планів. [[dnswitchmtik|Докладніше]] 
-    * //**&param=paycardpay**// - **зобов'язує** використовувати додаткові параметри: **&login**=some_user_login і **&paycardnum**=987654321. Параметр **&paycardcashtype**=24 - необов'язковий, має на увазі ID типу оплат і за замовчуванням рівний 1. +  * **getagentdata + [param login]** - повертає JSON з даними про присвоєному користувачеві контрагента
-    * //**&param=setpause**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login. +  * **districtscache** - оновлює кеш присвоєних користувачам районів
-    * //**&param=setunpause**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login. Наполегливо радимо використовувати цей функціонал дуже обережно, оскільки будь-яких спеціальних перевірок стану користувача перед розморожуванням не проводиться. +  * **smszilla** + filterid + templateid + [translit] здійснює розсилку з заздалегідь заданими фільтрами з певним шаблоном та опціональним примусовим транслітом за допомогою [[smszilla|SMSZilla]]. 
-    * //**&param=getuserdatabylogin**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login. При використанні необов'язкового параметра **&userpass**=some_password буде проведена верифікація пари "логін + пароль" перед поверненням даних користувача. +  * **multigen** - проводить швидку регенерацію всіх сценаріїв та відпрацювання необхідних сервісів [[multigen|КупаГен]]. 
-    * //**&param=getuserdatabymobile|getcontractsbymobile**// - не мають на увазі використання будь-яких додаткових параметрів, крім **&number=[mobile_number]** та їх дії/повертані дані цілком відповідають їх найменуванням. +  * **multigentotal** - очищає всі сценарії, потім здійснює регенерацію всіх сценаріїв та виконує необхідні сервіси (не рекомендується використовувати просто так)  
-    * //**&param=addusermobile**// - окрім **&number=[mobile_number]** зобов'язує також використовувати параметр **&login**=some_user_login, що, як би, логічно. Необов'язковий параметр **&maxmobilesamnt**=4 показує максимальну кількість мобільних номерів однією користувача+  * **multigentraff** - агрегує статистику сесій з таблички акаунтингу та оновлює трафік користувачів stargazer-а. 
-    //**getvservicescount**// **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину. Возвращает количество виртуальных сервисов, привязанных к определенному пользователю. +  * **multigenpod + [param login]** - шле PoD на NAS користувача з логіном вказаним у параметрі param. Керується опцією MULTIGEN_POD_ON_MAC_CHANGE.
-    * //**getonlinedaysleft**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**чтобы включить стоимость виртуальных услуг в расчет "оставшихся дней в сети". Возвращает количество «оставшихся дней в сети» для определенного пользователя. +
-    * //**getcontragentdata**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Возвращает данные связанного контрагента для определенного пользователя. +
-    * //**getuserspends**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**, для получения всех виртуальных услуг в дополнение к основному тарифу. Возвращает информацию о тарифе пользователя и его стоимости, а также, опционально, аналогичную информацию о виртуальных услугах пользователя в формате: +
-<code php> +
-        array(TarrifName => array('price' => TariffCost, 'daysperiod' => TariffChargePeriod), +
-              Vservice1 => array('price' => Vservice1Cost, 'daysperiod' => Vservice1ChargePeriod), +
-              Vservice2 => array('price' => Vservice2Cost, 'daysperiod' => Vservice2ChargePeriod),  +
-              VserviceN => array('price' => VserviceNCost, 'daysperiod' => VserviceChargePeriod) +
-             ) +
-        //Примечание: "TarrifName => TariffCost" - всегда первый элемент массива +
-</code> +
-  * +
-     * - ! - +
-        * //* Стоит отметить, что **getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|getcontragentdata|getuserspends** возвращают данные в формате JSON.//\\ +
-        * //* Все значения дополнительных параметров, конечно же, указаны как пример.//\\ +
- +
- +
-  * **nasmon** - производит опрос серверов NAS из справочника на тему их живости. +
-  * **mtsigmonpoll** - производит опрос Mikrotik и UBNT устройств для получения уровней сигнала. +
-  * **sormcast** - производит выгрузку данных в [[sormyahont|ИС СОРМ Яхонт]]. +
-  * **askozianum + [param mobilenumber]** - возвращает состояние пользователя по номеру его мобильного номера: 0 - не найден, 1 - найден и с ним все хорошо, 2 - должник, 3 - отморозок. +
-  * **freezedayscharge + [param debug2ublog]** - запускает процесс обработки замороженных пользователей при включенном ограничении количества дней заморозки. Списывает или начисляет доступные дни заморозки, а так же отключает заморозку тем, кто исчерпал свои доступные дни заморозки. Необязательный параметр //debug2ublog// включает дебаг-режим и запись происходящего в веблог. [[frozenchargedays|Подробнее]] +
-  * **mikrotikdnshaper + [param downshift]** - запускает обработку правил динамического шейпера для [[mikrotikapi|Mikrotik NAS]]. Опциональный параметр **downshift** указывает обработчику вернуть пользователям скорости согласно их тарифных планов. [[dnswitchmtik|Подробнее]] +
-  * **getagentdata + [param login]** - возвращает JSON с данными о присвоенном пользователю контрагенте+
-  * **districtscache** - обновляет кэш соответствия пользователей районам+
-  * **smszilla** + filterid + templateid + [translit] производит рассылку по заранее заданным фильтрам с определенным шаблоном и опциональным принудительным транслитом при помощи [[smszilla|SMSZilla]]. +
-  * **multigen** - производит быструю регенерацию всех сценариев и отработку требуемых сервисов +
-  * **multigentotal** - очищает все сценарии, потом производит регенерацию всех сценариев и выполняет требуемые сервисы (не рекомендуется использовать просто так) +
-  * **multigentraff** - аггрегирует статистику сессий из таблички аккаунтинга и обновляет трафик пользователей stargazer-а. +
-  * **multigenpod + [param login]** - шлет PoD на NAS пользователя с логином указанным в параметре param. Управляется опцией MULTIGEN_POD_ON_MAC_CHANGE.+
   * **onepunch + [param alias]** - запускает выполнение существующего [[onepunch|One-Punch]] скрипта.   * **onepunch + [param alias]** - запускает выполнение существующего [[onepunch|One-Punch]] скрипта.
-  * **paycardsqueue** - обрабатывает очередь платежных карточек и помечает их как полностью "использованные". +  * **paycardsqueue** - обробляє чергу платіжних карток і позначає їх як повністю "використані". 
-  * **salarytelegram** - рассылает сотрудникам [[salary|закрытые]] на них работы за день. +  * **salarytelegram** - розсилає співробітникам [[salary|закриті]] на них роботи за день. 
-  * **warehousetelegram** - рассылает сотрудникам [[warehouse|забронированные]] на них ТМЦ. +  * **warehousetelegram** - розсилає співробітникам [[warehouse|заброньовані]] на них ТМЦ. 
-  * **ddt** - вызывает периодическую обработку тарифов судного дня. +  * **ddt** - викликає періодичну обробку тарифів судного дня. 
-  * **visorcharge** - производит начисление средств для камер в случае их дефицита, в последний день месяца с основного аккаунта.+  * **visorcharge** - здійснює нарахування коштів для камер у разі їх дефіциту, в останній день місяця з основного облікового запису.
   * **fdbarchive** - производит сохранение текущего кэша FDB для архива. При необходимости производит ротацию.   * **fdbarchive** - производит сохранение текущего кэша FDB для архива. При необходимости производит ротацию.
-  * **remotedhcp** - возвращает данные необходимые для синхронизации [[remotedhcp|удаленными DHCP серверами]]. +  * **remotedhcp** - повертає дані, необхідні для синхронізації [[remotedhcp|віддаленими DHCP серверами]]. 
-  * **stgfeecharge2mysql** - создает кэш последних списаний денежных средств старгейзером со счета пользователя для каждого логина вытягивая это все из stargazer.log. Нужно для корректной работы функционала, включаемого опцией [[alteriniconf|alter.ini]] ONLINE_SHOW_LAST_FEECHARGE.+  * **stgfeecharge2mysql** - створює кеш останніх списань коштів старгейзером з рахунку користувача для кожного логіну витягаючи це все з stargazer.log. Потрібно для коректної роботи функціонала, що включає опцію [[alteriniconf|alter.ini]] ONLINE_SHOW_LAST_FEECHARGE.
   * **smartup** - вызов предназначен для обеспечения базовой интеграция c сервисом [[smartup|SmartUP]].   * **smartup** - вызов предназначен для обеспечения базовой интеграция c сервисом [[smartup|SmartUP]].
   * **envyarchive** - сохраняет конфигурацию всех завистливых устройств в архиве.   * **envyarchive** - сохраняет конфигурацию всех завистливых устройств в архиве.
Рядок 144: Рядок 114:
  
 Мысль надеюсь понятна.\\ Мысль надеюсь понятна.\\
 +
 +====== Страшні виклики навколо Asterisk ======
 +
 +  * **asterisk + [param login]** - дозволяє отримати логін клієнта за номером телефону
 +  * **asterisk + [param realname]** - дозволяє отримати логін та ПІБ клієнта за номером телефону у вигляді **[login]-[ПІБ]**;
 +  * **asterisk + [param swstatus]** - дозволяє отримати стан обладнання, до якого прив'язаний клієнт у білінгу за номером телефону (Відповідь буде: OK або DIE)
 +  * **asterisk** - можливий наступний запит: **/?module=remoteapi&key=[ubserial]&action=asterisk&number=[mobile_number]&param=[login|realname|swstatus|userstatus|setcredit|paycardpay|setpause|setunpause|getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|addusermobile|getvservicescount|getonlinedaysleft|getcontragentdata|getuserspends]**
 +    * //**&param=userstatus**// - дозволяє використовувати два цілком собі "self explanationary" додаткові параметри: **&ignorecache**=true и **&getmoney**=true
 +    * //**&param=setcredit**// - **зобов'язує** використовувати додаткові параметри: **&login**=some_user_login, **&money**=123.45 и **&expiredays**=7.     
 +    * //**&param=paycardpay**// - **зобов'язує** використовувати додаткові параметри: **&login**=some_user_login і **&paycardnum**=987654321. Параметр **&paycardcashtype**=24 - необов'язковий, має на увазі ID типу оплат і за замовчуванням рівний 1.
 +    * //**&param=setpause**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login.
 +    * //**&param=setunpause**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login. Наполегливо радимо використовувати цей функціонал дуже обережно, оскільки будь-яких спеціальних перевірок стану користувача перед розморожуванням не проводиться.
 +    * //**&param=getuserdatabylogin**// - **зобов'язує** використовувати додатковий параметр: **&login**=some_user_login. При використанні необов'язкового параметра **&userpass**=some_password буде проведена верифікація пари "логін + пароль" перед поверненням даних користувача.
 +    * //**&param=getuserdatabymobile|getcontractsbymobile**// - не мають на увазі використання будь-яких додаткових параметрів, крім **&number=[mobile_number]** та їх дії/повертані дані цілком відповідають їх найменуванням.
 +    * //**&param=addusermobile**// - окрім **&number=[mobile_number]** зобов'язує також використовувати параметр **&login**=some_user_login, що, як би, логічно. Необов'язковий параметр **&maxmobilesamnt**=4 показує максимальну кількість мобільних номерів однією користувача.
 +    * //**getvservicescount**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину. Возвращает количество виртуальных сервисов, привязанных к определенному пользователю.
 +    * //**getonlinedaysleft**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**, чтобы включить стоимость виртуальных услуг в расчет "оставшихся дней в сети". Возвращает количество «оставшихся дней в сети» для определенного пользователя.
 +    * //**getcontragentdata**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Возвращает данные связанного контрагента для определенного пользователя.
 +    * //**getuserspends**// - **подразумевает** возможность поиска юзера по номеру телефона **&number=[mobile_number]** или логину **&login**=some_user_login. Вы также можете использовать параметр **includevsrvs=true**, для получения всех виртуальных услуг в дополнение к основному тарифу. Возвращает информацию о тарифе пользователя и его стоимости, а также, опционально, аналогичную информацию о виртуальных услугах пользователя в формате:
 +<code php>
 +        array(TarrifName => array('price' => TariffCost, 'daysperiod' => TariffChargePeriod),
 +              Vservice1 => array('price' => Vservice1Cost, 'daysperiod' => Vservice1ChargePeriod),
 +              Vservice2 => array('price' => Vservice2Cost, 'daysperiod' => Vservice2ChargePeriod), 
 +              VserviceN => array('price' => VserviceNCost, 'daysperiod' => VserviceChargePeriod)
 +             )
 +        //Примечание: "TarrifName => TariffCost" - всегда первый элемент массива
 +</code>
 +  *
 +     * - ! -
 +        * //* Стоит отметить, что **getuserdatabylogin|getuserdatabymobile|getcontractsbymobile|getcontragentdata|getuserspends** возвращают данные в формате JSON.//\\
 +        * //* Все значения дополнительных параметров, конечно же, указаны как пример.//\\
 +
 +
 +
 ====== Обгортка ====== ====== Обгортка ======
  
remoteapi.txt · Востаннє змінено: 2024/05/15 14:31 повз bobr