SIGNL4 — оповещение мобильных устройств

SIGNL4 предлагает критически важные оповещения для мобильных устройств, реагирование на инциденты и отправку служб для операционной критической инфраструктуры. Он постоянно оповещает вас с помощью push-отправки приложений, SMS-текста и голосовых звонков, включая отслеживание, эскалацию, совместную работу и планирование обязанностей.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Derdack GmbH
URL	https://www.signl4.com/feedback-we-love-hear-from-you/
Адрес электронной почты	success@signl4.com

Метаданные соединителя
Publisher	Derdack
Website	https://www.signl4.com
Политика конфиденциальности	https://www.signl4.com/privacy-policy/
Категории	ИТ-операции; Коммуникация

SIGNL4 предлагает критически важные оповещения, реагирование на инциденты и отправку служб для операционной критической инфраструктуры. Он постоянно оповещает вас с помощью push-отправки приложений, SMS-текста и голосовых звонков, включая отслеживание, эскалацию, совместную работу и планирование обязанностей.

Вы можете интегрировать SIGNL4 в поток для отправки надежных оповещений команды при необходимости.

Предпосылки

Вам нужна учетная запись SIGNL4. Если у вас еще нет одного, вы можете получить один на https://connect.signl4.com/. Вы также можете напрямую скачать мобильное приложение из Google Play Store или из Apple App Store.

Получение учетных данных

Чтобы использовать соединитель, вам нужен ключ API SIGNL4. На веб-портале SIGNL4 вы получите ключ API в разделе интеграции —> ключ API. Затем вы можете использовать ключ API для проверки подлинности соединителя SIGNL4 в Power Automate.

Начало работы с соединителем

Подробное описание функций API SIGNL4 можно найти здесь. После добавления соединителя SIGNL4 в поток Power Automate необходимо получить ключ API SIGNL4. Затем можно использовать функции API соответствующим образом. Если у вас должны быть дополнительные вопросы, пожалуйста, не стесняйтесь связаться с командой SIGNL4.

Самый простой способ начать — использовать действие EventsSend для отправки оповещения:

Сначала получите секрет команды SIGNL4 или секрет интеграции с веб-портала SIGNL4.
Если у вас есть секрет команды или секрет интеграции, вы можете использовать этот секрет в функции EventsSend для активации события, которое может создать оповещение для вашей команды. Вам просто нужно ввести любой заголовок и сообщение. Описание других параметров можно найти на странице документации по входящего веб-перехватчика.
Это так, и теперь вы активируете событие и получаете оповещение в SIGNL4.

Известные проблемы и ограничения

Соединитель SIGNL4 для Power Automate инкапсулирует весь REST API SIGNL4 2.0. Некоторые функции зависят от плана SIGNL4.

Распространенные ошибки и средства устранения неполадок

N/A

Часто задаваемые вопросы

Здесь можно найти часто задаваемые вопросы о SIGNL4 и справку по интернету. Кроме того, доступна комплексная видеотека .

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Acknowlegde несколько оповещений	Этот метод подтверждает все предоставленные оповещения.
Включает экземпляр скрипта	Включает экземпляр скрипта.
Возвращает все доступные скрипты инвентаризации	Возвращает все доступные скрипты инвентаризации, которые можно добавить в подписку SIGNL4.
Возвращает все сведения о заданном экземпляре скрипта	Возвращает экземпляр скрипта, указанный идентификатором переданного экземпляра.
Возвращает все скрипты инвентаризации	Возвращает все скрипты инвентаризации.
Возвращает все экземпляры скриптов команды SIGNL4	Возвращает все экземпляры скриптов в подписке.
Возвращает имена всех образов категорий оповещений	Возвращает имена всех образов категорий оповещений. Чтобы получить изображение, перейдите к account.signl4.com/images/alerts/categoryImageName.svg.
Возвращает источники событий определенной команды	Возвращает источники событий определенной команды.
Возвращает лицензии голосового номера подписки	Получает лицензии голосового номера подписки.
Возвращает лицензии пользователя подписки	Получает лицензии пользователя подписки.
Возвращает отчет об оповещении	Возвращает отчет об оповещении.
Возвращает параметры оповещений определенной команды	Возвращает параметры оповещений определенной команды.
Возвращает параметры оповещений определенной команды	Возвращает параметры оповещений определенной команды.
Возвращает сведения конкретной команды	Возвращает сведения конкретной команды.
Возвращает сведения о расписании обязанностей с указанным идентификатором	Возвращает сведения о расписании обязанностей с указанным идентификатором.
Возвращает сведения о ценах на канал подписки	Возвращает сведения о цене канала подписки.
Возвращает сведения обо всех запланированных расписаниях	Возвращает сведения обо всех запланированных расписаниях.
Возвращает скрипт инвентаризации по идентификатору	Возвращает скрипт, указанный идентификатором переданного скрипта.
Возвращает удаленное действие	Пример запроса: `GET /RemoteActions/{actionId}`
Возвращает удаленное задание из журнала	Пример запроса: `GET /remoteActions/journal/{jobId}`
Возвращает удаленные действия	Пример запроса: `GET /RemoteActions?externalId=12345`
Возвращает удаленные задания, страницы из журнала	Пример запроса: `POST /remoteActions/journal/paged?maxResults=100 { "statusCode": "Executed" }`
Возвращает указанное вложение указанного оповещения	Возвращает указанное вложение указанного оповещения.
Возвращает функции указанной подписки	Возвращает функции указанной подписки.
Возможность включения веб-перехватчика	Возможность включения веб-перехватчика.
Возможность отключения веб-перехватчика	Возможность отключения веб-перехватчика.
Добавление пользователя в команду	Добавьте пользователя в команду.
Задает параметры генерации оповещений определенной команды	Задает параметры генерации оповещений определенной команды.
Закройте все подтверждения оповещений	Этот метод закрывает все подтверждения оповещений, которые у вашей команды сейчас есть.
Закройте оповещение	Закройте оповещение.
Закрытие нескольких оповещений	Этот метод закрывает все предоставленные оповещения.
Копирование праздников из одной команды в другую	Скопируйте праздники из одной команды в другую.
Настройка номера телефона пользователя	Задайте номер телефона пользователя. Если сохраняется другой номер телефона, он будет перезаписан.
Настройка подписок категорий	Пример запроса: `POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { }`
Настройка профилей уведомлений для пользователя	Задайте профили уведомлений для пользователя.
Обновление веб-перехватчика по идентификатору	Обновляет указанный веб-перехватчик.
Обновление источника событий	Обновление источника событий.
Обновление параметров конфиденциальности для команды	Обновите параметры конфиденциальности для команды.
Обновление пароля пользователя	Обновляет пароль пользователя.
Обновление профиля подписок	Обновляет профиль подписок.
Обновление сведений о языковом стандарте (например, язык, часовой пояс) для пользователя	Обновите сведения о языковом стандарте (например, язык, часовой пояс) для пользователя.
Обновление существующего шаблона выноски для подписки	Обновите существующий шаблон выноски для подписки.
Обновление существующего шаблона оповещения	Обновите существующий шаблон оповещений.
Обновление существующей категории	Пример запроса: `PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e { "name": "Water-Updated", "imageName": "water.svg", "color": "#0000cc", "keywordMatching": "All", "keywords": [ { "value": "H2O" }, { "value": "Water" }, { "value": "Wet" } ] }`
Обновление текущих параметров предоплаченной подписки	Обновите текущие параметры предоплаченной подписки.
Обновление текущих параметров предоплаченной подписки	Обновите текущие параметры предоплаченной подписки.
Обновление удаленного действия	Пример запроса: `PUT /remoteActions/{actionId} { "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7", "name": "MyAction", "enabled": true, }`
Обновление членства в команде пользователя	Обновляет членство в команде пользователя. Вы можете переместить пользователя в другую команду в подписке и /или изменить роль пользователя.
Обновляет заданный экземпляр скрипта	Обновляет указанный экземпляр скрипта, обычно используемый для обновления конфигурации скрипта.
Обновляет пользовательские данные заданного экземпляра скрипта, включающее отображаемое имя.	Обновляет указанный экземпляр скрипта.
Обновляет профиль группы	Обновляет профиль команды.
Обновляет профиль пользователя	Обновляет профиль пользователя.
Оповещение об аннотации	Заметит оповещение, указав сведения о заметках.
Оповещение триггера	Активирует новое оповещение для вашей команды. Все члены команды по обязанности получат уведомления об оповещениях.
Отключает заданный экземпляр скрипта	Отключает заданный экземпляр скрипта.
Отмена закрытия нескольких оповещений	Этот метод пытается отменить закрытие нескольких оповещений. Операция обрабатывается в фоновом режиме.
Отмена закрытия оповещения	Этот метод пытается отменить закрытие оповещения.
Отмена очереди нескольких подтверждений	Этот метод пытается отменить подтверждение нескольких оповещений через очередь. Операция обрабатывается в фоновом режиме.
Отмена подтверждения оповещения	Этот метод пытается отменить подтверждение оповещения.
Отправка оповещений вручную в команду	Переведите оповещение вручную в команду.
Отправлен образ профиля для указанного пользователя	Отправлен образ профиля для указанного пользователя.
Отправлен образ профиля для указанной команды	Отправлен образ профиля для указанной команды.
Отправляет сообщение указанному пользователю	Отправляет сообщение указанному пользователю, содержащее сведения обо всех источниках событий команды пользователя.
Отправляет сообщение электронной почты, если приглашение существует	Отправляет сообщение электронной почты, если приглашение существует.
Подтверждает все видимые оповещения	Этот метод подтверждает все необработанные оповещения, которые ваша команда в настоящее время имеет определенного пользователя.
Подтверждение оповещения	Подтвердите оповещение.
Получает изображение указанной команды	Получает изображение указанной команды.
Получает ход установки определенного пользователя	Получает ход установки определенного пользователя.
Получает ход установки определенной команды	Получает ход установки определенной команды.
Получение веб-перехватчика по идентификатору	Возвращает сведения веб-перехватчика, указанного переданным идентификатором.
Получение веб-перехватчиков	Возвращает коллекцию определенных исходящих веб-перехватчиков в системе.
Получение всех доступных определений	Получение всех доступных определений.
Получение всех категорий	Получение всех категорий.
Получение всех категорий	Пример запроса: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7`
Получение всех команд, в которые входит пользователь	Возвращает список объектов группы с подробными сведениями, такими как их имя. Возвращаются только команды, в которые входит пользователь.
Получение всех пользователей	Возвращает список объектов пользователя с подробными сведениями, такими как адрес электронной почты и сведения об обязанностях. Будут возвращены только пользователи, к которых у вас есть доступ.
Получение всех пользователей указанных команд	Получение всех пользователей указанных команд.
Получение всех шаблонов выносок для подписки	Получите все шаблоны выносок для подписки.
Получение всех шаблонов оповещений из команды	Получите все шаблоны оповещений из команды.
Получение записей временной шкалы оповещений	Получение записей временной шкалы оповещений по идентификатору.
Получение источника события по идентификатору	Получение источника события по идентификатору.
Получение источников событий из одной или нескольких команд	Получение источников событий из одной или нескольких команд.
Получение личного образа пользователя	Получите личный образ пользователя.
Получение метрик для всех категорий	Пример запроса: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics`
Получение метрик для определенной категории	Пример запроса: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics`
Получение общедоступной информации обо всех командах в подписке	Получение общедоступной информации обо всех командах в подписке.
Получение оповещений на странице	Возвращает страницы оповещений.
Получение оповещения	Возвращает оповещение по идентификатору.
Получение определения	Получение определения.
Получение определенной категории	Пример запроса: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e`
Получение отчета об оповещении	Возвращает сведения о томе оповещений в разных периодах времени, а также сведения о поведении ответа (объем подтвержденных и необработанных оповещений) членов команды.
Получение параметров конфиденциальности команды	Получение параметров конфиденциальности группы для команды.
Получение параметров обязанностей команды для нескольких команд	Получение параметров обязанностей команды для нескольких команд.
Получение параметров события	Получение параметров события по идентификатору.
Получение подписок категорий	Пример запроса: `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { }`
Получение пользователя по идентификатору	Возвращает объект пользователя с подробными сведениями, такими как адрес электронной почты и сведения о обязанностях.
Получение праздников для команды	Получить праздники для команды.
Получение предоплаченных транзакций подписки	Получение предоплаченных транзакций подписки.
Получение предоплаченных транзакций подписки	Получение предоплаченных транзакций подписки.
Получение профилей уведомлений для пользователя	Получение профилей уведомлений для пользователя.
Получение сведений для всех команд подписки	Получение сведений для всех команд подписки.
Получение сведений о вложениях оповещения	Получение вложений оповещения по идентификатору.
Получение сведений о конкретной подписке	Получение сведений о конкретной подписке.
Получение сведений о помощнике по обязанностям для команд	Получение сведений о помощнике по обязанностям для команд.
Получение сведений о скачиваемых отчетах оповещений	Получение сведений о скачиваемых отчетах оповещений.
Получение сведений о событии	Получение сведений о событии.
Получение сведений об оповещении	Получение сведений об оповещении.
Получение сведений обо всех доступных и управляемых подписках	Получение сведений обо всех доступных или управляемых подписках.
Получение сведений обо всех командах	Получение сведений обо всех командах.
Получение события обзора	Получение события обзора по идентификатору.
Получение состояния обязанности по идентификатору пользователя	Возвращает объект с сведениями о обязанностях.
Получение страницы событий обзора	Получение страницы событий обзора. Если есть дополнительные результаты, вы также получите маркер продолжения, который можно добавить в фильтр событий.
Получение текущего предоплаченного баланса подписки	Получение текущего предоплаченного баланса подписки.
Получение текущего предоплаченного баланса подписки	Получите текущий предоплаченный баланс подписки.
Получение текущих параметров предоплаченной подписки	Получение текущих параметров предоплаченной подписки.
Получение текущих параметров предоплаченной подписки	Получите текущие параметры предоплаченной подписки.
Получение уведомлений оповещений	Получение уведомлений обо всех пользователях по идентификатору оповещения.
Получение членства в команде	Получение членства в команде.
Получение членства в команде от пользователя	Получение членства в команде от пользователя.
Приглашение пользователей в команду	Пригласите пользователей в команду.
Проверка интервалов времени шаблона	Проверьте интервалы времени шаблона для всех существующих слотов времени других шаблонов.
Проверяет, имеет ли пользователь предоставленный разрешение	Проверяет, имеет ли пользователь предоставленный разрешение.
Проверяет предыдущий созданный номер телефона для пользователя	Проверяет предыдущий созданный номер телефона для пользователя.
Скачивание отчета об обязанности с определенным именем файла	Скачайте отчет о обязанностях с определенным именем файла.
Событие Send	Отправить событие.
Создает новый экземпляр скрипта в команде SIGNL4	Создает новый экземпляр скрипта скрипта, указанного в тексте запроса.
Создание веб-перехватчика	Создает новый исходящий веб-перехватчик, который будет получать уведомления при возникновении определенных событий.
Создание источника событий	Создайте источник события.
Создание нового шаблона оповещений	Создайте шаблон оповещений.
Создание новой категории	Пример запроса: `POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7 { "name": "Water", "imageName": "water.svg", "color": "#0000cc", "keywordMatching": "Any", "keywords": [ { "value": "H2O" }, { "value": "Water" } ] }`
Создание удаленного действия	Пример запроса: `POST /remoteActions { "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7", "name": "MyAction", "enabled": true, }`
Создание удаленного задания	Пример запроса: `POST /remoteActions/{actionId}/jobs { "remoteActionPin" : "1234", "parameters": [ { "name": "Param1", "value": "Value 1" } ] }`
Создание шаблонов выносок для подписки	Создайте новые шаблоны выносок для подписки.
Сохранение нескольких расписаний	Сохраните несколько расписаний. При желании можно переопределить существующие расписания.
Сохранение повторяющихся праздников для команды	Сохраните повторяющиеся праздники для команды.
Сохранение праздников для команды	Сохраните праздники для команды.
Срез или обновление заданного расписания обязанностей	Создание и обновление заданного расписания обязанностей.
Удаление адреса контакта от пользователя	Удаление адреса контакта от пользователя.
Удаление веб-перехватчика по идентификатору	Удаляет указанный веб-перехватчик, чтобы он больше не был уведомлен.
Удаление источника событий	Удаление источника событий.
Удаление личного образа пользователя	Удаление личного образа пользователя.
Удаление номера телефона пользователя	Удалите номер телефона пользователя.
Удаление определенного шаблона генерации оповещений	Удалите определенный шаблон оповещений.
Удаление определенной обязанности	Удаление определенной обязанности.
Удаление праздников	Удаление праздников.
Удаление расписаний обязанностей в диапазоне	Удаление расписаний обязанностей в диапазоне.
Удаление распространения событий	Удаление распространения событий.
Удаление существующего шаблона выноски из подписки	Удалите существующий шаблон выноски из подписки.
Удаление существующей категории	Пример запроса: `DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e`
Удаляет пользователя или приглашение из команды	Удаляет пользователя или приглашение из команды.
Удаляет текущий образ команды	Удаляет текущий образ команды.
Удаляет удаленное действие	Пример запроса: `DELETE /eaRemoteActions/{actionId}`
Удаляет учетную запись пользователя	Удаляет учетную запись пользователя.
Удаляет экземпляр скрипта	Возвращает экземпляр скрипта, указанный идентификатором переданного экземпляра.
Удар пользователя	Указанный пользователь будет выбит из обязанности.
Удар пользователя в	Указанный пользователь будет ударить по обязанности.
Удар пользователя в качестве диспетчера	Указанный пользователь будет ударить в обязанности руководителя.
Установка расположения пользователя	Задайте расположение пользователя.

Acknowlegde несколько оповещений

Идентификатор операции:: AlertsAcknowledgeMultiple

Этот метод подтверждает все предоставленные оповещения.

Параметры

Имя	Ключ	Обязательно	Тип
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Включает экземпляр скрипта

Идентификатор операции:: ScriptsEnable

Включает экземпляр скрипта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор экземпляра скрипта	instanceId	True	string	Идентификатор экземпляра, который требуется включить.

Возвращаемое значение

Тело: ScriptInstanceDetails

Возвращает все доступные скрипты инвентаризации

Идентификатор операции:: ScriptsGetAvailable

Возвращает все доступные скрипты инвентаризации, которые можно добавить в подписку SIGNL4.

Возвращаемое значение

response: array of InventoryScriptInfo

Возвращает все сведения о заданном экземпляре скрипта

Идентификатор операции:: ScriptsGetInfo

Возвращает экземпляр скрипта, указанный идентификатором переданного экземпляра.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор экземпляра скрипта	instanceId	True	string	Идентификатор экземпляра скрипта для возврата.

Возвращаемое значение

Тело: ScriptInstanceDetails

Возвращает все скрипты инвентаризации

Идентификатор операции:: ScriptsGetAll76

Возвращает все скрипты инвентаризации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Language	language		string	Language

Возвращаемое значение

response: array of InventoryScriptInfo

Возвращает все экземпляры скриптов команды SIGNL4

Идентификатор операции:: ScriptsGetAll

Возвращает все экземпляры скриптов в подписке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы команд	teamId		array	Идентификаторы команд.
Изменено с момента	modifiedSince		date-time	Изменено с тех пор.

Возвращаемое значение

response: array of ScriptInstanceInfo

Возвращает имена всех образов категорий оповещений

Идентификатор операции:: CategoriesGetImageNames

Возвращает имена всех образов категорий оповещений. Чтобы получить изображение, перейдите к account.signl4.com/images/alerts/categoryImageName.svg.

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of string

Возвращает источники событий определенной команды

Идентификатор операции:: TeamsGetEventSources

Возвращает источники событий определенной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которого должны быть получены источники.

Возвращаемое значение

response: array of EventSourceEndpointInfo

Возвращает лицензии голосового номера подписки

Идентификатор операции:: SubscriptionsGetVoiceNumberLicense

Получает лицензии голосового номера подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки

Возвращаемое значение

Тело: UserLicenseInfo

Возвращает лицензии пользователя подписки

Идентификатор операции:: SubscriptionsGetUserLicenses

Получает лицензии пользователя подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки

Возвращаемое значение

Тело: UserLicenseInfo

Возвращает отчет об оповещении

Идентификатор операции:: TeamsGetAlertReport

Возвращает отчет об оповещении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которой вы хотите получить сведения о файле отчета о обязанностях.
Имя файла	fileName	True	string	Имя файла, который требуется скачать.

Возвращаемое значение

response: binary

Возвращает параметры оповещений определенной команды

Идентификатор операции:: TeamsGetAlertSettings

Возвращает параметры оповещений определенной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId		array	ID команды.

Возвращаемое значение

Тело: MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

Возвращает параметры оповещений определенной команды

Идентификатор операции:: TeamsGetAlertSettings99

Возвращает параметры оповещений определенной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которого должны быть получены параметры.

Возвращаемое значение

Тело: AlertSettings

Возвращает сведения конкретной команды

Идентификатор операции:: TeamsGetInfo

Возвращает сведения конкретной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, которую необходимо получить.

Возвращаемое значение

Тело: TeamInfo

Возвращает сведения о расписании обязанностей с указанным идентификатором

Идентификатор операции:: DutiesGetInfo

Возвращает сведения о расписании обязанностей с указанным идентификатором.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит долг
Идентификатор расписания обязанностей	scheduleId	True	string	Идентификатор запрошенного расписания обязанностей.

Возвращаемое значение

Тело: ScheduleInfo

Возвращает сведения о ценах на канал подписки

Идентификатор операции:: SubscriptionsGetChannelPriceInfo

Возвращает сведения о цене канала подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки, которую необходимо получить.

Возвращаемое значение

Тело: ChannelPriceInfo

Возвращает сведения обо всех запланированных расписаниях

Идентификатор операции:: SchedulesGetPlanned

Возвращает сведения обо всех запланированных расписаниях.

Параметры

Имя	Ключ	Тип
limit	limit	integer
minDate	minDate	date-time
TeamIds	teamIds	array of string
userId	userId	string

Возвращаемое значение

response: array of V2.ScheduleDetails

Возвращает скрипт инвентаризации по идентификатору

Идентификатор операции:: ScriptsGet

Возвращает скрипт, указанный идентификатором переданного скрипта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор скрипта	scriptId	True	string	Идентификатор возвращаемого скрипта.
Language	language		string	Language

Возвращаемое значение

Тело: ScriptInstanceDetails

Возвращает удаленное действие

Идентификатор операции:: RemoteActionsGet

Пример запроса:

GET /RemoteActions/{actionId}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор действия	actionId	True	string	Идентификатор возвращаемого действия
Language	language		integer	0 = EN 1 = DE

Имя

Ключ

Обязательно

Тип

Описание

Идентификатор действия

actionId

True

string

Идентификатор возвращаемого действия

Language

language

integer

0 = EN
1 = DE

Возвращаемое значение

Тело: V2.RemoteActionDetails

Возвращает удаленное задание из журнала

Идентификатор операции:: RemoteActionsGetJob

Пример запроса:

GET /remoteActions/journal/{jobId}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор задания	jobId	True	string	Идентификатор возвращаемого задания
Language	language		integer	0 = EN 1 = DE

Имя

Ключ

Обязательно

Тип

Описание

Идентификатор задания

jobId

True

string

Идентификатор возвращаемого задания

Language

language

integer

0 = EN
1 = DE

Возвращаемое значение

Тело: V2.RemoteJob

Возвращает удаленные действия

Идентификатор операции:: RemoteActionsGetActions

Пример запроса:

GET /RemoteActions?externalId=12345

Параметры

Имя	Ключ	Тип	Описание
Идентификатор команды	teamId	string	Идентификатор команды
Внешний идентификатор	externalId	string	Необязательный фильтр для внешнего идентификатора
Тип	type	integer	0 = неизвестно 1 = скрипт 2 = EnterpriseAlert 3 = веб-перехватчик
Служба исполнителя	executorService	string	Служба исполнителя
Language	language	integer	0 = EN 1 = DE

Возвращаемое значение

response: array of V2.RemoteActionInfo

Возвращает удаленные задания, страницы из журнала

Идентификатор операции:: RemoteActionsGetJobsPaged

Пример запроса:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}

Параметры

Имя	Ключ	Тип	Описание
Максимальное количество результатов	maxResults	integer	Максимальное количество результатов
Language	language	integer	0 = EN 1 = DE
actionId	actionId	string
continuationToken	continuationToken	string
maxCreationDate	maxCreationDate	date-time
minCreationDate	minCreationDate	date-time
modifiedSince	modifiedSince	date-time
statusCodes	statusCodes	integer	0 = нет 1 = ожидание 2 = готово 4 = выполнение 8 = выполнено 16 = ошибка

Возвращаемое значение

Тело: PagedResultsPublic-1-V2.RemoteJob-

Возвращает указанное вложение указанного оповещения

Идентификатор операции:: AlertsGetAttachment

Возвращает указанное вложение указанного оповещения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор оповещения, содержащего нужное вложение.
Идентификатор вложения	attachmentId	True	string	Идентификатор вложения, который требуется получить.
Ширина изображения	width		integer	Необязательный параметр, определяющий требуемую ширину полученного рисунка.
Высота изображения	height		integer	Необязательный параметр, определяющий нужную высоту полученного рисунка.
Scale	scale		boolean	Необязательный параметр, определяющий, требуется ли масштабирование полученного изображения. По умолчанию установлено значение true.

Возвращаемое значение

response: binary

Возвращает функции указанной подписки

Идентификатор операции:: SubscriptionsGetFeatures

Возвращает функции указанной подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки, из которой необходимо получить компоненты.

Возвращаемое значение

response: array of SubscriptionFeature

Возможность включения веб-перехватчика

Идентификатор операции:: WebhooksDisable

Возможность включения веб-перехватчика.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор веб-перехватчика	webhookId	True	string	Идентификатор веб-перехватчика для веб-перехватчика, который должен быть отключен.

Возвращаемое значение

Тело: WebhookInfo

Возможность отключения веб-перехватчика

Идентификатор операции:: WebhooksEnable

Возможность отключения веб-перехватчика.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор веб-перехватчика	webhookId	True	string	Идентификатор веб-перехватчика для веб-перехватчика, который должен быть включен.

Возвращаемое значение

Тело: WebhookInfo

Добавление пользователя в команду

Идентификатор операции:: TeamsAddUser

Добавьте пользователя в команду.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, в который должен быть приглашен пользователь.
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, который вы хотите добавить в команду.
roleId	roleId		string
setUserOnDuty	setUserOnDuty		boolean

Возвращаемое значение

Тело: V2.TeamMembershipDetails

Задает параметры генерации оповещений определенной команды

Идентификатор операции:: TeamsSetAlertSettings

Задает параметры генерации оповещений определенной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для настройки параметров должен быть задан.
escEnabled	escEnabled		boolean
escMode	escMode		integer	0 = диспетчер 1 = команда
escRefId	escRefId		string
filterAction	filterAction		integer	0 = подавление 1 = скрыть 2 = Отключение
filterMode	filterMode		integer	0 = выкл. 1 = WhiteListAllCategories
канал	channel		integer	0 = нет 1 = Push 2 = голос 3 = SMS
delay	delay		integer
enabled	enabled		boolean
optOut	optOut		integer	0 = нет 1 = отключено 2 = личное
overrideNotificationProfiles	overrideNotificationProfiles		boolean
persNotInterval	persNotInterval		integer
persNotMode	persNotMode		integer	0 = выкл. 1 = сводка
responseMode	responseMode		integer	2 = SingleAcknowledge 4 = MultiAcknowledge
responseTime	responseTime		integer

Возвращаемое значение

Тело: AlertSettings

Закройте все подтверждения оповещений

Идентификатор операции:: AlertsCloseAll

Этот метод закрывает все подтверждения оповещений, которые у вашей команды сейчас есть.

Параметры

Имя	Ключ	Тип	Описание
Идентификатор пользователя	userId	string	Идентификатор пользователя, который будет использоваться для закрытия оповещений.
categoryIds	categoryIds	array of string
maxDate	maxDate	date-time
minDate	minDate	date-time
scope	scope	integer	0 = по умолчанию 1 = AllTeams 2 = SpecificTeams
TeamIds	teamIds	array of string

Закройте оповещение

Идентификатор операции:: AlertsClose

Закройте оповещение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор для подтверждения оповещения.
descr	descr		string
uid	uid	True	string

Возвращаемое значение

Тело: V2.AlertInfo

Закрытие нескольких оповещений

Идентификатор операции:: AlertsCloseMultiple

Этот метод закрывает все предоставленные оповещения.

Параметры

Имя	Ключ	Обязательно	Тип
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Копирование праздников из одной команды в другую

Идентификатор операции:: TeamsCopyHolidays

Скопируйте праздники из одной команды в другую.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, в которую вы хотите скопировать праздники
Год	year	True	integer	Год, из которого вы хотите скопировать
Идентификатор команды	sourceTeamId	True	string	Идентификатор команды, из которой вы хотите скопировать праздники

Возвращаемое значение

Тело: V2.TeamHolidayDetails

Настройка номера телефона пользователя

Идентификатор операции:: UsersSetPhoneNumber

Задайте номер телефона пользователя. Если сохраняется другой номер телефона, он будет перезаписан.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, в который вы хотите добавить номер телефона
код страны	countryCode		string
номер телефона	phoneNumber		string
sendValidationCode	sendValidationCode		boolean
sendValidationCodeVia	sendValidationCodeVia		integer	0 = нет 1 = SMS 2 = голос

Возвращаемое значение

Тело: V2.UserPhoneNumberDetails

Настройка подписок категорий

Идентификатор операции:: CategoriesSetSubscription

Пример запроса:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория
Идентификатор категории	categoryId	True	string	Категория для обновления
статус	status	True	integer	0 = подписка 1 = Отключение 2 = скрытый
userId	userId	True	string

Возвращаемое значение

response: array of CategorySubscriptionInfo

Настройка профилей уведомлений для пользователя

Идентификатор операции:: UsersSetNotificationProfile

Задайте профили уведомлений для пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, из которого вы хотите получить профили уведомлений.
канал	channel		integer	0 = нет 1 = Push 2 = электронная почта 4 = Bot 8 = голос 16 = SMS
delayInMinutes	delayInMinutes		integer
enabled	enabled		boolean
options	options		integer
упорный	persistent		boolean

Возвращаемое значение

response: array of V2.NotificationProfileDetails

Обновление веб-перехватчика по идентификатору

Идентификатор операции:: WebhooksUpdate

Обновляет указанный веб-перехватчик.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор исходящего веб-перехватчика	webhookId	True	string	Идентификатор обновляемого исходящего веб-перехватчика.
описание	description		string
extUrl	extUrl	True	string
имя	name	True	string
teamId	teamId		string

Возвращаемое значение

Тело: WebhookInfo

Обновление источника событий

Идентификатор операции:: EventSourcesUpdate

Обновление источника событий.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор источника событий	eventSourceId	True	string	Идентификатор источника события
описание	description		string
disabled	disabled		boolean
имя	name		string
teamId	teamId		string

Возвращаемое значение

Тело: EventSourceEndpointInfo

Обновление параметров конфиденциальности для команды

Идентификатор операции:: TeamsUpdatePrivacySettings

Обновите параметры конфиденциальности для команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды
hideContactAddresses	hideContactAddresses		boolean
hideDutyData	hideDutyData		boolean
hideForEscalation	hideForEscalation		boolean

Возвращаемое значение

Тело: V2.TeamPrivacySettingsDetails

Обновление пароля пользователя

Идентификатор операции:: UsersUpdatePassword

Обновляет пароль пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, пароль которого должен быть изменен.
currentPassword	currentPassword		string
newPassword	newPassword		string

Обновление профиля подписок

Идентификатор операции:: SubscriptionsUpdateProfile

Обновляет профиль подписок.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор обновляемой подписки
имя	name		string

Возвращаемое значение

Тело: SubscriptionInfo

Обновление сведений о языковом стандарте (например, язык, часовой пояс) для пользователя

Идентификатор операции:: UsersUpdateLocaleInfo

Обновите сведения о языковом стандарте (например, язык, часовой пояс) для пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, электронная почта или "я" для пользователя, которого вы хотите обновить
language	language		string
часовой пояс	timeZone		string

Возвращаемое значение

Тело: V2.UserLocaleResponseDetails

Обновление существующего шаблона выноски для подписки

Идентификатор операции:: CalloutsUpdateTemplate

Обновите существующий шаблон выноски для подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД шаблона	templateId	True	string	Идентификатор шаблона, который требуется обновить
categoryId	categoryId		string
externalId (внешний идентификатор)	externalId		string
id	id		string
location	location		string
имя	name		string
субъект	subject		string
targetAllTeams	targetAllTeams		boolean
targetTeamId	targetTeamId		string
текст	text		string
workflowType	workflowType		integer	0 = AsConfiguredInTeam 2 = TeamBroadcast 4 = MultiAcknowledge 5 = MultiAcknowledgeEmergency

Возвращаемое значение

response: array of V2.CalloutTemplateDetails

Обновление существующего шаблона оповещения

Идентификатор операции:: TeamsUpdateAlertPattern

Обновите существующий шаблон оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которого вы хотите создать шаблон
Идентификатор шаблона	patternId	True	string	Идентификатор шаблона для обновления
categories	categories		array of string
enabled	enabled		boolean
mode	mode		integer	0 = диспетчер 1 = команда
referenceId	referenceId		string
id	id		string
имя	name		string
канал	channel		integer	0 = нет 1 = Push 2 = голос 3 = SMS
delayInMinutes	delayInMinutes		integer
enabled	enabled		boolean
overrideEscalationSettings	overrideEscalationSettings		boolean
overrideNotificationProfiles	overrideNotificationProfiles		boolean
overrideResponseSettings	overrideResponseSettings		boolean
responseMode	responseMode		integer	2 = SingleAcknowledge 4 = MultiAcknowledge
responseTime	responseTime		integer
suppressSignl	suppressSignl		boolean
час	hour		integer
протокол	minutes		integer
будний день	weekday		integer	0 = Праздник 1 — понедельник; 2 — вторник; 3 — среда; 4 — четверг; 5 — пятница; 6 — суббота. 7 = воскресенье
id	id		string

Возвращаемое значение

Тело: V2.AlertingPatternDetails

Обновление существующей категории

Идентификатор операции:: CategoriesUpdate

Пример запроса:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория
Идентификатор категории	categoryId	True	string	Идентификатор категории
enabled	enabled		boolean
id	id		string
имя	name		string
type	type	True	integer	0 = параметр 1 = тема 2 = текст 3 = расположение
value	value		string
color	color	True	string
id	id		string
имя	name		string
type	type	True	integer	0 = параметр 1 = гиперссылка
value	value		string
id	id		string
imageName	imageName	True	string
isDefault	isDefault		boolean
keywordMatching	keywordMatching	True	integer	0 = любой 1 = все
ключевые слова	keywords	True	array of string
keywordsExcluded	keywordsExcluded		array of string
имя	name	True	string
options	options		integer	0 = нет 1 = скрытый 2 = DenyDelete 4 = HideOptOut 8 = HideKeywords
заказ	order		integer
teamId	teamId		string

Возвращаемое значение

Тело: CategoryInfo

Обновление текущих параметров предоплаченной подписки

Идентификатор операции:: PrepaidUpdateSettings55

Обновите текущие параметры предоплаченной подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки
topUpAmount	topUpAmount		integer
topUpEnabled	topUpEnabled		boolean
topUpLimit	topUpLimit		integer

Возвращаемое значение

Тело: PrepaidSettingsInfo

Обновление текущих параметров предоплаченной подписки

Идентификатор операции:: PrepaidUpdateSettings

Обновите текущие параметры предоплаченной подписки.

Параметры

Имя	Ключ	Тип
topUpAmount	topUpAmount	integer
topUpEnabled	topUpEnabled	boolean
topUpLimit	topUpLimit	integer

Возвращаемое значение

Тело: PrepaidSettingsInfo

Обновление удаленного действия

Идентификатор операции:: RemoteActionsUpdate

Пример запроса:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор действия	actionId	True	string	Идентификатор обновления удаленного действия
Идентификатор действия	language		integer	0 = EN 1 = DE
имя	name	True	string
value	value		string
canEdit	canEdit		boolean
canExecute	canExecute		boolean
teamId	teamId		string
definitionId	definitionId		string
описание	description		string
enabled	enabled		boolean
имя	name		string
teamId	teamId		string

Возвращаемое значение

Тело: V2.RemoteActionDetails

Обновление членства в команде пользователя

Идентификатор операции:: TeamsUpdateUserMembership

Обновляет членство в команде пользователя. Вы можете переместить пользователя в другую команду в подписке и /или изменить роль пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Команда пользователя, к которому вы хотите обновиться, принадлежит на данный момент.
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, который требуется обновить.
Идентификатор пользователя	requesterUserId		string	Идентификатор пользователя, с которым вы хотите изменить роль. Это необходимо указать при использовании ключа API. Этот пользователь должен иметь администратора ролей (для настройки роли администратора) или администратора группы (для настройки прав.
Настройка пользователя по обязанности	setUserOnDuty		boolean	Задает новое состояние обязанности для пользователя, если пользователь перемещен в другую команду. Пользователь должен быть по умолчанию.
isValid	isValid		boolean
roleId	roleId		string
teamId	teamId		string

Возвращаемое значение

Тело: UserInfo

Обновляет заданный экземпляр скрипта

Идентификатор операции:: ScriptsUpdateConfig

Обновляет указанный экземпляр скрипта, обычно используемый для обновления конфигурации скрипта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор экземпляра скрипта	instanceId	True	string	Идентификатор экземпляра обновляемого скрипта.
config	config
customScriptDescription	customScriptDescription		string
customScriptName	customScriptName		string
enabled	enabled		boolean
teamId	teamId		string

Возвращаемое значение

Тело: ScriptInstanceDetails

Обновляет пользовательские данные заданного экземпляра скрипта, включающее отображаемое имя.

Идентификатор операции:: ScriptsUpdateCustomData

Обновляет указанный экземпляр скрипта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор экземпляра скрипта	instanceId	True	string	Идентификатор экземпляра обновляемого скрипта.
customScriptDescription	customScriptDescription		string
customScriptName	customScriptName		string
instanceId	instanceId		string
scriptName	scriptName		string

Возвращаемое значение

Тело: ScriptInstanceDetails

Обновляет профиль группы

Идентификатор операции:: TeamsUpdateProfile

Обновляет профиль команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, которая должна быть обновлена.
имя	name		string

Возвращаемое значение

Тело: TeamInfo

Обновляет профиль пользователя

Идентификатор операции:: UsersUpdateProfile

Обновляет профиль пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя для обновления.
имя	name		string
часовой пояс	timeZone		string

Возвращаемое значение

Тело: UserInfo

Оповещение об аннотации

Идентификатор операции:: AlertsAnnotate

Заметит оповещение, указав сведения о заметках.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор оповещения для анимации.
текст	text		string
type	type		integer	0 = нет 1 = текст 2 = изображение
userId	userId		string

Возвращаемое значение

Тело: V2.AlertAnnotationDetails

Оповещение триггера

Идентификатор операции:: AlertsTrigger

Активирует новое оповещение для вашей команды. Все члены команды по обязанности получат уведомления об оповещениях.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name		string
заказ	order		integer
type	type		integer	0 = нет 1 = объект 2 = массив 3 = конструктор 4 = свойство 5 = комментарий 6 = целое число 7 = Float 8 = строка 9 = логический 10 = NULL 11 = неопределено 12 = Дата 13 = необработанный 14 = Байт 15 = GUID 16 = URI 17 = TimeSpan 100 = Html
value	value		string
содержимое	content		string
Тип контента	contentType		string
encoding	encoding		integer	0 = нет 1 = Base64
id	id		string
имя	name		string
категория	category		string
externalId (внешний идентификатор)	externalId		string
flags	flags		integer	0 = нет 1 = HasAttachments 2 = HasAnnotations 4 = IsBreached 8 = HasLocationInfo 16 = ЭскалацияToTeam 32 = ЭскалацияToManager 64 = CreatedByEscalation
severity	severity		integer	0 = низкий 1 = основной 2 = критическое
teamId	teamId	True	string
текст	text	True	string
title	title	True	string

Возвращаемое значение

Тело: V2.AlertDetails

Отключает заданный экземпляр скрипта

Идентификатор операции:: ScriptsDisable

Отключает заданный экземпляр скрипта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор экземпляра скрипта	instanceId	True	string	Идентификатор экземпляра, отключаемого.

Возвращаемое значение

Тело: ScriptInstanceDetails

Отмена закрытия нескольких оповещений

Идентификатор операции:: AlertsUndoCloseMultiple

Этот метод пытается отменить закрытие нескольких оповещений. Операция обрабатывается в фоновом режиме.

Параметры

Имя	Ключ	Обязательно	Тип
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Отмена закрытия оповещения

Идентификатор операции:: AlertsUndoClose

Этот метод пытается отменить закрытие оповещения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	ИД оповещения.
descr	descr		string
uid	uid	True	string

Возвращаемое значение

Тело: V2.AlertInfo

Отмена очереди нескольких подтверждений

Идентификатор операции:: AlertsUndoAcknowledgeMultiple

Этот метод пытается отменить подтверждение нескольких оповещений через очередь. Операция обрабатывается в фоновом режиме.

Параметры

Имя	Ключ	Обязательно	Тип
alertIds	alertIds	True	array of string
descr	descr		string
uid	uid	True	string

Отмена подтверждения оповещения

Идентификатор операции:: AlertsUndoAck

Этот метод пытается отменить подтверждение оповещения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	ИД оповещения.
descr	descr		string
uid	uid	True	string

Возвращаемое значение

Тело: V2.AlertInfo

Отправка оповещений вручную в команду

Идентификатор операции:: AlertsEscalateToTeam

Переведите оповещение вручную в команду.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор оповещения для оповещений, которые требуется выполнить.
targetTeamId	targetTeamId		string
userId	userId		string

Возвращаемое значение

response: string

Отправлен образ профиля для указанного пользователя

Идентификатор операции:: UsersUploadImage

Отправлен образ профиля для указанного пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя.

Отправлен образ профиля для указанной команды

Идентификатор операции:: TeamsUploadImage

Отправлен образ профиля для указанной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, где нужно задать образ команды.

Отправляет сообщение указанному пользователю

Идентификатор операции:: UsersSendEventSourceInfoEmail

Отправляет сообщение указанному пользователю, содержащее сведения обо всех источниках событий команды пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя.
Идентификатор команды	teamId		string	Идентификатор команды, из которого пользователь должен получить сведения о конечной точке.

Отправляет сообщение электронной почты, если приглашение существует

Идентификатор операции:: TeamsResendInvite

Отправляет сообщение электронной почты, если приглашение существует.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды с приглашенным пользователем.
inviterId	inviterId		string
userMail	userMail	True	string

Возвращаемое значение

response: string

Подтверждает все видимые оповещения

Идентификатор операции:: AlertsAcknowledgeAll

Этот метод подтверждает все необработанные оповещения, которые ваша команда в настоящее время имеет определенного пользователя.

Параметры

Имя	Ключ	Тип	Описание
Идентификатор пользователя	userId	string	Идентификатор пользователя, который будет использоваться для подтверждения предупреждений.
categoryIds	categoryIds	array of string
maxDate	maxDate	date-time
minDate	minDate	date-time
scope	scope	integer	0 = по умолчанию 1 = AllTeams 2 = SpecificTeams
TeamIds	teamIds	array of string

Подтверждение оповещения

Идентификатор операции:: AlertsAcknowledge

Подтвердите оповещение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор для подтверждения оповещения.
descr	descr		string
uid	uid	True	string

Возвращаемое значение

Тело: V2.AlertInfo

Получает изображение указанной команды

Идентификатор операции:: TeamsGetImage

Получает изображение указанной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, из которой вы хотите получить изображение.
Высота изображения	height		integer	Необязательный параметр, определяющий нужную высоту полученного рисунка.
Ширина изображения	width		integer	Необязательный параметр, определяющий требуемую ширину полученного рисунка.

Возвращаемое значение

Тело: V2.TeamImageDetails

Получает ход установки определенного пользователя

Идентификатор операции:: UsersGetSetupProgress

Получает ход установки определенного пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, для которого должен быть получен ход выполнения.

Возвращаемое значение

Тело: UserSetupProgress

Получает ход установки определенной команды

Идентификатор операции:: TeamsGetSetupProgress

Получает ход установки определенной команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которого должен быть получен ход выполнения.

Возвращаемое значение

Тело: TeamSetupProgress

Получение веб-перехватчика по идентификатору

Идентификатор операции:: WebhooksGet

Возвращает сведения веб-перехватчика, указанного переданным идентификатором.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор исходящего веб-перехватчика	webhookId	True	string	Идентификатор извлекаемого исходящего веб-перехватчика.

Возвращаемое значение

Тело: WebhookInfo

Получение веб-перехватчиков

Идентификатор операции:: WebhooksGetAll

Возвращает коллекцию определенных исходящих веб-перехватчиков в системе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId		string	Идентификатор команды.

Возвращаемое значение

response: array of WebhookInfo

Получение всех доступных определений

Идентификатор операции:: RemoteActionsGetAvailableDefinitions

Получение всех доступных определений.

Параметры

Имя

Ключ

Обязательно

Тип

Описание

Language

language

integer

0 = EN
1 = DE

Возвращаемое значение

response: array of V2.RemoteActionDefinitionDetails

Получение всех категорий

Идентификатор операции:: CategoriesGetAll

Получение всех категорий.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId		array	Идентификатор команды.

Возвращаемое значение

Тело: MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

Получение всех категорий

Идентификатор операции:: CategoriesGetAllOfTeam

Пример запроса:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой относятся категории

Возвращаемое значение

response: array of CategoryInfo

Получение всех команд, в которые входит пользователь

Идентификатор операции:: UsersGetAllTeams

Возвращает список объектов группы с подробными сведениями, такими как их имя. Возвращаются только команды, в которые входит пользователь.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	userId	True	string	Идентификатор команды.

Возвращаемое значение

response: array of TeamInfo

Получение всех пользователей

Идентификатор операции:: UsersGettAll

Возвращает список объектов пользователя с подробными сведениями, такими как адрес электронной почты и сведения об обязанностях. Будут возвращены только пользователи, к которых у вас есть доступ.

Возвращаемое значение

response: array of V2.UserDetails

Получение всех пользователей указанных команд

Идентификатор операции:: TeamsGetAllUsers

Получение всех пользователей указанных команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы команд	teamId		array	Идентификаторы команды для запроса. Если это пусто, вы получаете доступ ко всем пользователям всех команд.

Возвращаемое значение

Тело: MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

Получение всех шаблонов выносок для подписки

Идентификатор операции:: CalloutsGetTemplates

Получите все шаблоны выносок для подписки.

Возвращаемое значение

response: array of V2.CalloutTemplateDetails

Получение всех шаблонов оповещений из команды

Идентификатор операции:: TeamsGetAllAlertPatterns

Получите все шаблоны оповещений из команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой вы хотите получить доступ

Возвращаемое значение

response: array of V2.AlertingPatternDetails

Получение записей временной шкалы оповещений

Идентификатор операции:: AlertsGetTimeline

Получение записей временной шкалы оповещений по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор запрошенного оповещения.
Идентификатор пользователя	userId		string	ИД пользователя

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of

Получение источника события по идентификатору

Идентификатор операции:: EventSourcesGetById

Получение источника события по идентификатору.

Параметры

Имя

Ключ

Обязательно

Тип

Описание

Идентификатор источника событий

eventSourceId

True

string

Идентификатор источника события.

Language

language

integer

0 = EN
1 = DE

Возвращаемое значение

Тело: EventSourceEndpointInfo

Получение источников событий из одной или нескольких команд

Идентификатор операции:: EventSourcesGet

Получение источников событий из одной или нескольких команд.

Параметры

Имя

Ключ

Обязательно

Тип

Описание

Идентификаторы команд

teamId

array

Идентификаторы команды для получения источников событий из. Если вы не добавляете идентификатор команды, вы получите источники событий, к которых у вас есть доступ из подписки.

Включение внутренних данных

includeInternal

boolean

Если в результат будут включены истинные внутренние источники событий (System, Manual, API).

Language

language

integer

0 = EN
1 = DE

Возвращаемое значение

Тело: MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

Получение личного образа пользователя

Идентификатор операции:: UsersGetImage

Получите личный образ пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя".
Высота изображения	height		integer	Высота изображения".
Ширина изображения	width		integer	Ширина изображения".

Возвращаемое значение

Тело: UserImage

Получение метрик для всех категорий

Идентификатор операции:: CategoriesGetAllMetrics

Пример запроса:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория

Возвращаемое значение

response: array of CategoryMetrics

Получение метрик для определенной категории

Идентификатор операции:: CategoriesGetMetrics

Пример запроса:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория
Идентификатор категории	categoryId	True	string	Идентификатор категории для получения

Возвращаемое значение

Тело: CategoryMetrics

Получение общедоступной информации обо всех командах в подписке

Идентификатор операции:: TeamsGetAllPublicInformation

Получение общедоступной информации обо всех командах в подписке.

Возвращаемое значение

response: array of V2.TeamPublicDetails

Получение оповещений на странице

Идентификатор операции:: AlertsGetPaged

Возвращает страницы оповещений.

Параметры

Имя	Ключ	Тип	Описание
Идентификатор пользователя	userId	string	Идентификатор пользователя, для которого требуется получить оповещения.
Ограничение оповещений	maxResults	integer	Определяет ограничение полученных сведений об оповещении для каждого запроса. 1–100 разрешено для каждого запроса. Число оповещений может быть меньше, если отфильтровано, но по крайней мере 1.
afterId	afterId	string
alertIds	alertIds	array of string
alertStatusCodes	alertStatusCodes	integer	0 = нет 1 = Открыть 2 = подтверждено 4 = закрыто 8 = NoReply 16 = неудачно 32 = ошибка
categoryIds	categoryIds	array of string
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string
externalId (внешний идентификатор)	externalId	string
maxCreated	maxCreated	date-time
minCreated	minCreated	date-time
modifiedSince	modifiedSince	date-time
showPersonalHiddenCategories	showPersonalHiddenCategories	boolean
TeamIds	teamIds	array of string
textToSearch	textToSearch	string

Возвращаемое значение

Тело: PagedResultsPublic-1-V2.AlertInfo-

Получение оповещения

Идентификатор операции:: AlertsGet

Возвращает оповещение по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор запрошенного оповещения.
Идентификатор пользователя	userId		string	ИД пользователя

Возвращаемое значение

Тело: V2.AlertInfo

Получение определения

Идентификатор операции:: RemoteActionsGetDefinition

Получение определения.

Параметры

Имя

Ключ

Обязательно

Тип

Описание

Идентификатор определения

definitionId

True

string

Идентификатор определения

Language

language

integer

0 = EN
1 = DE

Возвращаемое значение

Тело: V2.RemoteActionDefinitionDetails

Получение определенной категории

Идентификатор операции:: CategoriesGet

Пример запроса:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория
Идентификатор категории	categoryId	True	string	Идентификатор категории для получения

Возвращаемое значение

Тело: CategoryInfo

Получение отчета об оповещении

Идентификатор операции:: AlertsGetReport

Возвращает сведения о томе оповещений в разных периодах времени, а также сведения о поведении ответа (объем подтвержденных и необработанных оповещений) членов команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId		string	Идентификатор пользователя, для которого требуется отчет.
Идентификаторы команд	teamId		array	Идентификаторы команд, для которого требуется отчет. Если вы не задаете идентификатор команды, вы получите все ресурсы всех команд, к которых у вас есть доступ.

Возвращаемое значение

Тело: MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

Получение параметров конфиденциальности команды

Идентификатор операции:: TeamsGetPrivacySettings

Получение параметров конфиденциальности группы для команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды

Возвращаемое значение

Тело: V2.TeamPrivacySettingsDetails

Получение параметров обязанностей команды для нескольких команд

Идентификатор операции:: TeamsGetDutySettings

Получение параметров обязанностей команды для нескольких команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы команд	teamId		array	Идентификаторы команд.

Возвращаемое значение

Тело: MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

Получение параметров события

Идентификатор операции:: EventsGetParameters

Получение параметров события по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор события	eventId	True	string	Идентификатор события запрошенного оповещения.

Возвращаемое значение

response: array of EventParameterInfo

Получение подписок категорий

Идентификатор операции:: CategoriesGetSubscription

Пример запроса:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория
Идентификатор категории	categoryId	True	string	Категория для получения подписок

Возвращаемое значение

response: array of CategorySubscriptionInfo

Получение пользователя по идентификатору

Идентификатор операции:: UsersGet

Возвращает объект пользователя с подробными сведениями, такими как адрес электронной почты и сведения о обязанностях.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, который требуется получить. Используйте "Me", чтобы получить сведения о пользователе, вошедшего в систему. Это невозможно с помощью ключа API. Также может быть адрес электронной почты пользователя в команде или уникальный идентификатор соответствующего объекта пользователя".

Возвращаемое значение

Тело: V2.UserDetails

Получение праздников для команды

Идентификатор операции:: TeamsGetHolidays

Получить праздники для команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, из которого вы хотите получить праздники

Возвращаемое значение

Тело: V2.TeamHolidayDetails

Получение предоплаченных транзакций подписки

Идентификатор операции:: SubscriptionsGetPrepaidTransactions

Получение предоплаченных транзакций подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки для получения транзакций

Возвращаемое значение

response: array of PrepaidTransactionInfo

Получение предоплаченных транзакций подписки

Идентификатор операции:: PrepaidGetTransactions

Получение предоплаченных транзакций подписки.

Возвращаемое значение

response: array of PrepaidTransactionInfo

Получение профилей уведомлений для пользователя

Идентификатор операции:: UsersGetNotificationProfile

Получение профилей уведомлений для пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, из которого вы хотите получить профили уведомлений.

Возвращаемое значение

response: array of V2.NotificationProfileDetails

Получение сведений для всех команд подписки

Идентификатор операции:: SubscriptionsGetAllTeamsInfo

Получение сведений для всех команд подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор обновляемой подписки

Возвращаемое значение

response: array of TeamInfo

Получение сведений о вложениях оповещения

Идентификатор операции:: AlertsGetAttachmentInfo

Получение вложений оповещения по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор запрошенного оповещения.

Возвращаемое значение

response: array of V2.AlertAttachmentInfo

Получение сведений о конкретной подписке

Идентификатор операции:: SubscriptionsGetInfo

Получение сведений о конкретной подписке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор извлекаемой подписки.

Возвращаемое значение

Тело: SubscriptionInfo

Получение сведений о помощнике по обязанностям для команд

Идентификатор операции:: DutiesGetDutyAssistantInfo

Получение сведений о помощнике по обязанностям для команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы команд	teamId		array	Идентификаторы команд, чтобы получить сводки для.
Последние две обязанности	lastTwoDuties		boolean	Решите, хотите ли вы все обязанности или только последние два.

Возвращаемое значение

Тело: MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

Получение сведений о скачиваемых отчетах оповещений

Идентификатор операции:: TeamsGetAlertReportsInfo

Получение сведений о скачиваемых отчетах оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, из которой вы хотите скачать отчеты.

Возвращаемое значение

response: array of AlertAuditReportFileInfo

Получение сведений о событии

Идентификатор операции:: EventsGetDetails

Получение сведений о событии.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор события	eventId	True	string	Идентификатор события, которое требуется получить

Возвращаемое значение

Тело: V2.EventDetails

Получение сведений об оповещении

Идентификатор операции:: AlertsGetDetails

Получение сведений об оповещении.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Оповещение, которое вы хотите получить.
Идентификатор пользователя	userId		string	Идентификатор пользователя, в котором вызывается API. Он используется для фильтрации оповещений.

Возвращаемое значение

Тело: V2.AlertDetails

Получение сведений обо всех доступных и управляемых подписках

Идентификатор операции:: SubscriptionsGetAll

Получение сведений обо всех доступных или управляемых подписках.

Возвращаемое значение

response: array of SubscriptionInfo

Получение сведений обо всех командах

Идентификатор операции:: TeamsGetAllInfo

Получение сведений обо всех командах.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы команд	teamId		array	Идентификаторы команд

Возвращаемое значение

response: array of TeamInfo

Получение события обзора

Идентификатор операции:: EventsGetOverview

Получение события обзора по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор события	eventId	True	string	Идентификатор события для получения.

Возвращаемое значение

Тело: OverviewEvent

Получение состояния обязанности по идентификатору пользователя

Идентификатор операции:: UsersGetDutyStatus

Возвращает объект с сведениями о обязанностях.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, который требуется получить. Используйте "Me", чтобы получить сведения о пользователе, вошедшего в систему. Это невозможно с помощью ключа API. Также может быть адрес электронной почты пользователя в команде или уникальный идентификатор соответствующего объекта пользователя".
Идентификатор команды	teamId		array	Идентификатор команды".

Возвращаемое значение

Тело: MultiTeamResult-2-UserDutyInfo-V2.DutyError-

Получение страницы событий обзора

Идентификатор операции:: EventsGetOverviewPaged

Получение страницы событий обзора. Если есть дополнительные результаты, вы также получите маркер продолжения, который можно добавить в фильтр событий.

Параметры

Имя	Ключ	Тип	Описание
Лимит	maxResults	integer	Определяет ограничение полученных сведений об оповещении для каждого запроса. 1–100 разрешено для каждого запроса. Число оповещений может быть меньше, если отфильтровано, но по крайней мере 1.
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string
eventSourceId	eventSourceId	string
eventStatusCode	eventStatusCode	integer	0 = нет 1 = обработка 2 = Signled 3 = отфильтрованный 4 = разрешено 5 = отменено 6 = подтверждено 7 = отложено 8 = NoRuleApplied 9 = MultipleTargetStatus 1000 = ошибка
maxCreationDate	maxCreationDate	date-time
minCreationDate	minCreationDate	date-time
modifiedSince	modifiedSince	date-time
Teamid	teamid	string
textToSearch	textToSearch	string

Возвращаемое значение

Тело: PagedResultsPublic-1-OverviewEvent-

Получение текущего предоплаченного баланса подписки

Идентификатор операции:: SubscriptionsGetPrepaidBalance

Получение текущего предоплаченного баланса подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки

Возвращаемое значение

Тело: PrepaidBalanceInfo

Получение текущего предоплаченного баланса подписки

Идентификатор операции:: PrepaidGetBalance

Получите текущий предоплаченный баланс подписки.

Возвращаемое значение

Тело: PrepaidBalanceInfo

Получение текущих параметров предоплаченной подписки

Идентификатор операции:: PrepaidGetSettings84

Получение текущих параметров предоплаченной подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ID подписки	subscriptionId	True	string	Идентификатор подписки

Возвращаемое значение

Тело: PrepaidSettingsInfo

Получение текущих параметров предоплаченной подписки

Идентификатор операции:: PrepaidGetSettings

Получите текущие параметры предоплаченной подписки.

Возвращаемое значение

Тело: PrepaidSettingsInfo

Получение уведомлений оповещений

Идентификатор операции:: AlertsGetNotifications

Получение уведомлений обо всех пользователях по идентификатору оповещения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оповещения	alertId	True	string	Идентификатор запрошенного оповещения.

Возвращаемое значение

response: array of AlertNotificationInfo

Получение членства в команде

Идентификатор операции:: TeamsGetMemberships

Получение членства в команде.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой вы хотите получить доступ.

Возвращаемое значение

response: array of V2.TeamMembershipDetails

Получение членства в команде от пользователя

Идентификатор операции:: TeamsGetTeamMemberships

Получение членства в команде от пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, к которому требуется получить доступ.

Возвращаемое значение

response: array of V2.TeamMembershipDetails

Приглашение пользователей в команду

Идентификатор операции:: TeamsInviteUser

Пригласите пользователей в команду.

Параметры

Имя	Ключ	Обязательно	Тип
inviterId	inviterId		string
электронная почта	email		string
roleId	roleId		string
teamId	teamId	True	string

Возвращаемое значение

response: array of V2.InvitationResult

Проверка интервалов времени шаблона

Идентификатор операции:: TeamsValidateAlertPattern

Проверьте интервалы времени шаблона для всех существующих слотов времени других шаблонов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды шаблона генерации оповещений
Идентификатор шаблона	patternId		string	Идентификатор шаблона оповещений шаблона, для которого требуется сэкономить интервалы времени. Может иметь значение NULL
Идентификаторы категорий	categoryIds		array	Идентификаторы категорий шаблона, который требуется проверить. Может иметь значение NULL.
час	hour		integer
протокол	minutes		integer
будний день	weekday		integer	0 = Праздник 1 — понедельник; 2 — вторник; 3 — среда; 4 — четверг; 5 — пятница; 6 — суббота. 7 = воскресенье
id	id		string

Возвращаемое значение

response: array of V2.TimeSlotValidationResultDetails

Проверяет, имеет ли пользователь предоставленный разрешение

Идентификатор операции:: UsersCheckPermissions

Проверяет, имеет ли пользователь предоставленный разрешение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя для проверки разрешений.
permissions	permissions		array of string
TeamIds	teamIds		array of string

Возвращаемое значение

Тело: MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

Проверяет предыдущий созданный номер телефона для пользователя

Идентификатор операции:: UsersValidatePhoneNumber

Проверяет предыдущий созданный номер телефона для пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, который требуется проверить предыдущий созданный номер телефона
номер телефона	phoneNumber		string
validationCode	validationCode		string

Скачивание отчета об обязанности с определенным именем файла

Идентификатор операции:: TeamsGetDutyReport

Скачайте отчет о обязанностях с определенным именем файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которой вы хотите скачать отчет о обязанностях.
Имя файла	fileName	True	string	Имя файла скачиваемого csv-файла.

Возвращаемое значение

response: binary

Событие Send

Идентификатор операции:: EventsSend

Отправить событие.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Секрет команды	teamSecret	True	string	Секрет команды.
Название	Title	True	string
Message	Message	True	string
X-S4-Service	X-S4-Service		string	X-S4-Service: назначает вход в службу или системную категорию с указанным именем.
X-S4-Location	X-S4-Location		string	X-S4-Location: передача сведений о расположении (широта, долгота) с событием и отображение карты в мобильном приложении.
X-S4-AlertingScenario	X-S4-AlertingScenario		string	X-S4-AlertingScenario: если это событие активирует signl, позволяет управлять тем, как SIGNL4 уведомляет команду. Поддерживаемые значения: single_ack, multi_ack, экстренные ситуации.
X-S4-ExternalID	X-S4-ExternalID		string	X-S4-ExternalID: если событие исходит из записи в 3-сторонней системе, используйте этот параметр для передачи уникального идентификатора этой записи. Этот идентификатор будет передаваться в исходящих уведомлениях веб-перехватчика из SIGNL4, что отлично подходит для корреляции и синхронизации этой записи с signl.
X-S4-Status	X-S4-Status		string	X-S4-Status: если вы хотите разрешить существующий signl с помощью внешнего идентификатора (X-S4-ExternalID), можно добавить этот параметр состояния. У него есть три возможных значения: новые, подтвержденные, разрешенные.
X-S4-Filtering	X-S4-Filtering		boolean	X-S4-Filtering: укажите логическое значение true или false, чтобы применить фильтрацию событий для этого события или нет. Если задано значение true, событие активирует уведомление только команде, если оно содержит по крайней мере одно ключевое слово из одной из служб и системных категорий (т. е. в списке разрешений).
Параметр внешнего идентификатора	ExtIdParam		string	Внешний параметр идентификатора.
Внешний параметр состояния	ExtStatusParam		string	Внешний параметр состояния.
Новое состояние	NewStatus		string	Новое состояние.
Разрешенный параметр состояния	ResolvedStatus		string	Разрешенный параметр состояния.
Состояние "Ack"	AckStatus		string	Состояние Ack.

Возвращаемое значение

Тело: OverviewEvent

Создает новый экземпляр скрипта в команде SIGNL4

Идентификатор операции:: ScriptsCreate

Создает новый экземпляр скрипта скрипта, указанного в тексте запроса.

Параметры

Имя	Ключ	Тип
config	config
customScriptDescription	customScriptDescription	string
customScriptName	customScriptName	string
enabled	enabled	boolean
instanceId	instanceId	string
scriptId	scriptId	string
scriptName	scriptName	string
sharedTeams	sharedTeams	array of string
teamId	teamId	string

Возвращаемое значение

Тело: ScriptInstanceDetails

Создание веб-перехватчика

Идентификатор операции:: WebhooksCreate

Создает новый исходящий веб-перехватчик, который будет получать уведомления при возникновении определенных событий.

Параметры

Имя	Ключ	Обязательно	Тип
описание	description		string
extUrl	extUrl	True	string
имя	name	True	string
teamId	teamId		string

Возвращаемое значение

response: string

Создание источника событий

Идентификатор операции:: EventSourcesCreate

Создайте источник события.

Параметры

Имя	Ключ	Тип	Описание
описание	description	string
disabled	disabled	boolean
language	language	integer	0 = EN 1 = DE
имя	name	string
sharedTeams	sharedTeams	array of string
teamId	teamId	string
type	type	integer	0 = нет 1 = электронная почта 2 = веб-перехватчик

Возвращаемое значение

Тело: EventSourceEndpointInfo

Создание нового шаблона оповещений

Идентификатор операции:: TeamsCreateAlertPattern

Создайте шаблон оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которого вы хотите создать шаблон
categories	categories		array of string
enabled	enabled		boolean
mode	mode		integer	0 = диспетчер 1 = команда
referenceId	referenceId		string
id	id		string
имя	name		string
канал	channel		integer	0 = нет 1 = Push 2 = голос 3 = SMS
delayInMinutes	delayInMinutes		integer
enabled	enabled		boolean
overrideEscalationSettings	overrideEscalationSettings		boolean
overrideNotificationProfiles	overrideNotificationProfiles		boolean
overrideResponseSettings	overrideResponseSettings		boolean
responseMode	responseMode		integer	2 = SingleAcknowledge 4 = MultiAcknowledge
responseTime	responseTime		integer
suppressSignl	suppressSignl		boolean
час	hour		integer
протокол	minutes		integer
будний день	weekday		integer	0 = Праздник 1 — понедельник; 2 — вторник; 3 — среда; 4 — четверг; 5 — пятница; 6 — суббота. 7 = воскресенье
id	id		string

Возвращаемое значение

Тело: V2.AlertingPatternDetails

Создание новой категории

Идентификатор операции:: CategoriesCreate

Пример запроса:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория
enabled	enabled		boolean
id	id		string
имя	name		string
type	type	True	integer	0 = параметр 1 = тема 2 = текст 3 = расположение
value	value		string
color	color	True	string
id	id		string
имя	name		string
type	type	True	integer	0 = параметр 1 = гиперссылка
value	value		string
id	id		string
imageName	imageName	True	string
isDefault	isDefault		boolean
keywordMatching	keywordMatching	True	integer	0 = любой 1 = все
ключевые слова	keywords	True	array of string
keywordsExcluded	keywordsExcluded		array of string
имя	name	True	string
options	options		integer	0 = нет 1 = скрытый 2 = DenyDelete 4 = HideOptOut 8 = HideKeywords
заказ	order		integer
teamId	teamId		string

Возвращаемое значение

Тело: CategoryInfo

Создание удаленного действия

Идентификатор операции:: RemoteActionsCreate

Пример запроса:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Language	language		integer	0 = EN 1 = DE
имя	name	True	string
value	value		string
canEdit	canEdit		boolean
canExecute	canExecute		boolean
teamId	teamId		string
definitionId	definitionId		string
описание	description		string
enabled	enabled		boolean
имя	name		string
teamId	teamId		string

Возвращаемое значение

Тело: V2.RemoteActionDetails

Создание удаленного задания

Идентификатор операции:: RemoteActionsCreateJob

Пример запроса:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор действия	actionId	True	string	Идентификатор действия
имя	name	True	string
value	value		string
alertId	alertId		string
options	options		integer	0 = нет
remoteActionPin	remoteActionPin		string

Возвращаемое значение

Тело: V2.RemoteJob

Создание шаблонов выносок для подписки

Идентификатор операции:: CalloutsCreateTemplate

Создайте новые шаблоны выносок для подписки.

Параметры

Имя	Ключ	Тип	Описание
categoryId	categoryId	string
externalId (внешний идентификатор)	externalId	string
id	id	string
location	location	string
имя	name	string
субъект	subject	string
targetAllTeams	targetAllTeams	boolean
targetTeamId	targetTeamId	string
текст	text	string
workflowType	workflowType	integer	0 = AsConfiguredInTeam 2 = TeamBroadcast 4 = MultiAcknowledge 5 = MultiAcknowledgeEmergency

Возвращаемое значение

response: array of V2.CalloutTemplateDetails

Сохранение нескольких расписаний

Идентификатор операции:: DutiesSaveMultiple

Сохраните несколько расписаний. При желании можно переопределить существующие расписания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор группы для задания
Override	overrideExisting		boolean	Переопределите или сократите существующие расписания, если задано значение true.
конец	end		date-time
id	id		string
options	options		integer
start	start		date-time
userId	userId		string

Возвращаемое значение

response: array of ScheduleInfo

Сохранение повторяющихся праздников для команды

Идентификатор операции:: TeamsSaveRepeatingHolidays

Сохраните повторяющиеся праздники для команды.

Параметры

Имя

Ключ

Обязательно

Тип

Описание

Идентификатор команды

teamId

True

string

Идентификатор команды, для которой вы хотите сохранить праздники

day

integer

month

integer

0 = отмена набора
1 = январь
2 = февраль
3 = март
4 = апрель
5 = май
6 = июнь
7 = июль
8 = август
9 = сентябрь
10 = октябрь
11 = ноябрь
12 = декабрь

Возвращаемое значение

Тело: V2.TeamHolidayDetails

Сохранение праздников для команды

Идентификатор операции:: TeamsSaveHolidays

Сохраните праздники для команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, для которой вы хотите сохранить праздники
Год	year	True	integer	Год, для которого вы хотите сохранить праздники
day	day		integer
month	month		integer	0 = отмена набора 1 = январь 2 = февраль 3 = март 4 = апрель 5 = май 6 = июнь 7 = июль 8 = август 9 = сентябрь 10 = октябрь 11 = ноябрь 12 = декабрь

Возвращаемое значение

Тело: V2.TeamHolidayDetails

Срез или обновление заданного расписания обязанностей

Идентификатор операции:: DutiesCreateOrUpdate

Создание и обновление заданного расписания обязанностей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которому должна быть назначена обязанность.
конец	end		date-time
id	id		string
options	options		integer
start	start		date-time
userId	userId		string

Возвращаемое значение

Тело: ScheduleInfo

Удаление адреса контакта от пользователя

Идентификатор операции:: UsersDeleteContactAddress

Удаление адреса контакта от пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя для удаления адреса из
Идентификатор адреса	addressId	True	string	Идентификатор адреса контакта

Удаление веб-перехватчика по идентификатору

Идентификатор операции:: WebhooksDelete

Удаляет указанный веб-перехватчик, чтобы он больше не был уведомлен.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор исходящего веб-перехватчика	webhookId	True	string	Идентификатор исходящего веб-перехватчика, который будет удален.

Удаление источника событий

Идентификатор операции:: EventSourcesDelete

Удаление источника событий.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор источника событий	eventSourceId	True	string	Идентификатор источника события

Удаление личного образа пользователя

Идентификатор операции:: UsersDeleteImage

Удаление личного образа пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя или меня

Удаление номера телефона пользователя

Идентификатор операции:: UsersDeletePhoneNumber

Удалите номер телефона пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя

Удаление определенного шаблона генерации оповещений

Идентификатор операции:: TeamsDeleteAlertPattern

Удалите определенный шаблон оповещений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой вы хотите получить доступ
Идентификатор шаблона	patternId	True	string	Идентификатор шаблона для шаблона, к которому требуется получить доступ

Удаление определенной обязанности

Идентификатор операции:: DutiesDelete

Удаление определенной обязанности.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит обязанность.
Идентификатор расписания обязанностей	dutyId	True	string	Идентификатор удаляемой обязанности.

Удаление праздников

Идентификатор операции:: TeamsDeleteHolidays

Удаление праздников.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, из которого требуется удалить праздники
day	day		integer
month	month		integer	0 = отмена набора 1 = январь 2 = февраль 3 = март 4 = апрель 5 = май 6 = июнь 7 = июль 8 = август 9 = сентябрь 10 = октябрь 11 = ноябрь 12 = декабрь
год	year		integer

Удаление расписаний обязанностей в диапазоне

Идентификатор операции:: DutiesDeleteInRange

Удаление расписаний обязанностей в диапазоне.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, которую вы хотите удалить
от / из / с (context-dependent)	from		date-time
Кому	to		date-time

Возвращаемое значение

response: array of ScheduleInfo

Удаление распространения событий

Идентификатор операции:: EventDistributionDelete

Удаление распространения событий.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор источника событий	distributionId	True	string	Идентификатор источника события

Удаление существующего шаблона выноски из подписки

Идентификатор операции:: CalloutsDeleteTemplate

Удалите существующий шаблон выноски из подписки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД шаблона	templateId	True	string	Идентификатор шаблона.

Удаление существующей категории

Идентификатор операции:: CategoriesDelete

Пример запроса:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, к которой принадлежит категория
Идентификатор категории	categoryId	True	string	Идентификатор категории для удаления

Удаляет пользователя или приглашение из команды

Идентификатор операции:: TeamsRemoveUser

Удаляет пользователя или приглашение из команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, из нее следует удалить
Идентификатор пользователя	userId	True	string	Идентификатор пользователя, который должен быть удален
Идентификатор пользователя	requesterUserId		string	Идентификатор пользователя, который удалит другого пользователя.

Удаляет текущий образ команды

Идентификатор операции:: TeamsDeleteImage

Удаляет текущий образ команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	teamId	True	string	Идентификатор команды, из которого требуется удалить образ команды.

Удаляет удаленное действие

Идентификатор операции:: RemoteActionsDelete

Пример запроса:

DELETE /eaRemoteActions/{actionId}

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор действия	actionId	True	string	Идентификатор действия для удаления

Удаляет учетную запись пользователя

Идентификатор операции:: UsersDelete

Удаляет учетную запись пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор удаляемого пользователя.

Удаляет экземпляр скрипта

Идентификатор операции:: ScriptsDelete

Возвращает экземпляр скрипта, указанный идентификатором переданного экземпляра.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор экземпляра скрипта	instanceId	True	string	Идентификатор экземпляра скрипта для возврата.

Удар пользователя

Идентификатор операции:: DutiesUserPunchOut

Указанный пользователь будет выбит из обязанности.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
TeamIds	teamIds		array of string
userId	userId	True	string

Возвращаемое значение

Тело: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Удар пользователя в

Идентификатор операции:: DutiesUserPunchIn

Указанный пользователь будет ударить по обязанности.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
TeamIds	teamIds		array of string
userId	userId	True	string

Возвращаемое значение

Тело: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Удар пользователя в качестве диспетчера

Идентификатор операции:: DutiesUserPunchInAsManager

Указанный пользователь будет ударить в обязанности руководителя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
TeamIds	teamIds		array of string
userId	userId	True	string

Возвращаемое значение

Тело: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Установка расположения пользователя

Идентификатор операции:: UsersSetLocation

Задайте расположение пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	string	Идентификатор пользователя.
широта	latitude		double
долгота	longitude		double
отметка времени	timestamp		date-time

Возвращаемое значение

Тело: LocationInfo

Определения

AlertAuditReportFileInfo

Имя	Путь	Тип
fileName	fileName	string
fileSizeInBytes	fileSizeInBytes	integer
lastRecord	lastRecord	date-time
LastUpdated	lastUpdated	date-time
month	month	integer
год	year	integer

AlertEscalationModes

0 = диспетчер
1 = команда

0 = диспетчер
1 = команда

: integer

AlertFilterActions

0 = подавление
1 = скрыть
2 = Отключение

0 = подавление
1 = скрыть
2 = Отключение

: integer

AlertFilterModes

0 = выкл.
1 = WhiteListAllCategories

0 = выкл.
1 = WhiteListAllCategories

: integer

AlertNotificationInfo

Имя	Путь	Тип	Описание
address	address	string
deviceName	deviceName	string
LastUpdate	lastUpdate	date-time
messageStatus	messageStatus	AlertNotificationInfoMessageStatus	0 = нет 1 = отклонено 2 = сбой 3 = в очереди 4 = передано 5 = буферизованно 6 = доставлено 7 = отменено 8 = защищенный 9 = abuseProtected 10 = задержка
messageStatusErrorCode	messageStatusErrorCode	integer
notificationChannelType	notificationChannelType	AlertNotificationInfoChannelType	0 = нет 1 = Push 2 = электронная почта 4 = Bot 8 = голос 16 = SMS
userId	userId	string
userStatus	userStatus	AlertNotificationInfoUserStatus	0 = нет 1 = MessageCreated 2 = NotOnDuty 3 = CategoryHidden 4 = CategoryMuted 5 = NoNotificationProfiles 6 = NoMessagesByNotificationProfiles

AlertNotificationInfoChannelType

0 = нет
1 = Push
2 = электронная почта
4 = Bot
8 = голос
16 = SMS

0 = нет
1 = Push
2 = электронная почта
4 = Bot
8 = голос
16 = SMS

: integer

AlertNotificationInfoMessageStatus

0 = нет
1 = отклонено
2 = сбой
3 = в очереди
4 = передано
5 = буферизованно
6 = доставлено
7 = отменено
8 = защищенный
9 = abuseProtected
10 = задержка

0 = нет
1 = отклонено
2 = сбой
3 = в очереди
4 = передано
5 = буферизованно
6 = доставлено
7 = отменено
8 = защищенный
9 = abuseProtected
10 = задержка

: integer

AlertNotificationInfoUserStatus

0 = нет
1 = MessageCreated
2 = NotOnDuty
3 = CategoryHidden
4 = CategoryMuted
5 = NoNotificationProfiles
6 = NoMessagesByNotificationProfiles

0 = нет
1 = MessageCreated
2 = NotOnDuty
3 = CategoryHidden
4 = CategoryMuted
5 = NoNotificationProfiles
6 = NoMessagesByNotificationProfiles

: integer

AlertResponseModes

2 = SingleAcknowledge
4 = MultiAcknowledge

2 = SingleAcknowledge
4 = MultiAcknowledge

: integer

AlertSettings

Имя	Путь	Тип	Описание
escEnabled	escEnabled	boolean
escMode	escMode	AlertEscalationModes	0 = диспетчер 1 = команда
escRefId	escRefId	string
filterAction	filterAction	AlertFilterActions	0 = подавление 1 = скрыть 2 = Отключение
filterMode	filterMode	AlertFilterModes	0 = выкл. 1 = WhiteListAllCategories
notificationProfileOverrides	notificationProfileOverrides	array of AlertSettingsNotificationProfile
optOut	optOut	TeamCategoryOptOutModes	0 = нет 1 = отключено 2 = личное
overrideNotificationProfiles	overrideNotificationProfiles	boolean
persNotInterval	persNotInterval	integer
persNotMode	persNotMode	PersistentNotificationModes	0 = выкл. 1 = сводка
responseMode	responseMode	AlertResponseModes	2 = SingleAcknowledge 4 = MultiAcknowledge
responseTime	responseTime	integer

AlertSettingsChannelType

0 = нет
1 = Push
2 = голос
3 = SMS

0 = нет
1 = Push
2 = голос
3 = SMS

: integer

AlertSettingsNotificationProfile

Имя

Путь

Тип

Описание

канал

channel

AlertSettingsChannelType

0 = нет
1 = Push
2 = голос
3 = SMS

delay

integer

enabled

boolean

CategoryAugmentation

Имя	Путь	Тип	Описание
enabled	enabled	boolean
id	id	string
имя	name	string
type	type	CategoryAugmentationType	0 = параметр 1 = тема 2 = текст 3 = расположение
value	value	string

CategoryAugmentationType

0 = параметр
1 = тема
2 = текст
3 = расположение

0 = параметр
1 = тема
2 = текст
3 = расположение

: integer

CategoryEnrichment

Имя	Путь	Тип	Описание
id	id	string
имя	name	string
type	type	CategoryEnrichmentType	0 = параметр 1 = гиперссылка
value	value	string

CategoryEnrichmentType

0 = параметр
1 = гиперссылка

0 = параметр
1 = гиперссылка

: integer

CategoryInfo

Имя	Путь	Тип	Описание
augmentations	augmentations	array of CategoryAugmentation
color	color	string
обогащения	enrichments	array of CategoryEnrichment
id	id	string
imageName	imageName	string
isDefault	isDefault	boolean
keywordMatching	keywordMatching	KeywordMatchingType	0 = любой 1 = все
ключевые слова	keywords	array of string
keywordsExcluded	keywordsExcluded	array of string
имя	name	string
options	options	CategoryInfoOptions	0 = нет 1 = скрытый 2 = DenyDelete 4 = HideOptOut 8 = HideKeywords
заказ	order	integer
teamId	teamId	string

CategoryInfoOptions

0 = нет
1 = скрытый
2 = DenyDelete
4 = HideOptOut
8 = HideKeywords

0 = нет
1 = скрытый
2 = DenyDelete
4 = HideOptOut
8 = HideKeywords

: integer

CategoryMetrics

Имя	Путь	Тип
categoryId	categoryId	string
last24h	last24h	integer
lastAlert	lastAlert	date-time
подписчика	subscriberCount	integer

CategorySubscriptionInfo

Имя

Путь

Тип

Описание

статус

status

CategorySubscriptionStatus

0 = подписка
1 = Отключение
2 = скрытый

userId

string

CategorySubscriptionStatus

0 = подписка
1 = Отключение
2 = скрытый

0 = подписка
1 = Отключение
2 = скрытый

: integer

ChannelPriceInfo

Имя	Путь	Тип	Описание
СМС	sms	integer
voicePerMinute	voicePerMinute	integer

DutySummaryInfo

Имя	Путь	Тип
dutyEnd	dutyEnd	date-time
dutyId	dutyId	string
dutyStart	dutyStart	date-time

EventParameterInfo

Имя	Путь	Тип	Описание
имя	name	string
заказ	order	integer
type	type	EventParameterTypes	0 = нет 1 = объект 2 = массив 3 = конструктор 4 = свойство 5 = комментарий 6 = целое число 7 = Float 8 = строка 9 = логический 10 = NULL 11 = неопределено 12 = Дата 13 = необработанный 14 = Байт 15 = GUID 16 = URI 17 = TimeSpan 100 = Html
value	value	string

EventParameterTypes

0 = нет
1 = объект
2 = массив
3 = конструктор
4 = свойство
5 = комментарий
6 = целое число
7 = Float
8 = строка
9 = логический
10 = NULL
11 = неопределено
12 = Дата
13 = необработанный
14 = Байт
15 = GUID
16 = URI
17 = TimeSpan
100 = Html

0 = нет
1 = объект
2 = массив
3 = конструктор
4 = свойство
5 = комментарий
6 = целое число
7 = Float
8 = строка
9 = логический
10 = NULL
11 = неопределено
12 = Дата
13 = необработанный
14 = Байт
15 = GUID
16 = URI
17 = TimeSpan
100 = Html

: integer

События

0 = низкий
1 = основной
2 = критическое

0 = низкий
1 = основной
2 = критическое

: integer

EventSourceEndpointInfo

Имя	Путь	Тип	Описание
address	address	string
описание	description	string
disabled	disabled	boolean
groupId	groupId	string
id	id	string
lastEvent	lastEvent	date-time
имя	name	string
подтип	subType	string
subscriptionId	subscriptionId	string
teamId	teamId	string
type	type	EventSourceTypes	0 = нет 1 = электронная почта 2 = веб-перехватчик 3 = скрипт 4 = система 5 = вручную 6 = голос 7 = API

EventSourceTypes

0 = нет
1 = электронная почта
2 = веб-перехватчик
3 = скрипт
4 = система
5 = вручную
6 = голос
7 = API

0 = нет
1 = электронная почта
2 = веб-перехватчик
3 = скрипт
4 = система
5 = вручную
6 = голос
7 = API

: integer

EventStatusCodes

0 = нет
1 = обработка
2 = Signled
3 = отфильтрованный
4 = разрешено
5 = отменено
6 = подтверждено
7 = отложено
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = ошибка

0 = нет
1 = обработка
2 = Signled
3 = отфильтрованный
4 = разрешено
5 = отменено
6 = подтверждено
7 = отложено
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = ошибка

: integer

InventoryScriptInfo

Имя	Путь	Тип
config	config
данные	data	ScriptDescriptionData
Шаблон события	eventPattern
локализацияDetails	localizationDetails	array of ScriptLocalizationDetail
scriptId	scriptId	string
scriptName	scriptName	string
видимость	visibility	string

KeywordMatchingType

0 = любой
1 = все

0 = любой
1 = все

: integer

LocationInfo

Имя	Путь	Тип
широта	latitude	double
долгота	longitude	double
отметка времени	timestamp	date-time

MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

Имя	Путь	Тип	Описание
данные	data	array of EventSourceEndpointInfo
Ошибки	errors	array of V2.EventSourceEndpointError

MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

Имя	Путь	Тип	Описание
данные	data	array of TeamDutySummaryInfo
Ошибки	errors	array of V2.TeamDutySummaryError

MultiTeamResult-2-UserDutyInfo-V2.DutyError-

Имя	Путь	Тип	Описание
данные	data	array of UserDutyInfo
Ошибки	errors	array of V2.DutyError

MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

Имя	Путь	Тип	Описание
данные	data	array of V2.AlertCountsDetails
Ошибки	errors	array of V2.AlertReportError

MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError

Имя	Путь	Тип	Описание
данные	data	array of V2.AlertSettingsDetails
Ошибки	errors	array of V2.AlertSettingsError

MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

Имя	Путь	Тип	Описание
данные	data	array of V2.CategoryDetails
Ошибки	errors	array of V2.CategoryError

MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

Имя	Путь	Тип	Описание
данные	data	array of V2.TeamDutySettingsDetails
Ошибки	errors	array of V2.TeamDutySettingsError

MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

Имя	Путь	Тип	Описание
данные	data	array of V2.TeamPermissions
Ошибки	errors	array of V2.PermissionError

MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

Имя	Путь	Тип	Описание
данные	data	array of V2.UserDetails
Ошибки	errors	array of V2.TeamUserError

MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Имя	Путь	Тип	Описание
данные	data	array of V2.UserDutyDetails
Ошибки	errors	array of V2.DutyChangeError

ОбзорEvent

Имя	Путь	Тип	Описание
acknowledgedAlerts	acknowledgedAlerts	array of string
alertId	alertId	string
categoryId	categoryId	string
closedAlerts	closedAlerts	array of string
время создания	creationTime	date-time
eventSourceGroupId	eventSourceGroupId	string
eventSourceId	eventSourceId	string
eventSourceTeamId	eventSourceTeamId	string
eventSourceType	eventSourceType	EventSourceTypes	0 = нет 1 = электронная почта 2 = веб-перехватчик 3 = скрипт 4 = система 5 = вручную 6 = голос 7 = API
eventStatus	eventStatus	EventStatusCodes	0 = нет 1 = обработка 2 = Signled 3 = отфильтрованный 4 = разрешено 5 = отменено 6 = подтверждено 7 = отложено 8 = NoRuleApplied 9 = MultipleTargetStatus 1000 = ошибка
id	id	string
последнееИзменение	lastModified	date-time
severity	severity	EventSeverities	0 = низкий 1 = основной 2 = критическое
teamId	teamId	string
текст	text	string
title	title	string

PagedResultsPublicContinuationToken

Имя	Путь	Тип
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string

PagedResultsPublic-1-OverviewEvent-

Имя	Путь	Тип
continuationToken	continuationToken	PagedResultsPublicContinuationToken
hasMore	hasMore	boolean
results	results	array of OverviewEvent

PagedResultsPublic-1-V2.AlertInfo-

Имя	Путь	Тип
continuationToken	continuationToken	PagedResultsPublicContinuationToken
hasMore	hasMore	boolean
results	results	array of V2.AlertInfo

PagedResultsPublic-1-V2.RemoteJob-

Имя	Путь	Тип
continuationToken	continuationToken	PagedResultsPublicContinuationToken
hasMore	hasMore	boolean
results	results	array of V2.RemoteJob

PersistentNotificationModes

0 = выкл.
1 = сводка

0 = выкл.
1 = сводка

: integer

ПредоплаченнаяBalanceInfo

Имя	Путь	Тип
равновесие	balance	integer
latestTopUp	latestTopUp	date-time
pendingTransactions	pendingTransactions	boolean

PrepaidSettingsInfo

Имя	Путь	Тип
topUpAmount	topUpAmount	integer
topUpEnabled	topUpEnabled	boolean
topUpLimit	topUpLimit	integer

ПредоплаченнаяtransactionInfo

Имя	Путь	Тип
количество	amount	integer
autoTopUpId	autoTopUpId	string
создано	created	date-time
создано кем	createdBy	string
currency	currency	string
изменено	modified	date-time
packageCode	packageCode	string
статус	status	string
код состояния	statusCode	integer
subscriptionId	subscriptionId	string
transactionId	transactionId	string

ScheduleInfo

Имя	Путь	Тип
конец	end	date-time
id	id	string
options	options	integer
start	start	date-time
userId	userId	string

ScriptDescriptionData

Имя	Путь	Тип
описание	description	string
имя	name	string
scriptType	scriptType	string
краткое описание	shortDescription	string

ScriptInstanceDetails

Имя	Путь	Тип
config	config
customScriptDescription	customScriptDescription	string
customScriptName	customScriptName	string
enabled	enabled	boolean
Шаблон события	eventPattern
eventSourceId	eventSourceId	string
instanceId	instanceId	string
последнееИзменение	lastModified	date-time
runtimeInformation	runtimeInformation	ScriptInstanceInfoRuntimeInformationModel
scriptId	scriptId	string
scriptName	scriptName	string
subscriptionId	subscriptionId	string
teamId	teamId	string
webhookUrl	webhookUrl	string

ScriptInstanceInfo

Имя	Путь	Тип
customScriptDescription	customScriptDescription	string
customScriptName	customScriptName	string
enabled	enabled	boolean
Шаблон события	eventPattern
eventSourceId	eventSourceId	string
instanceId	instanceId	string
последнееИзменение	lastModified	date-time
runtimeInformation	runtimeInformation	ScriptInstanceInfoRuntimeInformationModel
scriptId	scriptId	string
scriptName	scriptName	string
subscriptionId	subscriptionId	string
teamId	teamId	string

ScriptInstanceInfoRuntimeInformationModel

Имя

Путь

Тип

Описание

runtimeStatus

ScriptInstanceInfoRuntimeStatus

0 = неизвестно
1 = запуск
2 = ОК
3 = остановка
4 = остановлено
-1 = ошибка

runtimeStatusMessage

string

ScriptInstanceInfoRuntimeStatus

0 = неизвестно
1 = запуск
2 = ОК
3 = остановка
4 = остановлено
-1 = ошибка

0 = неизвестно
1 = запуск
2 = ОК
3 = остановка
4 = остановлено
-1 = ошибка

: integer

ScriptLocalizationDetail

Имя	Путь	Тип
config	config
данные	data	ScriptDescriptionData
language	language	string

SubscriptionFeature

Имя	Путь	Тип
имя	name	string
type	type	integer
value	value	string

SubscriptionInfo

Имя	Путь	Тип
branchId	branchId	string
country	country	string
currency	currency	string
externalAccountId	externalAccountId	string
id	id	string
имя	name	string
nextBilling	nextBilling	date-time
ownerId	ownerId	string
planCode	planCode	string
planState	planState	integer
referralEnabled	referralEnabled	boolean
статус	status	integer

TeamCategoryOptOutModes

0 = нет
1 = отключено
2 = личное

0 = нет
1 = отключено
2 = личное

: integer

TeamDutySummaryInfo

Имя	Путь	Тип
dutyAssistEnabled	dutyAssistEnabled	boolean
dutySummaries	dutySummaries	array of DutySummaryInfo
teamId	teamId	string

TeamInfo

Имя	Путь	Тип
id	id	string
imageLastModified	imageLastModified	date-time
memberIds	memberIds	array of string
имя	name	string
setupProgressEnabled	setupProgressEnabled	boolean
subscriptionId	subscriptionId	string
timezone	timezone	string

TeamSetupProgress

Имя	Путь	Тип
completedSteps	completedSteps	array of string
teamId	teamId	string
отметка времени	timestamp	date-time

UserDutyInfo

Имя	Путь	Тип
lastChange	lastChange	date-time
onDuty	onDuty	boolean
onManagerDuty	onManagerDuty	boolean
просроченный	overdue	boolean
teamId	teamId	string
userId	userId	string

UserImage

Имя	Путь	Тип
содержимое	content	byte
contentDispostion	contentDispostion	string
contentEncoding	contentEncoding	string
Тип контента	contentType	string
последнееИзменение	lastModified	date-time
имя	name	string

Информация о пользователе

Имя	Путь	Тип
colorIndex	colorIndex	integer
contactAddresses	contactAddresses	array of
dutyInfos	dutyInfos	UserDutyInfo
externalAuthProvider	externalAuthProvider	string
id	id	string
isDeactivated	isDeactivated	boolean
isInvite	isInvite	boolean
isRemoteActionPinSet	isRemoteActionPinSet	boolean
lastSeen	lastSeen	date-time
почта	mail	string
имя	name	string
roleId	roleId	string
subscriptionId	subscriptionId	string
часовой пояс	timeZone	string
userImageLastModified	userImageLastModified	date-time

UserLicenseInfo

Имя	Путь	Тип
currentUsers	currentUsers	integer
isFree	isFree	boolean
isTrial	isTrial	boolean
лицензированныеUsers	licensedUsers	integer
planCode	planCode	string

UserPermission

Имя	Путь	Тип	Описание
дозволенный	allowed	boolean
разрешение	permission	string

UserSetupProgress

Имя	Путь	Тип
completedSteps	completedSteps	array of string
отметка времени	timestamp	date-time
userId	userId	string

Версия 2. AlertAnnotationDetails

Имя	Путь	Тип	Описание
id	id	string
teamId	teamId	string
текст	text	string
отметка времени	timestamp	date-time
type	type	V2.AlertAnnotationTypes	0 = нет 1 = текст 2 = изображение
userId	userId	string

Версия 2. AlertAnnotationTypes

0 = нет
1 = текст
2 = изображение

0 = нет
1 = текст
2 = изображение

: integer

Версия 2. AlertAttachmentInfo

Имя	Путь	Тип
Тип контента	contentType	string
id	id	string
имя	name	string

Версия 2. AlertCategoryCountsDetails

Имя	Путь	Тип
признанный	acknowledged	integer
categoryId	categoryId	string
закрытый	closed	integer
Необработанные	unhandled	integer

Версия 2. AlertCountTypes

1 = TeamCurrentDuty
2 = TeamLastDuty
3 = UserLastDutyChange
4 = Last24Hours

1 = TeamCurrentDuty
2 = TeamLastDuty
3 = UserLastDutyChange
4 = Last24Hours

: integer

Версия 2. AlertCountsDetails

Имя	Путь	Тип	Описание
признанный	acknowledged	integer
categoryCounts	categoryCounts	array of V2.AlertCategoryCountsDetails
закрытый	closed	integer
конец	end	date-time
последнееИзменение	lastModified	date-time
start	start	date-time
subscriptionId	subscriptionId	string
teamId	teamId	string
type	type	V2.AlertCountTypes	1 = TeamCurrentDuty 2 = TeamLastDuty 3 = UserLastDutyChange 4 = Last24Hours
typeString	typeString	string
Необработанные	unhandled	integer
userId	userId	string

Версия 2. AlertDeliveryStatusCodes

0 = нет
1 = Открыть
2 = сбой
4 = передано
6 = доставлено
8 = защищенный
9 = abuseProtected
22 = PartlyFailed
24 = PartlyTransmitted
26 = PartlyDelivered
30 = NoOneOnDuty
31 = NoOneNotified

0 = нет
1 = Открыть
2 = сбой
4 = передано
6 = доставлено
8 = защищенный
9 = abuseProtected
22 = PartlyFailed
24 = PartlyTransmitted
26 = PartlyDelivered
30 = NoOneOnDuty
31 = NoOneNotified

: integer

Версия 2. AlertDeliveryStatusDetails

Имя

Путь

Тип

Описание

alertId

string

код состояния

statusCode

V2.AlertDeliveryStatusCodes

0 = нет
1 = Открыть
2 = сбой
4 = передано
6 = доставлено
8 = защищенный
9 = abuseProtected
22 = PartlyFailed
24 = PartlyTransmitted
26 = PartlyDelivered
30 = NoOneOnDuty
31 = NoOneNotified

userDeliveryStatus

array of V2.UserDeliveryStatus

Версия 2. AlertDetails

Имя	Путь	Тип	Описание
parameters	parameters	array of V2.EventParameterDetails
attachments	attachments	array of V2.AlertAttachmentInfo
categoryId	categoryId	string
Эскалации	escalations	array of V2.AlertEscalationDetails
eventId	eventId	string
externalId (внешний идентификатор)	externalId	string
flags	flags	V2.AlertFlags	0 = нет 1 = HasAttachments 2 = HasAnnotations 4 = IsBreached 8 = HasLocationInfo 16 = ЭскалацияToTeam 32 = ЭскалацияToManager 64 = CreatedByEscalation
история	history	V2.AlertHistoryInfo
id	id	string
последнееИзменение	lastModified	date-time
requiredAcknowledgements	requiredAcknowledgements	integer
severity	severity	V2.AlertSeverities	0 = низкий 1 = основной 2 = критическое
статус	status	V2.AlertStatusDetails
subscriptionId	subscriptionId	string
teamId	teamId	string
текст	text	string
временная шкалаEntries	timelineEntries	array of
title	title	string
workflowType	workflowType	V2.AlertWorkflowTypes	0 = нет 1 = пользователь 2 = TeamBroadcast 3 = TeamEscalation 4 = MultiAcknowledge 5 = MultiAcknowledgeEmergency

Версия 2. AlertEscalationDetails

Имя	Путь	Тип	Описание
alertId	alertId	string
alertStatus	alertStatus	V2.AlertStatusCodes	0 = нет 1 = Открыть 2 = подтверждено 4 = закрыто 8 = NoReply 16 = неудачно 32 = ошибка
escType	escType	V2.AlertEscalationType	0 = нет 1 = диспетчер 2 = команда
статус	status	V2.AlertEscalationStatus	0 = ОК 1 = InProgress 2 = TargetInvalid 3 = TargetPrivate 4 = отфильтрованный 5 = подавлено
teamId	teamId	string
teamName	teamName	string
отметка времени	timestamp	date-time

Версия 2. AlertEscalationStatus

0 = ОК
1 = InProgress
2 = TargetInvalid
3 = TargetPrivate
4 = отфильтрованный
5 = подавлено

0 = ОК
1 = InProgress
2 = TargetInvalid
3 = TargetPrivate
4 = отфильтрованный
5 = подавлено

: integer

Версия 2. AlertEscalationType

0 = нет
1 = диспетчер
2 = команда

0 = нет
1 = диспетчер
2 = команда

: integer

Версия 2. AlertFlags

0 = нет
1 = HasAttachments
2 = HasAnnotations
4 = IsBreached
8 = HasLocationInfo
16 = ЭскалацияToTeam
32 = ЭскалацияToManager
64 = CreatedByEscalation

0 = нет
1 = HasAttachments
2 = HasAnnotations
4 = IsBreached
8 = HasLocationInfo
16 = ЭскалацияToTeam
32 = ЭскалацияToManager
64 = CreatedByEscalation

: integer

Версия 2. AlertHistoryInfo

Имя	Путь	Тип
acknowledgedAt	acknowledgedAt	date-time
Благодарности	acknowledgements	array of string
closedAt	closedAt	date-time
closedBy	closedBy	string
создано	created	date-time

Версия 2. AlertInfo

Имя	Путь	Тип	Описание
categoryId	categoryId	string
eventId	eventId	string
externalId (внешний идентификатор)	externalId	string
flags	flags	V2.AlertFlags	0 = нет 1 = HasAttachments 2 = HasAnnotations 4 = IsBreached 8 = HasLocationInfo 16 = ЭскалацияToTeam 32 = ЭскалацияToManager 64 = CreatedByEscalation
история	history	V2.AlertHistoryInfo
id	id	string
последнееИзменение	lastModified	date-time
requiredAcknowledgements	requiredAcknowledgements	integer
severity	severity	V2.AlertSeverities	0 = низкий 1 = основной 2 = критическое
статус	status	V2.AlertStatusDetails
subscriptionId	subscriptionId	string
teamId	teamId	string
текст	text	string
title	title	string
workflowType	workflowType	V2.AlertWorkflowTypes	0 = нет 1 = пользователь 2 = TeamBroadcast 3 = TeamEscalation 4 = MultiAcknowledge 5 = MultiAcknowledgeEmergency

Версия 2. AlertReportError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. AlertSettingsChannelType

0 = нет
1 = Push
2 = голос
3 = SMS

0 = нет
1 = Push
2 = голос
3 = SMS

: integer

Версия 2. AlertSettingsDetails

Имя	Путь	Тип	Описание
escEnabled	escEnabled	boolean
escMode	escMode	AlertEscalationModes	0 = диспетчер 1 = команда
escRefId	escRefId	string
filterAction	filterAction	AlertFilterActions	0 = подавление 1 = скрыть 2 = Отключение
filterMode	filterMode	AlertFilterModes	0 = выкл. 1 = WhiteListAllCategories
notificationProfileOverrides	notificationProfileOverrides	array of V2.AlertSettingsNotificationProfileDetails
optOut	optOut	TeamCategoryOptOutModes	0 = нет 1 = отключено 2 = личное
overrideNotificationProfiles	overrideNotificationProfiles	boolean
persNotInterval	persNotInterval	integer
persNotMode	persNotMode	PersistentNotificationModes	0 = выкл. 1 = сводка
responseMode	responseMode	AlertResponseModes	2 = SingleAcknowledge 4 = MultiAcknowledge
responseTime	responseTime	integer
teamId	teamId	string

Версия 2. AlertSettingsError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. AlertSettingsNotificationProfileDetails

Имя

Путь

Тип

Описание

канал

channel

V2.AlertSettingsChannelType

0 = нет
1 = Push
2 = голос
3 = SMS

delayInMinutes

integer

enabled

boolean

Версия 2. Оповещения

0 = низкий
1 = основной
2 = критическое

0 = низкий
1 = основной
2 = критическое

: integer

Версия 2. AlertStatusCodes

0 = нет
1 = Открыть
2 = подтверждено
4 = закрыто
8 = NoReply
16 = неудачно
32 = ошибка

0 = нет
1 = Открыть
2 = подтверждено
4 = закрыто
8 = NoReply
16 = неудачно
32 = ошибка

: integer

Версия 2. AlertStatusDetails

Имя

Путь

Тип

Описание

alertDeliveryStatus

V2.AlertDeliveryStatusDetails

код состояния

statusCode

V2.AlertStatusCodes

0 = нет
1 = Открыть
2 = подтверждено
4 = закрыто
8 = NoReply
16 = неудачно
32 = ошибка

Версия 2. AlertWorkflowTypes

0 = нет
1 = пользователь
2 = TeamBroadcast
3 = TeamEscalation
4 = MultiAcknowledge
5 = MultiAcknowledgeEmergency

0 = нет
1 = пользователь
2 = TeamBroadcast
3 = TeamEscalation
4 = MultiAcknowledge
5 = MultiAcknowledgeEmergency

: integer

Версия 2. AlertingPatternChannelType

0 = нет
1 = Push
2 = голос
3 = SMS

0 = нет
1 = Push
2 = голос
3 = SMS

: integer

Версия 2. AlertingPatternDetails

Имя	Путь	Тип
categories	categories	array of string
эскалацияSettings	escalationSettings	V2.AlertingPatternEscalationSettings
id	id	string
имя	name	string
notificationProfileOverrides	notificationProfileOverrides	array of V2.AlertingPatternNotificationProfileDetails
overrideEscalationSettings	overrideEscalationSettings	boolean
overrideNotificationProfiles	overrideNotificationProfiles	boolean
overrideResponseSettings	overrideResponseSettings	boolean
responseSettings	responseSettings	V2.AlertingPatternResponseSettings
suppressSignl	suppressSignl	boolean
timeSlots	timeSlots	array of V2.TimeSlotDetails

Версия 2. AlertingPatternEscalationSettings

Имя

Путь

Тип

Описание

enabled

boolean

mode

AlertEscalationModes

0 = диспетчер
1 = команда

referenceId

string

Версия 2. AlertingPatternNotificationProfileDetails

Имя

Путь

Тип

Описание

канал

channel

V2.AlertingPatternChannelType

0 = нет
1 = Push
2 = голос
3 = SMS

delayInMinutes

integer

enabled

boolean

Версия 2. AlertingPatternResponseSettings

Имя

Путь

Тип

Описание

responseMode

AlertResponseModes

2 = SingleAcknowledge
4 = MultiAcknowledge

responseTime

integer

Версия 2. CalloutTemplateDetails

Имя	Путь	Тип	Описание
categoryId	categoryId	string
externalId (внешний идентификатор)	externalId	string
id	id	string
location	location	string
имя	name	string
субъект	subject	string
targetAllTeams	targetAllTeams	boolean
targetTeamId	targetTeamId	string
текст	text	string
workflowType	workflowType	V2.CalloutTemplateWorkflowType	0 = AsConfiguredInTeam 2 = TeamBroadcast 4 = MultiAcknowledge 5 = MultiAcknowledgeEmergency

Версия 2. CalloutTemplateWorkflowType

0 = AsConfiguredInTeam
2 = TeamBroadcast
4 = MultiAcknowledge
5 = MultiAcknowledgeEmergency

0 = AsConfiguredInTeam
2 = TeamBroadcast
4 = MultiAcknowledge
5 = MultiAcknowledgeEmergency

: integer

Версия 2. CategoryAugmentationDetails

Имя	Путь	Тип	Описание
enabled	enabled	boolean
id	id	string
имя	name	string
type	type	V2.CategoryAugmentationType	0 = параметр 1 = тема 2 = текст 3 = расположение
value	value	string

Версия 2. CategoryAugmentationType

0 = параметр
1 = тема
2 = текст
3 = расположение

0 = параметр
1 = тема
2 = текст
3 = расположение

: integer

Версия 2. CategoryDetails

Имя	Путь	Тип	Описание
augmentations	augmentations	array of V2.CategoryAugmentationDetails
color	color	string
обогащения	enrichments	array of V2.CategoryEnrichmentDetails
id	id	string
imageName	imageName	string
isDefault	isDefault	boolean
keywordMatching	keywordMatching	V2.KeywordMatchingType	0 = любой 1 = все
ключевые слова	keywords	array of string
keywordsExcluded	keywordsExcluded	array of string
имя	name	string
options	options	V2.CategoryOptions	0 = нет 1 = скрытый 2 = DenyDelete 4 = HideOptOut 8 = HideKeywords
заказ	order	integer
teamId	teamId	string

Версия 2. CategoryEnrichmentDetails

Имя	Путь	Тип	Описание
id	id	string
имя	name	string
type	type	V2.CategoryEnrichmentType	0 = параметр 1 = гиперссылка
value	value	string

Версия 2. CategoryEnrichmentType

0 = параметр
1 = гиперссылка

0 = параметр
1 = гиперссылка

: integer

Версия 2. CategoryError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. CategoryOptions

0 = нет
1 = скрытый
2 = DenyDelete
4 = HideOptOut
8 = HideKeywords

0 = нет
1 = скрытый
2 = DenyDelete
4 = HideOptOut
8 = HideKeywords

: integer

Версия 2. ChannelType

0 = нет
1 = Push
2 = электронная почта
4 = Bot
8 = голос
16 = SMS

0 = нет
1 = Push
2 = электронная почта
4 = Bot
8 = голос
16 = SMS

: integer

Версия 2. DutyChangeError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string
userId	userId	string

Версия 2. DutyError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. DutyModes

0 = нет
1 = первичный
100 = Manager

0 = нет
1 = первичный
100 = Manager

: integer

Версия 2. EventDetails

Имя	Путь	Тип	Описание
parameters	parameters	array of V2.EventParameterDetails
acknowledgedAlerts	acknowledgedAlerts	array of string
closedAlerts	closedAlerts	array of string
время создания	creationTime	date-time
eventSourceGroupId	eventSourceGroupId	string
eventSourceId	eventSourceId	string
eventSourceTeamId	eventSourceTeamId	string
eventSourceType	eventSourceType	V2.EventSourceTypes	0 = нет 1 = электронная почта 2 = веб-перехватчик 3 = скрипт 4 = система 5 = вручную 6 = голос 7 = API
eventStatus	eventStatus	V2.EventStatusCodes	0 = нет 1 = обработка 2 = Signled 3 = отфильтрованный 4 = разрешено 5 = отменено 6 = подтверждено 7 = отложено 8 = NoRuleApplied 9 = MultipleTargetStatus 1000 = ошибка
externalId (внешний идентификатор)	externalId	string
от / из / с (context-dependent)	from	string
id	id	string
последнееИзменение	lastModified	date-time
severity	severity	V2.EventSeverities	0 = низкий 1 = основной 2 = критическое
targets	targets	array of V2.EventTargetDetails
текст	text	string
title	title	string

Версия 2. EventParameterDetails

Имя	Путь	Тип	Описание
id	id	string
имя	name	string
options	options	V2.EventParameterOptions	0 = нет 1 = ExcludeFromCategorization
заказ	order	integer
type	type	V2.EventParameterTypes	0 = нет 1 = объект 2 = массив 3 = конструктор 4 = свойство 5 = комментарий 6 = целое число 7 = Float 8 = строка 9 = логический 10 = NULL 11 = неопределено 12 = Дата 13 = необработанный 14 = Байт 15 = GUID 16 = URI 17 = TimeSpan 100 = Html
value	value	string

Версия 2. EventParameterOptions

0 = нет
1 = ExcludeFromCategorization

0 = нет
1 = ExcludeFromCategorization

: integer

Версия 2. EventParameterTypes

0 = нет
1 = объект
2 = массив
3 = конструктор
4 = свойство
5 = комментарий
6 = целое число
7 = Float
8 = строка
9 = логический
10 = NULL
11 = неопределено
12 = Дата
13 = необработанный
14 = Байт
15 = GUID
16 = URI
17 = TimeSpan
100 = Html

0 = нет
1 = объект
2 = массив
3 = конструктор
4 = свойство
5 = комментарий
6 = целое число
7 = Float
8 = строка
9 = логический
10 = NULL
11 = неопределено
12 = Дата
13 = необработанный
14 = Байт
15 = GUID
16 = URI
17 = TimeSpan
100 = Html

: integer

Версия 2. События

0 = низкий
1 = основной
2 = критическое

0 = низкий
1 = основной
2 = критическое

: integer

Версия 2. EventSourceEndpointError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. EventSourceTypes

0 = нет
1 = электронная почта
2 = веб-перехватчик
3 = скрипт
4 = система
5 = вручную
6 = голос
7 = API

0 = нет
1 = электронная почта
2 = веб-перехватчик
3 = скрипт
4 = система
5 = вручную
6 = голос
7 = API

: integer

Версия 2. EventStatusCodes

0 = нет
1 = обработка
2 = Signled
3 = отфильтрованный
4 = разрешено
5 = отменено
6 = подтверждено
7 = отложено
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = ошибка

0 = нет
1 = обработка
2 = Signled
3 = отфильтрованный
4 = разрешено
5 = отменено
6 = подтверждено
7 = отложено
8 = NoRuleApplied
9 = MultipleTargetStatus
1000 = ошибка

: integer

Версия 2. EventTargetDetails

Имя	Путь	Тип	Описание
alertId	alertId	string
categoryId	categoryId	string
время создания	creationTime	date-time
distributionId	distributionId	string
eventId	eventId	string
eventTargetStatus	eventTargetStatus	V2.EventTargetStatusCode	0 = нет 1 = обработка 2 = Signled 3 = отфильтрованный 4 = разрешено 5 = отменено 6 = подтверждено 7 = отложено 1000 = ошибка
id	id	string
последнееИзменение	lastModified	date-time
teamId	teamId	string

Версия 2. EventTargetStatusCode

0 = нет
1 = обработка
2 = Signled
3 = отфильтрованный
4 = разрешено
5 = отменено
6 = подтверждено
7 = отложено
1000 = ошибка

0 = нет
1 = обработка
2 = Signled
3 = отфильтрованный
4 = разрешено
5 = отменено
6 = подтверждено
7 = отложено
1000 = ошибка

: integer

Версия 2. HolidayDetails

Имя	Путь	Тип	Описание
day	day	integer
month	month	V2.Month	0 = отмена набора 1 = январь 2 = февраль 3 = март 4 = апрель 5 = май 6 = июнь 7 = июль 8 = август 9 = сентябрь 10 = октябрь 11 = ноябрь 12 = декабрь
повторяющийся	repeating	boolean
год	year	integer

Версия 2. ПриглашениеResult

Имя	Путь	Тип
Код ошибки	errorCode	integer
errorMessage	errorMessage	string
приглашенныйUser	invitedUser	V2.InvitedUserInfo
success	success	boolean

Версия 2. InvitedUserInfo

Имя	Путь	Тип	Описание
mailAddress	mailAddress	string
roleId	roleId	string
статус	status	V2.UserStatus	0 = нет 1 = удалено 2 = приглашено 3 = активный
userId	userId	string

Версия 2. KeywordMatchingType

0 = любой
1 = все

0 = любой
1 = все

: integer

Версия 2. Месяц

0 = отмена набора
1 = январь
2 = февраль
3 = март
4 = апрель
5 = май
6 = июнь
7 = июль
8 = август
9 = сентябрь
10 = октябрь
11 = ноябрь
12 = декабрь

0 = отмена набора
1 = январь
2 = февраль
3 = март
4 = апрель
5 = май
6 = июнь
7 = июль
8 = август
9 = сентябрь
10 = октябрь
11 = ноябрь
12 = декабрь

: integer

Версия 2. NotificationProfileDetails

Имя	Путь	Тип	Описание
канал	channel	V2.ChannelType	0 = нет 1 = Push 2 = электронная почта 4 = Bot 8 = голос 16 = SMS
delayInMinutes	delayInMinutes	integer
enabled	enabled	boolean
options	options	integer
упорный	persistent	boolean

Версия 2. ПерекрытиеTimeSlotsDetails

Имя	Путь	Тип	Описание
refId	refId	string
timeSlots	timeSlots	array of V2.TimeSlotDetails

Версия 2. PermissionError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. PhoneNumberValidationStatus

0 = NotValidated
1 = проверено
2 = CountryNotSupported

0 = NotValidated
1 = проверено
2 = CountryNotSupported

: integer

Версия 2. RemoteActionDefinitionDetails

Имя	Путь	Тип	Описание
parameters	parameters	array of V2.RemoteActionDefinitionParameterDetails
createdAt	createdAt	date-time
описание	description	string
executorService	executorService	string
externalId (внешний идентификатор)	externalId	string
id	id	string
имя	name	string
код состояния	statusCode	V2.RemoteActionDefinitionStatus	0 = отключено 1 = включено 2 = недопустимо
statusDescription	statusDescription	string
type	type	V2.RemoteActionTypes	0 = неизвестно 1 = скрипт 2 = EnterpriseAlert 3 = веб-перехватчик
version	version	integer

Версия 2. RemoteActionDefinitionParameterDetails

Имя	Путь	Тип	Описание
controlType	controlType	V2.RemoteActionParameterControlTypes	0 = текст 1 = MultiLineText 2 = целое число 3 = Double 4 = Bool 5 = время 6 = Дата 7 = часовой пояс 8 = пароль 9 = ПИН-код 10 = SingleChoice 11 = MultiChoice 12 = предложение
defaultValue	defaultValue	string
описание	description	string
отображаемое имя	displayName	string
имя	name	string
options	options	V2.RemoteActionParameterOptions	0 = нет 1 = обязательный 2 = заблокировано 4 = Зашифровано
заказ	order	integer
values	values	array of string

Версия 2. RemoteActionDefinitionStatus

0 = отключено
1 = включено
2 = недопустимо

0 = отключено
1 = включено
2 = недопустимо

: integer

Версия 2. RemoteActionDetails

Имя	Путь	Тип	Описание
parameters	parameters	array of V2.RemoteActionParameter
доступ	access	array of V2.RemoteActionTeamAccessDetails
createdAt	createdAt	date-time
currentPrincipal	currentPrincipal	V2.RemoteActionPrincipalAccessDetails
definitionId	definitionId	string
definitionVersion	definitionVersion	integer
описание	description	string
enabled	enabled	boolean
executorService	executorService	string
externalId (внешний идентификатор)	externalId	string
id	id	string
имя	name	string
код состояния	statusCode	V2.RemoteActionStatus	0 = отключено 1 = включено 2 = недопустимо 4 = ProviderDisabled
statusDescription	statusDescription	string
subscriptionId	subscriptionId	string
teamId	teamId	string
type	type	V2.RemoteActionTypes	0 = неизвестно 1 = скрипт 2 = EnterpriseAlert 3 = веб-перехватчик

Версия 2. RemoteActionInfo

Имя	Путь	Тип	Описание
доступ	access	array of V2.RemoteActionTeamAccessDetails
createdAt	createdAt	date-time
currentPrincipal	currentPrincipal	V2.RemoteActionPrincipalAccessDetails
definitionId	definitionId	string
описание	description	string
enabled	enabled	boolean
id	id	string
имя	name	string
код состояния	statusCode	V2.RemoteActionStatus	0 = отключено 1 = включено 2 = недопустимо 4 = ProviderDisabled
statusDescription	statusDescription	string
subscriptionId	subscriptionId	string
teamId	teamId	string
type	type	V2.RemoteActionTypes	0 = неизвестно 1 = скрипт 2 = EnterpriseAlert 3 = веб-перехватчик

Версия 2. RemoteActionParameter

Имя	Путь	Тип	Описание
controlType	controlType	V2.RemoteActionParameterControlTypes	0 = текст 1 = MultiLineText 2 = целое число 3 = Double 4 = Bool 5 = время 6 = Дата 7 = часовой пояс 8 = пароль 9 = ПИН-код 10 = SingleChoice 11 = MultiChoice 12 = предложение
отображаемое имя	displayName	string
имя	name	string
options	options	V2.RemoteActionParameterOptions	0 = нет 1 = обязательный 2 = заблокировано 4 = Зашифровано
заказ	order	integer
value	value	string
values	values	array of string

Версия 2. RemoteActionParameterControlTypes

0 = текст
1 = MultiLineText
2 = целое число
3 = Double
4 = Bool
5 = время
6 = Дата
7 = часовой пояс
8 = пароль
9 = ПИН-код
10 = SingleChoice
11 = MultiChoice
12 = предложение

0 = текст
1 = MultiLineText
2 = целое число
3 = Double
4 = Bool
5 = время
6 = Дата
7 = часовой пояс
8 = пароль
9 = ПИН-код
10 = SingleChoice
11 = MultiChoice
12 = предложение

: integer

Версия 2. RemoteActionParameterOptions

0 = нет
1 = обязательный
2 = заблокировано
4 = Зашифровано

0 = нет
1 = обязательный
2 = заблокировано
4 = Зашифровано

: integer

Версия 2. RemoteActionPrincipalAccessDetails

Имя	Путь	Тип	Описание
canEdit	canEdit	boolean
canExecute	canExecute	boolean

Версия 2. RemoteActionStatus

0 = отключено
1 = включено
2 = недопустимо
4 = ProviderDisabled

0 = отключено
1 = включено
2 = недопустимо
4 = ProviderDisabled

: integer

Версия 2. RemoteActionTeamAccessDetails

Имя	Путь	Тип
canEdit	canEdit	boolean
canExecute	canExecute	boolean
teamId	teamId	string

Версия 2. RemoteActionTypes

0 = неизвестно
1 = скрипт
2 = EnterpriseAlert
3 = веб-перехватчик

0 = неизвестно
1 = скрипт
2 = EnterpriseAlert
3 = веб-перехватчик

: integer

Версия 2. RemoteJob

Имя	Путь	Тип	Описание
parameters	parameters	array of V2.RemoteJobParameter
actionId	actionId	string
activatedAt	activatedAt	date-time
createdAt	createdAt	date-time
creatorInfo	creatorInfo	V2.RemoteJobCreatorDetails
definitionId	definitionId	string
externalId (внешний идентификатор)	externalId	string
id	id	string
LastUpdate	lastUpdate	date-time
options	options	V2.RemoteJobOptions	0 = нет
startedAt	startedAt	date-time
код состояния	statusCode	V2.RemoteJobStatusCodes	0 = нет 1 = ожидание 2 = готово 4 = выполнение 8 = выполнено 16 = ошибка
statusDescription	statusDescription	string
Детали статуса	statusDetails	string
type	type	V2.RemoteActionTypes	0 = неизвестно 1 = скрипт 2 = EnterpriseAlert 3 = веб-перехватчик

Версия 2. RemoteJobCreatorDetails

Имя

Путь

Тип

Описание

referenceId

string

referenceName

string

type

V2.RemoteJobCreatorType

0 = нет
1 = пользователь
2 = ApiKey
3 = система

Версия 2. RemoteJobCreatorType

0 = нет
1 = пользователь
2 = ApiKey
3 = система

0 = нет
1 = пользователь
2 = ApiKey
3 = система

: integer

Версия 2. RemoteJobOptions

0 = нет

0 = нет

: integer

Версия 2. RemoteJobParameter

Имя	Путь	Тип	Описание
имя	name	string
value	value	string

Версия 2. RemoteJobStatusCodes

0 = нет
1 = ожидание
2 = готово
4 = выполнение
8 = выполнено
16 = ошибка

0 = нет
1 = ожидание
2 = готово
4 = выполнение
8 = выполнено
16 = ошибка

: integer

Версия 2. ScheduleDetails

Имя	Путь	Тип
конец	end	date-time
id	id	string
options	options	integer
start	start	date-time
teamId	teamId	string
userId	userId	string

Версия 2. TeamDutySettingsDetails

Имя	Путь	Тип
autosnapEnabled	autosnapEnabled	boolean
dutyAssistantEnabled	dutyAssistantEnabled	boolean
dutyChangeNotificationsEnabled	dutyChangeNotificationsEnabled	boolean
dutyLength	dutyLength	integer
переход на другой ресурс	handoverDate	date-time
handoverTime	handoverTime	integer
handoverWeekDay	handoverWeekDay	integer
minMemberOnDuty	minMemberOnDuty	integer
ПланированиеEnabled	schedulingEnabled	boolean
shiftReportCarbonCopyMail	shiftReportCarbonCopyMail	string
shiftReportEnabled	shiftReportEnabled	boolean
teamId	teamId	string
timezone	timezone	string

Версия 2. TeamDutySettingsError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. TeamDutySummaryError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
userId	userId	string

Версия 2. TeamHolidayDetails

Имя	Путь	Тип	Описание
каникулы	holidays	array of V2.HolidayDetails
teamId	teamId	string

Версия 2. TeamImageDetails

Имя	Путь	Тип
содержимое	content	byte
contentDispostion	contentDispostion	string
contentEncoding	contentEncoding	string
Тип контента	contentType	string
последнееИзменение	lastModified	date-time
имя	name	string

Версия 2. TeamMembershipDetails

Имя	Путь	Тип	Описание
mailAddress	mailAddress	string
memberSince	memberSince	date-time
roleId	roleId	string
статус	status	V2.UserStatus	0 = нет 1 = удалено 2 = приглашено 3 = активный
teamId	teamId	string
userId	userId	string

Версия 2. TeamPermissions

Имя	Путь	Тип	Описание
permissions	permissions	array of UserPermission
teamId	teamId	string

Версия 2. TeamPrivacySettingsDetails

Имя	Путь	Тип
hideContactAddresses	hideContactAddresses	boolean
hideDutyData	hideDutyData	boolean
hideForEscalation	hideForEscalation	boolean
teamId	teamId	string

Версия 2. TeamPublicDetails

Имя	Путь	Тип
id	id	string
имя	name	string
privacySettings	privacySettings	V2.TeamPrivacySettingsDetails

Версия 2. TeamUserError

Имя	Путь	Тип
Код ошибки	errorCode	integer
описание ошибки	errorDescription	string
teamId	teamId	string

Версия 2. TimeSlotDetails

Имя	Путь	Тип
конец	end	V2.WeekTimeDetails
id	id	string
start	start	V2.WeekTimeDetails

Версия 2. TimeSlotValidationResultDetails

Имя	Путь	Тип
isOverlapping	isOverlapping	boolean
item	item	V2.TimeSlotDetails
перекрытиеTimeSlots	overlappingTimeSlots	array of V2.OverlappingTimeSlotsDetails
действительный	valid	boolean

Версия 2. UserDeliveryStatus

Имя

Путь

Тип

Описание

код состояния

statusCode

V2.UserDeliveryStatusCodes

0 = нет
1 = Открыть
2 = сбой
4 = передано
6 = доставлено
8 = защищенный
9 = abuseProtected
24 = PartlyTransmitted
26 = PartlyDelivered
30 = NotOnDuty
31 = CategoryOptOut
32 = NoMessagesSent

userId

string

Версия 2. UserDeliveryStatusCodes

0 = нет
1 = Открыть
2 = сбой
4 = передано
6 = доставлено
8 = защищенный
9 = abuseProtected
24 = PartlyTransmitted
26 = PartlyDelivered
30 = NotOnDuty
31 = CategoryOptOut
32 = NoMessagesSent

0 = нет
1 = Открыть
2 = сбой
4 = передано
6 = доставлено
8 = защищенный
9 = abuseProtected
24 = PartlyTransmitted
26 = PartlyDelivered
30 = NotOnDuty
31 = CategoryOptOut
32 = NoMessagesSent

: integer

Версия 2. UserDetails

Имя	Путь	Тип
colorIndex	colorIndex	integer
contactAddresses	contactAddresses	array of
dutyInfos	dutyInfos	array of V2.UserDutyDetails
externalAuthProvider	externalAuthProvider	string
id	id	string
isDeactivated	isDeactivated	boolean
isInvite	isInvite	boolean
lastSeen	lastSeen	date-time
почта	mail	string
имя	name	string
remoteActionPinSet	remoteActionPinSet	boolean
subscriptionId	subscriptionId	string
часовой пояс	timeZone	string
userImageLastModified	userImageLastModified	date-time

Версия 2. UserDutyDetails

Имя	Путь	Тип	Описание
dutyMode	dutyMode	V2.DutyModes	0 = нет 1 = первичный 100 = Manager
lastChange	lastChange	date-time
onDutyTime	onDutyTime	integer
просроченный	overdue	boolean
teamId	teamId	string
userId	userId	string

Версия 2. UserLocaleResponseDetails

Имя	Путь	Тип
id	id	string
language	language	string
часовой пояс	timeZone	string

Версия 2. UserPhoneNumberDetails

Имя

Путь

Тип

Описание

код страны

countryCode

string

номер телефона

phoneNumber

string

validationStatus

V2.PhoneNumberValidationStatus

0 = NotValidated
1 = проверено
2 = CountryNotSupported

Версия 2. UserStatus

0 = нет
1 = удалено
2 = приглашено
3 = активный

0 = нет
1 = удалено
2 = приглашено
3 = активный

: integer

Версия 2. WeekTimeDetails

Имя

Путь

Тип

Описание

час

hour

integer

протокол

minutes

integer

будний день

weekday

V2.Weekday

0 = Праздник
1 — понедельник;
2 — вторник;
3 — среда;
4 — четверг;
5 — пятница;
6 — суббота.
7 = воскресенье

Версия 2. Будний день

0 = Праздник
1 — понедельник;
2 — вторник;
3 — среда;
4 — четверг;
5 — пятница;
6 — суббота.
7 = воскресенье

0 = Праздник
1 — понедельник;
2 — вторник;
3 — среда;
4 — четверг;
5 — пятница;
6 — суббота.
7 = воскресенье

: integer

WebhookInfo

Имя	Путь	Тип
описание	description	string
enabled	enabled	boolean
extUrl	extUrl	string
id	id	string
имя	name	string
subId	subId	string
teamId	teamId	string

струна

Это базовый тип данных string.

бинарный

Это базовый тип данных binary.