{ "openapi": "3.1.0", "info": { "title": "Cuba-Link Universal Billing API", "version": "1.5", "description": "Static API specification generated from api-data.json. It is refreshed whenever the catalog changes." }, "servers": [ { "url": "https://api.cuba-link.ru" } ], "paths": { "/api.php": { "post": { "operationId": "callCubaLinkBillingMethod", "summary": "Call a Cuba-Link billing API method", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Billing API key." }, { "name": "cat", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "general_api", "customer", "address", "vehicle", "billing", "notepad", "cwdm", "splitter", "additional_data", "service", "task", "newin", "call", "cable-route", "fiber", "map", "key", "commutation", "setting", "cross", "device", "redirect", "trader", "attach", "advertising", "system", "inventory", "sms", "owner", "employee", "node", "tariff", "vlan", "gps" ] }, "description": "API category." }, { "name": "action", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Method name; see x-cuba-link-catalog." } ], "responses": { "200": { "description": "Successful JSON response." }, "400": { "description": "Unsupported method or invalid parameters." }, "401": { "description": "Invalid API key." } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "query", "name": "key" } } }, "x-cuba-link-generated-at": "2026-08-11T13:22:12+00:00", "x-cuba-link-source-last-modified": "2026-08-11T13:22:12+00:00", "x-cuba-link-catalog": [ { "id": "general_api", "name": "Универсальное API", "description": "Совместно с разработчиками различных биллинговых систем была разработана универсальная структура API.Она позволяет получать информацию из разных биллингов в едином, стандартизированном формате.Актуальная версия: 1.5На текущий момент интеграцию по этому API обеспечивают следующие биллинговые системы:- uBilling: начиная с версии 0.7.2+ (поддерживает API v1.2) и с версии 0.8.0+ (поддерживает API v1.4).- MikBill: начиная с версии 2.8.16+ (API v1.2) и с версии 2.12.7+ (API v1.4).- Carbon Billing: начиная с версии 5.15.06+ (API v1.2).- ABillS: при условии установки соответствующего модуля- Platex: начиная с версии 7+.Сама САП \"Кубалинк\" также может предоставлять данные в соответствии с требованиями этого API. Для работы взаимодействия в САП \"Кубалинк\" используется модуль usm_billing. Ключевое преимущество: Данное \"Универсальное API\" — это мощный инструмент для подключения самописных или неподдерживаемых биллингов. Достаточно, чтобы администратор или программист организовал вывод данных из своей системы в требуемом формате, и наш бесплатный модуль usm_billing сможет их корректно обработать.Основные принципы взаимодействия- Взаимодействие полностью построено на API-запросах. - Рабочая кодировка данных — UTF-8. - Формат данных для ответов — JSON. - Для идентификации и авторизации используется API-ключ. Рекомендуется на стороне биллинга дополнительно настраивать проверку IP-адресов, с которых поступают запросы, или ограничивать доступ другими сетевыми методами (например, на уровне VLAN). На запросы к неподдерживаемым методам или методы с некорректными параметрами система должна отвечать HTTP-статусом 400 (Bad Request). В теле ответа можно детализировать причину ошибки. Текстовые поля, имеющие пустое значение, рекомендуется не включать в ответ для оптимизации трафика. Форматы данных Дата и время: Указываются в формате \"ГГГГ-ММ-ДД ЧЧ:ММ:СС\". Пример: \"2024-03-15 14:30:00\"IP-адрес: Передаётся в виде целого числа (long integer), полученного путём преобразования адреса.Пример: для адреса 10.0.0.138 возвращается число 167772266.MAC-адрес: Указывается строкой из 12 символов в нижнем регистре без каких-либо разделителей.Пример: для адреса AA:BB:CC:DD:EE:FF возвращается строка \"aabbccddeeff\".", "methods": [ { "name": "get_api_information", "description": "get_api_information", "required_parameters": [], "optional_parameters": [] }, { "name": "get_city_district_list", "description": "get_city_district_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_city_list", "description": "get_city_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_connect_list", "description": "get_connect_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_device_list", "description": "get_device_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_device_model", "description": "get_device_model", "required_parameters": [], "optional_parameters": [] }, { "name": "get_device_type", "description": "get_device_type", "required_parameters": [], "optional_parameters": [] }, { "name": "get_house_list", "description": "get_house_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_services_list", "description": "get_services_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_street_list", "description": "get_street_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_supported_change_user_data_list", "description": "get_supported_change_user_data_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_supported_change_user_state", "description": "get_supported_change_user_state", "required_parameters": [], "optional_parameters": [] }, { "name": "get_supported_change_user_tariff", "description": "get_supported_change_user_tariff", "required_parameters": [], "optional_parameters": [] }, { "name": "get_supported_method_list", "description": "get_supported_method_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_system_information", "description": "get_system_information", "required_parameters": [], "optional_parameters": [] }, { "name": "get_tariff_list", "description": "get_tariff_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_user_additional_data_type_list", "description": "get_user_additional_data_type_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_user_group_list", "description": "get_user_group_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_user_history", "description": "get_user_history", "required_parameters": [], "optional_parameters": [] }, { "name": "get_user_list", "description": "get_user_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_user_messages", "description": "get_user_messages", "required_parameters": [], "optional_parameters": [] }, { "name": "get_user_state_list", "description": "get_user_state_list", "required_parameters": [], "optional_parameters": [] }, { "name": "get_user_tags", "description": "get_user_tags", "required_parameters": [], "optional_parameters": [] }, { "name": "change_user_data", "description": "change_user_data", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "customer", "name": "Абоненты", "description": "", "methods": [ { "name": "add", "description": "Добавление абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "abon_hist", "description": "Вывод операций с абонентом (финансовые и прочие)", "required_parameters": [], "optional_parameters": [] }, { "name": "change_balance", "description": "Изменение баланса (операция прихода/расхода)", "required_parameters": [], "optional_parameters": [] }, { "name": "change_billing", "description": "Изменение биллинга", "required_parameters": [], "optional_parameters": [] }, { "name": "change_date_connect", "description": "Изменение даты подключения", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "get_activity_counter", "description": "Получение счетчика активных абонентов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_abon_id", "description": "Получение ID абонента по входящим данным", "required_parameters": [], "optional_parameters": [] }, { "name": "get_customer_group", "description": "Получение списка групп абонентов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_customers_id", "description": "Получение списка ID абонентов по входящим условиям", "required_parameters": [], "optional_parameters": [] }, { "name": "get_data", "description": "Получение информации по абоненту", "required_parameters": [], "optional_parameters": [] }, { "name": "get_ip_port_device_commutation", "description": "Получение IP,MAC-адресов абонентов с привязкой к коммутаторам (в т.ч. для работы с DHCP)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_last_ip", "description": "Получение последнего используемого IP-адреса для абонентов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_mac_history", "description": "Получение истории изменения MAC-адресов по абоненту", "required_parameters": [], "optional_parameters": [] }, { "name": "get_max_agreement_number", "description": "Получение максимального занятого номера договора (числового)", "required_parameters": [], "optional_parameters": [] }, { "name": "ip_add", "description": "Добавление IP-адреса", "required_parameters": [], "optional_parameters": [] }, { "name": "ip_delete", "description": "Удаление IP-адреса", "required_parameters": [], "optional_parameters": [] }, { "name": "ip_subnet_add", "description": "Добавление подсети IP-адресов для абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "ip_subnet_delete", "description": "Удаление подсети IP-адресов у абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "list_tarif_available", "description": "Список тарифов, доступных абоненту для смены", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_add", "description": "Добавление метки на абоненте", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_delete", "description": "Удаление метки с абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "merge", "description": "Объединение абонентов", "required_parameters": [], "optional_parameters": [] }, { "name": "msg", "description": "Вывод переписки с абонентом", "required_parameters": [], "optional_parameters": [] }, { "name": "msg_add", "description": "Добавление сообщения от абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "msg_add_to_customer", "description": "Добавление сообщения от сотрудника к абоненту", "required_parameters": [], "optional_parameters": [] }, { "name": "pass_change", "description": "Смена пароля на вход в ЛК", "required_parameters": [], "optional_parameters": [] }, { "name": "service_add", "description": "Добавление доп.услуги", "required_parameters": [], "optional_parameters": [] }, { "name": "service_remove", "description": "Удаление доп.услуги", "required_parameters": [], "optional_parameters": [] }, { "name": "set_mac_by_ip", "description": "указание MAC-адреса для IP-адреса абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "state_change", "description": "изменение статуса работы у абонента", "required_parameters": [], "optional_parameters": [] }, { "name": "tarif_change", "description": "смена тарифа абоненту", "required_parameters": [], "optional_parameters": [] }, { "name": "to_ex", "description": "перевод абонента в категорию \"Бывшие абоненты\"", "required_parameters": [], "optional_parameters": [] }, { "name": "to_normal", "description": "перевод абонента в в обычный статус (из \"Бывших абонентов\")", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "address", "name": "Адреса", "description": "", "methods": [ { "name": "add_locality_type", "description": "Добавление типа адресной единицы", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_locality_type", "description": "Редактирование типа адресной единицы", "required_parameters": [], "optional_parameters": [] }, { "name": "get_locality_type", "description": "Информация о типах адресных единиц", "required_parameters": [], "optional_parameters": [] }, { "name": "get_alias", "description": "Информация об алиасах", "required_parameters": [], "optional_parameters": [] }, { "name": "add_address", "description": "Добавление адресной единицы", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Информация об адресных единицах", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_address", "description": "Редактирование адресной единицы", "required_parameters": [], "optional_parameters": [] }, { "name": "add_province", "description": "Добавление области", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_province", "description": "Редактирование области", "required_parameters": [], "optional_parameters": [] }, { "name": "del_province", "description": "Удаление области", "required_parameters": [], "optional_parameters": [] }, { "name": "get_province", "description": "Список областей", "required_parameters": [], "optional_parameters": [] }, { "name": "add_district", "description": "Добавление района", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_district", "description": "Редактирование района", "required_parameters": [], "optional_parameters": [] }, { "name": "del_district", "description": "Удаление района", "required_parameters": [], "optional_parameters": [] }, { "name": "get_district", "description": "Список районов", "required_parameters": [], "optional_parameters": [] }, { "name": "add_city", "description": "Добавление населенного пункта", "required_parameters": [], "optional_parameters": [] }, { "name": "get_city", "description": "Список населённых пунктов", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_city", "description": "Редактирование населённого пункта", "required_parameters": [], "optional_parameters": [] }, { "name": "del_city", "description": "Удаление населённого пункта", "required_parameters": [], "optional_parameters": [] }, { "name": "add_area", "description": "Добавление района в населённом пункте", "required_parameters": [], "optional_parameters": [] }, { "name": "get_area", "description": "Список районов населённых пунктов", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_area", "description": "Редактирование района населённого пункта", "required_parameters": [], "optional_parameters": [] }, { "name": "del_area", "description": "Удаление района населённого пункта", "required_parameters": [], "optional_parameters": [] }, { "name": "add_street", "description": "Добавление улицы", "required_parameters": [], "optional_parameters": [] }, { "name": "get_street", "description": "Список улиц", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_street", "description": "Редактирование улицы", "required_parameters": [], "optional_parameters": [] }, { "name": "del_street", "description": "Удаление улицы", "required_parameters": [], "optional_parameters": [] }, { "name": "add_house", "description": "Добавление здания", "required_parameters": [], "optional_parameters": [] }, { "name": "add_house_mark", "description": "Добавление метки на доме", "required_parameters": [], "optional_parameters": [] }, { "name": "del_house", "description": "Удаление дома", "required_parameters": [], "optional_parameters": [] }, { "name": "delete_house_mark", "description": "Снятие метки с дома", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_building_coord", "description": "Изменение географических координат у здания/сооружения", "required_parameters": [], "optional_parameters": [] }, { "name": "get_building_structure", "description": "Просмотр структуры здания", "required_parameters": [], "optional_parameters": [] }, { "name": "get_building_type", "description": "Справочник типов зданий", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_building_structure", "description": "Редактирование структуры здания", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_house", "description": "Редактирование здания", "required_parameters": [], "optional_parameters": [] }, { "name": "get_house", "description": "Список домов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_level", "description": "Справочник типов уровней (этажей)", "required_parameters": [], "optional_parameters": [] }, { "name": "move_child_object", "description": "Перенос дочерних объектов с здания на другое здание", "required_parameters": [], "optional_parameters": [] }, { "name": "owner_remove", "description": "Исключение собственника у здания", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "vehicle", "name": "Автотранспорт", "description": "", "methods": [ { "name": "add", "description": "Добавление", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список транспорта", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "billing", "name": "Биллинг", "description": "", "methods": [ { "name": "get", "description": "Информация о биллингах", "required_parameters": [], "optional_parameters": [] }, { "name": "refresh_date_update", "description": "Обновление даты синхронизации данных с биллингом", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "notepad", "name": "Блокнот", "description": "", "methods": [ { "name": "get_chapter", "description": "Информация о разделах блокнота", "required_parameters": [], "optional_parameters": [] }, { "name": "get_note", "description": "Информация о записях", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "cwdm", "name": "CWDM", "description": "", "methods": [ { "name": "get", "description": "Список CWDM", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "splitter", "name": "Делители/уплотнители", "description": "", "methods": [ { "name": "get", "description": "Список объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "add", "description": "Добавление объекта", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование объекта", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление объекта", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "additional_data", "name": "Дополнительные поля", "description": "Дополнительные поля имеют категории (cat_id)2 - Кабельные линии6 - Радиооборудование7 - Здания8 - Коммутаторы9 - Медиаконвертеры10 - Системные устройства12 - Тарифы (только для ручных биллингов)13 - Дополнительные услуги (только для ручных биллингов)14 - Сооружения связи15 - Кроссы/ODF16 - VLAN17 - Задания18 - Автотранспорт19 - Рекламные кампании20 - Произвольные устройства21 - Поставщики23 - Делители/Уплотнители24 - Собственники25 - ТМЦ26 - Кабельные каналы27 - Кабельные трассы (кабельных линий)28 - Абоненты 29 - Ключи30 - Наименования ТМЦ40 - Адресные единицы48 - Склады102 - Объекты на карте999 - СотрудникиДополнительные поля имеют тип поля (type)1 - Текст2 - Число3 - Флаг4 - Выбор из списка5 - Текстовое поле6 - Выбор из списка (в т.ч. свой вариант)7 - Дата8 - Выбор из списка (несколько значений)", "methods": [ { "name": "add_field", "description": "Добавление доп.поля", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_field", "description": "Редактирование доп.поля", "required_parameters": [], "optional_parameters": [] }, { "name": "delete_field", "description": "Удаление доп.поля (удаляется только если нет записей с этим доп.полем)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_value", "description": "Получение значений полей", "required_parameters": [], "optional_parameters": [] }, { "name": "change_value", "description": "Изменение значения дополнительного поля, в случае отсутствия такого дополнительного поля у объекта - оно будет создано.", "required_parameters": [], "optional_parameters": [] }, { "name": "change_value_mass", "description": "Массовое изменение значения дополнительного поля для множества объектов. В случае отсутствия такого дополнительного поля у объекта - оно будет создано.", "required_parameters": [], "optional_parameters": [] }, { "name": "get_list", "description": "Получение списка полей", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "service", "name": "Дополнительные услуги", "description": "", "methods": [ { "name": "get", "description": "Список дополнительных услуг", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "task", "name": "Задания", "description": "", "methods": [ { "name": "add", "description": "Создание задания", "required_parameters": [], "optional_parameters": [] }, { "name": "add_cable_line_to_task", "description": "Добавление кабельной линии к заданию", "required_parameters": [], "optional_parameters": [] }, { "name": "add_customer_to_task", "description": "Добавление абонента к заданию", "required_parameters": [], "optional_parameters": [] }, { "name": "add_device_to_task", "description": "Добавление оборудования к заданию", "required_parameters": [], "optional_parameters": [] }, { "name": "add_owner_to_task", "description": "Добавление собственника к заданию", "required_parameters": [], "optional_parameters": [] }, { "name": "change_date_work", "description": "Изменение даты и времени выполнения задания (дата, на которую назначены работы)", "required_parameters": [], "optional_parameters": [] }, { "name": "change_state", "description": "Изменения состояния (статуса) задания", "required_parameters": [], "optional_parameters": [] }, { "name": "check_verify_code", "description": "Проверка кода подтверждения для выполнения заявки", "required_parameters": [], "optional_parameters": [] }, { "name": "checklist_item_check", "description": "Отметка пункта чек-листа в задании", "required_parameters": [], "optional_parameters": [] }, { "name": "checklist_item_uncheck", "description": "Снятие отметки с пункта чек-листа в задании", "required_parameters": [], "optional_parameters": [] }, { "name": "comment_add", "description": "Добавление комментария", "required_parameters": [], "optional_parameters": [] }, { "name": "comment_edit", "description": "Изменение комментария", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление задания", "required_parameters": [], "optional_parameters": [] }, { "name": "division_add", "description": "Добавление подразделения", "required_parameters": [], "optional_parameters": [] }, { "name": "division_delete", "description": "Исключение подразделения", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Изменение задания", "required_parameters": [], "optional_parameters": [] }, { "name": "employee_add", "description": "Добавление исполнителя", "required_parameters": [], "optional_parameters": [] }, { "name": "employee_delete", "description": "Исключение исполнителя", "required_parameters": [], "optional_parameters": [] }, { "name": "get_allow_staff", "description": "Список исполнителей и подразделений, которые доступны для назначение на задание (согласно настроек)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_catalog_type", "description": "Типы заданий", "required_parameters": [], "optional_parameters": [] }, { "name": "get_catalog_type_group", "description": "Группы типов заданий", "required_parameters": [], "optional_parameters": [] }, { "name": "get_catalog_state", "description": "Классификатор состояний заданий", "required_parameters": [], "optional_parameters": [] }, { "name": "get_comment", "description": "Комментарии", "required_parameters": [], "optional_parameters": [] }, { "name": "get_related_task_id", "description": "Список связанных заданий с текущим заданием (идентификаторы)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_typical_comments", "description": "Получение списка типовых комментариев", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_add", "description": "Добавление метки на задание", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_delete", "description": "Удаление метки с задания", "required_parameters": [], "optional_parameters": [] }, { "name": "overview_task", "description": "Фиксация факта просмотра задания сотрудником", "required_parameters": [], "optional_parameters": [] }, { "name": "remove_cable_line_from_task", "description": "Исключение кабельной линии с задания", "required_parameters": [], "optional_parameters": [] }, { "name": "remove_customer_from_task", "description": "Исключение абонента с задания", "required_parameters": [], "optional_parameters": [] }, { "name": "remove_owner_from_task", "description": "Исключение собственника с задания", "required_parameters": [], "optional_parameters": [] }, { "name": "set_rate", "description": "Указание индивидуального тарифа (для сотрудников) по заданию", "required_parameters": [], "optional_parameters": [] }, { "name": "show", "description": "Информация о задании", "required_parameters": [], "optional_parameters": [] }, { "name": "watcher_add", "description": "Добавление наблюдателя", "required_parameters": [], "optional_parameters": [] }, { "name": "watcher_delete", "description": "Исключение наблюдателя", "required_parameters": [], "optional_parameters": [] }, { "name": "get_list", "description": "Список заданий (идентификаторы)", "required_parameters": [], "optional_parameters": [] }, { "name": "add_node_to_task", "description": "Добавление сооружения связи к заданию", "required_parameters": [], "optional_parameters": [] }, { "name": "remove_node_from_task", "description": "Исключение сооружения связи с задания", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "newin", "name": "Заявки на подключение", "description": "", "methods": [] }, { "id": "call", "name": "Звонки", "description": "", "methods": [ { "name": "add", "description": "Создание записи о звонке", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список звонков", "required_parameters": [], "optional_parameters": [] }, { "name": "hangup", "description": "Фиксация факта окончания звонка", "required_parameters": [], "optional_parameters": [] }, { "name": "transfer_call", "description": "Передача информации и звонке другому сотруднику", "required_parameters": [], "optional_parameters": [] }, { "name": "dial", "description": "Передача входящего вызова получателю (вызов ещё не отвечен)", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование вызова", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "cable-route", "name": "Кабельные трассы", "description": "", "methods": [ { "name": "add_route", "description": "Добавление кабельной трассы", "required_parameters": [], "optional_parameters": [] }, { "name": "add_duct", "description": "Добавление кабельного канала", "required_parameters": [], "optional_parameters": [] }, { "name": "get_route", "description": "Список кабельных трасс", "required_parameters": [], "optional_parameters": [] }, { "name": "get_duct", "description": "Список кабельных каналов", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "fiber", "name": "Кабельные линии", "description": "", "methods": [ { "name": "add", "description": "Добавление линии", "required_parameters": [], "optional_parameters": [] }, { "name": "add_mark", "description": "Добавление метки", "required_parameters": [], "optional_parameters": [] }, { "name": "add_route_object", "description": "Добавление объекта на маршрут линии", "required_parameters": [], "optional_parameters": [] }, { "name": "catalog_cables_add", "description": "Добавление записи в каталог кабелей", "required_parameters": [], "optional_parameters": [] }, { "name": "catalog_cables_get", "description": "Каталог кабелей", "required_parameters": [], "optional_parameters": [] }, { "name": "catalog_types_get", "description": "Каталог типов кабельных линий", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление кабельной линии", "required_parameters": [], "optional_parameters": [] }, { "name": "delete_mark", "description": "Снятие метки", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование линии", "required_parameters": [], "optional_parameters": [] }, { "name": "get_fiber", "description": "Список волокон", "required_parameters": [], "optional_parameters": [] }, { "name": "get_geo_length", "description": "Расчёт длины линии согласно географических координат конечных точек (приблизительный расчёт)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_list", "description": "Список линий", "required_parameters": [], "optional_parameters": [] }, { "name": "map_color_get", "description": "Цвета кабелей на карте", "required_parameters": [], "optional_parameters": [] }, { "name": "remove_route_object", "description": "Исключение объектов на маршруте линии", "required_parameters": [], "optional_parameters": [] }, { "name": "set_geo_route", "description": "Установка географического маршрута линии", "required_parameters": [], "optional_parameters": [] }, { "name": "set_pigtail_type", "description": "Установка типа пигтейла для волокна/проводника линии", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "map", "name": "Карты покрытия", "description": "", "methods": [ { "name": "add_label", "description": "Добавление надписи", "required_parameters": [], "optional_parameters": [] }, { "name": "add_poly", "description": "Добавление полигона", "required_parameters": [], "optional_parameters": [] }, { "name": "check_entry_point_in_polygon", "description": "Список полигонов в которые входит точка", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_label", "description": "Изменение надписи", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_poly", "description": "Изменение полигона", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_poly", "description": "Список полигонов", "required_parameters": [], "optional_parameters": [] }, { "name": "map_object_facilities_inside", "description": "Получение списка объектов, что находятся внутри объекта на карте (например внутри полигона)", "required_parameters": [], "optional_parameters": [] }, { "name": "map_object_mark_add", "description": "Добавление метки на объекте на карте", "required_parameters": [], "optional_parameters": [] }, { "name": "map_object_mark_delete", "description": "Удаление метки с объекта на карте", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "key", "name": "Ключи", "description": "", "methods": [ { "name": "add", "description": "Добавление", "required_parameters": [], "optional_parameters": [] }, { "name": "get_list", "description": "Ключи", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "commutation", "name": "Коммутация", "description": "", "methods": [ { "name": "add", "description": "Коммутация объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Очистка коммутации", "required_parameters": [], "optional_parameters": [] }, { "name": "get_data", "description": "Получение массива коммутации", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "setting", "name": "Настройки", "description": "", "methods": [ { "name": "get", "description": "Получение значений параметров настройки", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_show", "description": "Вывод списка меток/слоёв для объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_add", "description": "Добавление метки/слоя для оборудования/объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_edit", "description": "Редактирование метки", "required_parameters": [], "optional_parameters": [] }, { "name": "mark_delete", "description": "Удаление метки", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "cross", "name": "ODF/Кроссы", "description": "", "methods": [ { "name": "add", "description": "Добавление", "required_parameters": [], "optional_parameters": [] }, { "name": "get_list", "description": "Список ODF/кроссов", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_adapter", "description": "Изменение свойств адаптера", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "device", "name": "Оборудование", "description": "", "methods": [ { "name": "get_connected_ont_information", "description": "Получение информации о подключенных ONU к OLT (сохраненная информация из базы. Прямой опрос не выполняется)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_current_ont_data", "description": "Получение некоторой текущей информации по ONU с OLT", "required_parameters": [], "optional_parameters": [] }, { "name": "get_device_id", "description": "Получение ID устройства по входящим данным", "required_parameters": [], "optional_parameters": [] }, { "name": "get_data", "description": "Получение информации об устройствах", "required_parameters": [], "optional_parameters": [] }, { "name": "get_iface_info", "description": "Получение текущей информации по интерфейсам (напрямую с устройства)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_iface_mac", "description": "Список интерфейсов с MAC-адресами на устройстве", "required_parameters": [], "optional_parameters": [] }, { "name": "get_mac_list", "description": "Получение списка MAC-адресов, которые были найдены на устройстве", "required_parameters": [], "optional_parameters": [] }, { "name": "get_ont_data", "description": "Получение последней информации по ONU", "required_parameters": [], "optional_parameters": [] }, { "name": "get_pon_level_history", "description": "Получение истории PON-уровней сигналов по ONU", "required_parameters": [], "optional_parameters": [] }, { "name": "get_relation_customers", "description": "Получение информации о зависимых абонентах", "required_parameters": [], "optional_parameters": [] }, { "name": "delete_mark", "description": "Снятие метки", "required_parameters": [], "optional_parameters": [] }, { "name": "read_fdb", "description": "Чтение FDB-таблицы с устройства (может выполняться продолжительное время)", "required_parameters": [], "optional_parameters": [] }, { "name": "set_data", "description": "Изменение информации об устройстве", "required_parameters": [], "optional_parameters": [] }, { "name": "set_iface_state", "description": "Изменение состояния интерфейса на устройстве", "required_parameters": [], "optional_parameters": [] }, { "name": "find_mac", "description": "Поиск MAC-адреса в истории опроса по оборудованию", "required_parameters": [], "optional_parameters": [] }, { "name": "add_mark", "description": "Добавление метки", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "redirect", "name": "Переадресация", "description": "", "methods": [] }, { "id": "trader", "name": "Поставщики", "description": "", "methods": [ { "name": "add", "description": "Добавление", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список поставщиков", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "attach", "name": "Прикрепляемые файлы", "description": "", "methods": [ { "name": "add", "description": "Добавление файла к объекту", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление файла", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Получение информации", "required_parameters": [], "optional_parameters": [] }, { "name": "get_file", "description": "Вывод содержимого файла (в бинарном виде)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_file_temporary_link", "description": "Предоставление прямой временной ссылки на загрузку файла", "required_parameters": [], "optional_parameters": [] }, { "name": "upload", "description": "Загрузка (добавление) файла к объекту", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "advertising", "name": "Рекламные кампании", "description": "", "methods": [ { "name": "add_customer", "description": "Добавление рекламной кампании абоненту", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список рекламных кампаний", "required_parameters": [], "optional_parameters": [] }, { "name": "remove_customer", "description": "Исключение абонента из рекламной кампании", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "system", "name": "Системная информация", "description": "", "methods": [ { "name": "get_system_info", "description": "Получение системной информации о САП \"Кубалинк\"", "required_parameters": [], "optional_parameters": [] }, { "name": "send_email", "description": "Отправка e-mail", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "inventory", "name": "Склад", "description": "Назначение: Действия с ТМЦ и складомДополнительные параметры:\naction - подкатегория запроса (возможное значение: см.ниже)\nВ учёте ТМЦ используется понятие как \"счет учета\".Счета представляют значения вида \"205031234567\"Первые 3 цифры:101 - Поставщики\n204 - Склад\n205 - Абонент\n206 - Сооружение связи\n210 - Кабельная линия\n212 - Задание\n213 - Здания\n214 - Склад (ТМЦ находится на данный момент в транзите)\n215 - Сотрудники\n900 - Списано\n4 и 5 цифра - субсчет01 - Подотчет долгий\n02 - Подотчет короткий\n03 - ТМЦ\n08 - Аренда\n09 - Учет проданного\n.. можно добавлять собственные субсчета\nПоследние 7 цифр - это ID объекта с ведущими нулями205031234567 - Счёт абонента id 1234567 и субсчет обычного учета ТМЦ", "methods": [ { "name": "add_inventory", "description": "Приход ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "add_inventory_assortment", "description": "Добавление наименования ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "add_inventory_section", "description": "Добавление раздела каталога товаров", "required_parameters": [], "optional_parameters": [] }, { "name": "add_inventory_to_operation", "description": "Добавление ТМЦ в операцию", "required_parameters": [], "optional_parameters": [] }, { "name": "change_arg_ip", "description": "Изменение IP-адреса в параметрах ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "change_arg_mac", "description": "Изменение MAC-адреса в параметрах ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "change_comment", "description": "Изменение заметки ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "change_price", "description": "Изменение стоимости ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "change_serial_number", "description": "Изменение серийного номера у ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "delete_inventory", "description": "Удаление СПИСАННОГО ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_inventory_assortment", "description": "Редактирование наименования ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_inventory_section", "description": "Редактирование раздела каталога товаров", "required_parameters": [], "optional_parameters": [] }, { "name": "get_inventory", "description": "Получение информации о ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "get_inventory_amount", "description": "Получение списка ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "get_inventory_catalog", "description": "Получение списка разделов каталога", "required_parameters": [], "optional_parameters": [] }, { "name": "get_inventory_catalog_id_by_name", "description": "Получение ID наименования ТМЦ по его названию", "required_parameters": [], "optional_parameters": [] }, { "name": "get_inventory_id", "description": "Получение ID ТМЦ по входящим данным", "required_parameters": [], "optional_parameters": [] }, { "name": "get_inventory_section_catalog", "description": "Получение наименований каталога ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "get_inventory_storage", "description": "Получение списка складов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_operation", "description": "Получение информации по операциям", "required_parameters": [], "optional_parameters": [] }, { "name": "split_inventory", "description": "Разделение ТМЦ", "required_parameters": [], "optional_parameters": [] }, { "name": "transfer_inventory", "description": "Перемещение ТМЦ", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "sms", "name": "SMS-сообщения", "description": "", "methods": [ { "name": "send", "description": "Отправка сообщения", "required_parameters": [], "optional_parameters": [] }, { "name": "status", "description": "Информация о сообщения", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "owner", "name": "Собственники", "description": "", "methods": [ { "name": "add", "description": "Добавление", "required_parameters": [], "optional_parameters": [] }, { "name": "bind_building", "description": "Указание собственника для здания", "required_parameters": [], "optional_parameters": [] }, { "name": "bind_fiber", "description": "Указание собственника для ВОЛС", "required_parameters": [], "optional_parameters": [] }, { "name": "bind_node", "description": "Указание собственника для объекта инфраструктуры", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление объекта", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование объекта", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "unbind_building", "description": "Исключение собственника у здания", "required_parameters": [], "optional_parameters": [] }, { "name": "unbind_fiber", "description": "Исключение собственника у ВОЛС", "required_parameters": [], "optional_parameters": [] }, { "name": "unbind_node", "description": "Исключение собственника у объекта инфраструктуры", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "employee", "name": "Сотрудники", "description": "", "methods": [ { "name": "add_notification", "description": "Создание PUSH-уведомления для сотрудника", "required_parameters": [], "optional_parameters": [] }, { "name": "address_access_add", "description": "Добавление адресного объекта в доступные адреса для сотрудника", "required_parameters": [], "optional_parameters": [] }, { "name": "address_access_list", "description": "Список доступных адресных объектов для сотрудника", "required_parameters": [], "optional_parameters": [] }, { "name": "address_access_remove", "description": "Удаление адресного объекта из доступных адресов для сотрудника", "required_parameters": [], "optional_parameters": [] }, { "name": "check_pass", "description": "Проверка совпадения логина и пароля для внешней системы", "required_parameters": [], "optional_parameters": [] }, { "name": "division_employee_add", "description": "Назначение сотрудника в подразделение", "required_parameters": [], "optional_parameters": [] }, { "name": "division_employee_remove", "description": "Исключение сотрудника из подразделения", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование записи о сотруднике", "required_parameters": [], "optional_parameters": [] }, { "name": "get_data", "description": "Получение информации о сотруднике", "required_parameters": [], "optional_parameters": [] }, { "name": "get_division", "description": "Получение информации о подразделении", "required_parameters": [], "optional_parameters": [] }, { "name": "get_division_list", "description": "Список подразделений", "required_parameters": [], "optional_parameters": [] }, { "name": "get_employee_id", "description": "Получение ID сотрудника по входящим данным", "required_parameters": [], "optional_parameters": [] }, { "name": "get_history", "description": "История действий (лимит 10000 записей в результатах выборки)", "required_parameters": [], "optional_parameters": [] }, { "name": "get_history_type", "description": "Типы действий в истории", "required_parameters": [], "optional_parameters": [] }, { "name": "get_timesheet_data", "description": "Получение информации из табеля работ", "required_parameters": [], "optional_parameters": [] }, { "name": "get_work_time_data", "description": "Получение информации о рабочем времени сотрудников", "required_parameters": [], "optional_parameters": [] }, { "name": "get_unavailable_data", "description": "Получение информации о недоступности сотрудника (отпуск, больничный)", "required_parameters": [], "optional_parameters": [] }, { "name": "set_timesheet_data", "description": "Добавление/изменение/удаление записи в табель работ", "required_parameters": [], "optional_parameters": [] }, { "name": "set_unavailable_data", "description": "Добавление/изменение/удаление записи о недоступности сотрудника (отпуск, больничный)", "required_parameters": [], "optional_parameters": [] }, { "name": "task_address_access_add", "description": "Добавление адресного объекта в список адресов, куда может быть назначен сотрудник на работы", "required_parameters": [], "optional_parameters": [] }, { "name": "task_address_access_list", "description": "Список адресов, куда может быть назначен сотрудник на работы", "required_parameters": [], "optional_parameters": [] }, { "name": "task_address_access_remove", "description": "Удаление адресного объекта из списка адресов, куда может быть назначен сотрудник на работы", "required_parameters": [], "optional_parameters": [] }, { "name": "work_time_finish", "description": "Фиксация момента окончания рабочего времени сотрудника", "required_parameters": [], "optional_parameters": [] }, { "name": "work_time_start", "description": "Фиксация момента начала рабочего времени сотрудника", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "node", "name": "Сооружения связи", "description": "", "methods": [ { "name": "add", "description": "Добавление объекта", "required_parameters": [], "optional_parameters": [] }, { "name": "add_mark", "description": "Добавление метки", "required_parameters": [], "optional_parameters": [] }, { "name": "change_custom_icon", "description": "Изменение собственного значка на карте", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление сооружения связи", "required_parameters": [], "optional_parameters": [] }, { "name": "delete_mark", "description": "Снятие метки", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование объекта", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_icon_list", "description": "Список собственных значков для объектов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_id", "description": "Получение ID объекта по входящим данным", "required_parameters": [], "optional_parameters": [] }, { "name": "get_id_by_coord", "description": "Получение ID ближайшего объекта по указанным координатам", "required_parameters": [], "optional_parameters": [] }, { "name": "get_redevelopment_scheme", "description": "Список схем перепланировки для сооружения связи", "required_parameters": [], "optional_parameters": [] }, { "name": "get_relation_customers", "description": "Получение информации о зависимых абонентах", "required_parameters": [], "optional_parameters": [] }, { "name": "get_scheme", "description": "Получение схемы коммутации", "required_parameters": [], "optional_parameters": [] }, { "name": "get_type_list", "description": "Получение список типов сооружения связи", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "tariff", "name": "Тарифы", "description": "", "methods": [ { "name": "add", "description": "Добавление тарифа", "required_parameters": [], "optional_parameters": [] }, { "name": "add_group", "description": "Добавление группы тарифов", "required_parameters": [], "optional_parameters": [] }, { "name": "add_tariff_in_group", "description": "Добавление тарифа в группу тарифов", "required_parameters": [], "optional_parameters": [] }, { "name": "delete_group", "description": "Удаление группы тарифов", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование тарифа", "required_parameters": [], "optional_parameters": [] }, { "name": "edit_group", "description": "Редактирование группы тарифов", "required_parameters": [], "optional_parameters": [] }, { "name": "get", "description": "Список тарифов", "required_parameters": [], "optional_parameters": [] }, { "name": "get_group", "description": "Информация о группах тарифов", "required_parameters": [], "optional_parameters": [] }, { "name": "remove_tariff_from_group", "description": "Исключение тарифа из группы тарифов", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "vlan", "name": "VLAN", "description": "", "methods": [ { "name": "add", "description": "Добавление vlan", "required_parameters": [], "optional_parameters": [] }, { "name": "customer_add_to_vlan", "description": "Добавление абонента к vlan", "required_parameters": [], "optional_parameters": [] }, { "name": "customer_remove_from_vlan", "description": "Исключение абонента из vlan", "required_parameters": [], "optional_parameters": [] }, { "name": "delete", "description": "Удаление vlan", "required_parameters": [], "optional_parameters": [] }, { "name": "edit", "description": "Редактирование vlan", "required_parameters": [], "optional_parameters": [] }, { "name": "get_list", "description": "Получение списка vlan", "required_parameters": [], "optional_parameters": [] } ] }, { "id": "gps", "name": "GPS-трекеры", "description": "", "methods": [ { "name": "get_info", "description": "Общая информация по трекеру", "required_parameters": [], "optional_parameters": [] }, { "name": "get_list", "description": "Список трекеров", "required_parameters": [], "optional_parameters": [] }, { "name": "get_route", "description": "Маршрут движения", "required_parameters": [], "optional_parameters": [] }, { "name": "set_position", "description": "Установить позицию для трекера", "required_parameters": [], "optional_parameters": [] } ] } ] }