|
Взаимодействие с IAPI происходит по HTTPS-протоколу с использованием mTLS. Аутентификация запросов в DION происходит по токену доступа. Токен имеет ограниченный срок действия, указанный при создании. В запросах к DION токен передаётся в заголовке X-Client-Access-Token. Количество токенов для организации не ограничено.
Токен доступа создаётся в административной панели DION. Инструкцию по созданию токена см. здесь.
Максимальная рекомендуемая нагрузка указана в таблице:
| Метрика | Значение |
|---|---|
| Общее количество запросов | 100/60 s |
| Количество единовременных запросов | 10/1 s |
Взаимодействовать с IAPI можно через коллекцию postman. Ссылка на коллекцию доступна здесь.
При работе с методами из данного раздела учтите следующее:
| Все почтовые адреса, которые вы передаете в запросе, должны быть зарегистрированы в DION (созданы учетные записи). Пользователи этих учетных записей должны хотя бы один раз войти в DION. |
| Владелец комнаты (owner_email) автоматически является и модератором. Не нужно передавать его адрес электронной почты в параметре moderators_emails. |
| Иногда релизы DION могут выходить чаще, чем обновления данного документа. |
Все настройки, доступные для конференций, можно получить при помощи метода:
GET api-integration.dion.vc/v1/events/params
Endpoint: POST api-integration.dion.vc/v1/events
Метод позволяет:
Параметры запроса:
| Название параметра | Вложенный параметр | Тип | Обязательность заполнения | Описание |
|---|---|---|---|---|
| event_params | array of strings | optional | Настройки комнаты при создании. Организатор может изменить их позже из личного кабинета DION. Вложенные параметры указываются как строки внутри массива. Разделитель — запятая. | |
| guest_access | string | optional | Если присутствует в запросе, вход для гостей открыт. В конференцию может подключиться любой пользователь, имеющий ссылку или номер телефона для подключения. |
|
| waiting_room | string | optional | Если присутствует в запросе, комната создается с залом ожидания. Владелец события или модератор решают, впустить ли участника из зала ожидания в основную комнату конференции. |
|
| access_only_with_moderators | string | optional | Если присутствует в запросе, вход в комнату доступен только в присутствии модератора или организатора. Без владельца или модератора событие не сможет начаться. После выхода всех модераторов из конференции событие завершится. |
|
| access_code_for_guests | string | optional | Если присутствует в запросе, при входе в конференцию гостям нужно будет ввести код доступа. | |
| access_code_for_all | string | optional | Если присутствует в запросе, при входе в конференцию пользователям нужно будет ввести код доступа. | |
| disable_chat | string | optional | Если присутствует в запросе, чат будет недоступен в конференции. |
|
| webinar_mode | string | optional | Если присутствует в запросе, конференция создается в режиме вебинара. При включенном режиме все участники будут подключаться к конференции без доступа к камере, микрофону и демонстрации экрана. Внутри конференции соответствующие доступы можно выдать участнику, сделав его спикером. |
|
| breakout_rooms_mode | string | optional | Если присутствует в запросе, конференция создается в режиме сессионных залов. При включенном режиме пользователи смогут разделиться по рабочим группам во время конференции. |
|
| auto_record_two_users | string | optional | Если присутствует в запросе, в конференции будет включена автоматическая запись встречи при подключении второго пользователя. Запись завершается после выхода всех пользователей из конференции. Модераторы не могут включать/выключать запись встречи. | |
| phone_call_beeps | string | optional | Если присутствует в запросе, в конференции инициатор звонка будет слышать гудки во время вызова на сотовый номер пользователя. | |
| is_on_cloud | boolean | mandatory |
Признак “Где будет проходить медиатрафик конференции”:
|
|
| link_settings | array of dict | mandatory | Параметры URL комнаты | |
| is_impersonal_slug | boolean | mandatory |
Тип ссылки на комнату:
|
|
| slug | string | optional |
Передается только в случае создания персонализированной конференции с привязкой к пользователю. В параметре указывается окончание URL комнаты (например: https://dion.vc/ivanov-room-for-smth). Максимальное число символов в поле slug - 64 (включая количество символов в логине пользователя, под которым создают ссылку). Для обезличенной комнаты значение не указывается; при отправке поля будет получена ошибка 400 Bad request. |
|
| moderators_emails | array of strings | optional | Дополнительные модераторы конференции. Передаются почтовые адреса УЗ пользователей в DION. Разделитель — запятая. | |
| owner_email | string | mandatory | Почтовый адрес организатора: пользователя, под учетной записью которого необходимо создать комнату. | |
| is_temporary | boolean | optional |
|
| Параметры в таблице выше передаются в виде JSON в теле POST-запроса. |
Схема запроса:
{
"event_params": [
"string",
"string"
],
"is_on_cloud": boolean,
"link_settings": {
"is_impersonal_slug": boolean,
"slug": "string"
},
"moderators_emails": [
"string",
"string"
],
"owner_email": "string",
"is_temporary": boolean
}
Параметры ответа:
| Название параметра | Вложенный параметр | Тип поля | Описание |
|---|---|---|---|
| id | string | Идентификатор комнаты в системе DION. | |
| owner_email | string | Почтовый адрес пользователя, под учетной записью которого создана комната. | |
| moderators_emails | string | Дополнительные модераторы конференции. Передаются почтовые адреса пользователей в DION. | |
| is_on_cloud | boolean |
Признак “Где будет проходить медиатрафик конференции”:
|
|
| event_params | array of strings | Параметры создаваемой комнаты. | |
| guest_access | string | Если присутствует, вход для гостей открыт. | |
| waiting_room | string | Если присутствует, комната создана с залом ожидания. | |
| access_only_with_moderators | string | Если присутствует, вход в комнату доступен только в присутствии модератора или организатора. | |
| access_code_for_guests | string | Если присутствует в запросе, при входе в конференцию гостям нужно будет ввести код доступа. | |
| access_code_for_all | string | Если присутствует в запросе, при входе в конференцию пользователям нужно будет ввести код доступа. | |
| disable_chat | string | Если присутствует, чат в конференции выключен. | |
| webinar_mode | string | Если присутствует, конференция создается в режиме вебинара. | |
| phone_call_beeps | string | Если присутствует, в конференции включены гудки при вызовах на сотовые номера. | |
| is_on_cloud | boolean |
Признак “Где будет проходить медиатрафик конференции”:
|
|
| is_temporary | boolean |
|
|
| link | string | URL комнаты. | |
| link_settings | object | Параметры URL комнаты. | |
| is_impersonal_slug | boolean | Тип ссылки на комнату: с возможностью кастомизации и с привязкой к пользователю или обезличенная. | |
| slug | string | Окончание URL комнаты (например: https://dion.vc/ivanov-room-for-smth). | |
| pstn | object | Массив данных для подключения к комнате с использованием телефонии. | |
| number | string | Номер телефона для подключения к телефонии. | |
| pin | int | Добавочный номер для подключения к комнате при помощи телефонии. |
Схема ответа:
{
"id": "string",
"owner_email": "string",
"moderators_emails": [
"string",
"string"
],
"is_on_cloud": boolean,
"is_temporary": boolean,
"event_params": [
"string",
"string"
],
"link": "string",
"link_settings": {
"slug": "string"
},
"pstn": {
"number": "string",
"pin": int,
},
"is_temporary": boolean
}
Endpoint: GET api-integration.dion.vc/v1/events/:event_id
Для получения данных по уже существующей конференции вашей организации, необходимо передать в URL запроса идентификатор комнаты.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
Пример запроса:
GET api-integration.dion.vc/v1/events/bbb9bbbb-555b-bbb-b5bb-b2bb5bbbbb5b
Параметры ответа:
| Название параметра | Вложенный параметр | Тип поля | Описание |
|---|---|---|---|
| id | string | Идентификатор комнаты в системе DION. | |
| owner_email | string | Почтовый адрес пользователя, под учетной записью которого создана комната. | |
| moderator_emails | string | Дополнительные модераторы конференции. Передаются почтовые адреса пользователей в DION. | |
| is_on_cloud | boolean |
Признак “Где будет проходить медиатрафик конференции”:
|
|
| is_temporary | boolean |
|
|
| event_params | array of strings | Параметры создаваемой комнаты. | |
| guest_access | string | Если присутствует, вход для гостей открыт. | |
| waiting_room | string | Если присутствует, комната создана с залом ожидания. | |
| access_only_with_moderators | string | Если присутствует, вход в комнату доступен только в присутствии модератора или организатора. | |
| access_code_for_guests | string | Если присутствует в запросе, при входе в конференцию гостям нужно будет ввести код доступа. | |
| access_code_for_all | string | Если присутствует в запросе, при входе в конференцию пользователям нужно будет ввести код доступа. | |
| disable_chat | string | Если присутствует, чат в конференции выключен. | |
| webinar_mode | string | Если присутствует, конференция создается в режиме вебинара. | |
| phone_call_beeps | string | Если присутствует, в конференции включены гудки при вызовах на сотовые номера. | |
| link | string | URL комнаты. | |
| link_settings | array of dict | Параметры URL комнаты. | |
| slug | string | Окончание URL комнаты (например: https://dion.vc/ivanov-room-for-smth). | |
| pstn | object | Массив данных для подключения к комнате с использованием телефонии. | |
| number | string | Номер телефона для подключения к телефонии. | |
| pin | int | Добавочный номер для подключения к комнате при помощи телефонии. |
Схема ответа:
{
"id": "string",
"owner_email": "string",
"moderators_emails": [
"string",
"string"
],
"is_on_cloud": boolean,
"is_temporary": boolean ,
"event_params": [
"string",
"string"
],
"link": "string",
"link_settings": {
"is_impersonal_slug": boolean,
"slug": "string"
},
"pstn": {
"number": "string",
"pin": int,
}
}
Endpoint: GET api-integration.dion.vc/v1/events/:event_id/sessions
Для получения списка сесcий комнаты.
Входные параметры:
Body-параметры
| Параметр | Описание | Тип | Обязательность | Пример | |
| time_start | Начало временного интервала | datetime UTC в соответствии RFC 3339 | Нет | ||
| time_end | Окончание временного интервала | datetime UTC в соответствии RFC 3339 | Нет | ||
| page | Номер страницы | number | Да | ||
| limit | Количество строк на странице | number | Да | ||
| event_ids | Массив событий не более 5000 элементов | array | Да | ||
| event_id | Идентификатор комнаты в формате уникального кода | string | Да | ||
Выходные параметры:
| Параметр | Описание | Тип | Обязательность | Пример | ||
| items | Массив | |||||
| event_id | Идентификатор комнаты в формате уникального кода | string | Да | |||
| sessions | Объект данных с информацией о сессии конференции | object | Да | |||
| id | Идентификатор сессии конференции | string | Да | |||
| session_start | Время создания сессии конференции | string | Да | |||
| session_end | Время окончания сессии конференции | string | Да | |||
| pagination | ||||||
| all_pages | Всего страниц | number | Да | 5 | ||
| all_records | Всего записей | number | Да | 150 | ||
| current_page | Текущая страница | number | Да | 1 | ||
| Особенности работы |
|
|---|---|
| Коды состояния HTTP |
|
Обработка ошибок
| HTTP status code | errorMessage | Описание |
|---|---|---|
| <Текст возвращаемого сообщения> | <В каких случаях возникает исключение> | |
Endpoint: PUT api-integration.dion.vc/v1/events/:event_id
Метод позволяет изменить настройки уже созданной комнаты для вашей организации.
В URL запроса необходимо передать идентификатор комнаты. В теле — новые значения параметров.
Параметры запроса:
Body-параметры:
| Название параметра | Вложенный параметр | Тип | Обязательность заполнения | Описание |
|---|---|---|---|---|
| event_params | array of strings | optional | Настройки комнаты при создании. Организатор может изменить их позже из личного кабинета DION. Вложенные параметры указываются как строки внутри массива. Разделитель — запятая. | |
| guest_access | string | optional | Если присутствует в запросе, вход для гостей открыт. В конференцию может подключиться любой пользователь, имеющий ссылку или номер телефона для подключения. |
|
| waiting_room | string | optional | Если присутствует в запросе, комната создается с залом ожидания. Владелец события или модератор решают, впустить ли участника из зала ожидания в основную комнату конференции. |
|
| access_only_with_moderators | string | optional | Если присутствует в запросе, вход в комнату доступен только в присутствии модератора или организатора. Без владельца или модератора событие не сможет начаться. После выхода всех модераторов из конференции событие завершится. |
|
| access_code_for_guests | string | optional | Если присутствует в запросе, при входе в конференцию гостям нужно будет ввести код доступа. | |
| access_code_for_all | string | optional | Если присутствует в запросе, при входе в конференцию пользователям нужно будет ввести код доступа. | |
| disable_chat | string | optional | Если присутствует в запросе, чат будет недоступен в конференции. |
|
| webinar_mode | string | optional | Если присутствует в запросе, конференция создается в режиме вебинара. При включенном режиме все участники будут подключаться к конференции без доступа к камере, микрофону и демонстрации экрана. Внутри конференции соответствующие доступы можно выдать участнику, сделав его спикером. |
|
| breakout_rooms_mode | string | optional | Если присутствует в запросе, конференция создается в режиме сессионных залов. При включенном режиме пользователи смогут разделиться по рабочим группам во время конференции. |
|
| auto_record_two_users | string | optional | Если присутствует в запросе, в конференции будет включена автоматическая запись встречи при подключении второго пользователя. Запись завершается после выхода всех пользователей из конференции. Модераторы не могут включать/выключать запись встречи. | |
| phone_call_beeps | string | optional | Если присутствует в запросе, в конференции инициатор звонка будет слышать гудки во время вызова на сотовый номер пользователя. | |
| is_on_cloud | boolean | optional |
Признак “Где будет проходить медиатрафик конференции”:
|
|
| link_settings | array of dict | optional | Параметры URL комнаты. | |
| is_impersonal_slug | boolean | optional |
Тип ссылки на комнату:
|
|
| slug | string | optional |
Передается только в случае создания персонализированной конференции с привязкой к пользователю. В параметре указывается окончание URL комнаты (например: https://dion.vc/ivanov-room-for-smth). Максимальное число символов в поле slug - 64 (включая количество символов в логине пользователя, под которым создают ссылку). Для обезличенной комнаты значение не указывается, при отправке поля будет получена ошибка 400 Bad request. |
|
| moderator_emails | array of strings | optional | Дополнительные модераторы конференции. Передаются почтовые адреса УЗ пользователей в DION. Разделитель — запятая. | |
| owner_email | string | mandatory | Почтовый адрес организатора: пользователя, под учетной записью которого необходимо создать комнату. | |
| is_temporary | boolean | optional |
|
Схема параметров в теле запроса:
{
"event_params": [
"string",
"string"
],
"is_on_cloud": boolean,
"link_settings": {
"is_impersonal_slug": boolean,
"slug": "string"
},
"moderators_emails": [
"string",
"string"
],
"owner_email": "string",
"is_temporary": boolean
}
Параметры ответа:
| Название параметра | Вложенный параметр | Тип поля | Описание |
|---|---|---|---|
| id | string | Идентификатор комнаты в системе DION. | |
| owner_email | string | Почтовый адрес пользователя, под учетной записью которого создана комната. | |
| moderator_emails | string | Дополнительные модераторы конференции. Передаются почтовые адреса пользователей в DION. | |
| is_on_cloud | boolean |
Признак “Где будет проходить медиатрафик конференции”:
|
|
| event_params | array of strings | Параметры создаваемой комнаты. | |
| guest_access | string | Если присутствует, вход для гостей открыт. | |
| waiting_room | string | Если присутствует, комната создана с залом ожидания. | |
| access_only_with_moderators | string | Если присутствует, вход в комнату доступен только в присутствии модератора или организатора. | |
| access_code_for_guests | string | Если присутствует в запросе, при входе в конференцию гостям нужно будет ввести код доступа. | |
| access_code_for_all | string | Если присутствует в запросе, при входе в конференцию пользователям нужно будет ввести код доступа. | |
| disable_chat | string | Если присутствует, чат в конференции выключен. | |
| webinar_mode | string | Если присутствует, конференция создается в режиме вебинара. | |
| phone_call_beeps | string | Если присутствует, в конференции включены гудки при вызовах на сотовые номера. | |
| link | string | URL комнаты. | |
| link_settings | array of dict | Параметры URL комнаты. | |
| is_impersonal_slug | boolean | Тип ссылки на комнату: с возможностью кастомизации и с привязкой к пользователю или обезличенная. | |
| slug | string | Окончание URL комнаты (например: https://dion.vc/ivanov-room-for-smth). | |
| pstn | object | Массив данных для подключения к комнате с использованием телефонии. | |
| number | string | Номер телефона для подключения к телефонии. | |
| pin | int | Добавочный номер для подключения к комнате при помощи телефонии. | |
| is_temporary | boolean | Отображение конференции в личном кабинете организатора. |
Схема параметров ответа:
{
"id": "string",
"owner_email": "string",
"moderators_emails": [
"string",
"string"
],
"is_on_cloud": boolean,
"is_temporary": boolean,
"event_params": [
"string",
"string"
],
"link": "string",
"link_settings": {
"slug": "string"
},
"pstn": {
"number": "string",
"pin": int,
}
}
Endpoint: DELETE api-integration.dion.vc/v1/events/:event_id
Для удаления конференции необходимо передать идентификатор комнаты в URL запроса.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
При успешной обработке запроса в ответе будет отправлен HTTP-код 204.
Endpoint: GET api-integration.dion.vc/v1/events/get-slug-by-owner-email
Метод позволяет получить список адресов (slug), созданных и не удаленных пользователем комнат по его почте.
Для получения списка комнат необходимо передать в запросе параметры:
Параметры запроса:
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| string | mandatory | Почта пользователя | |
| page | string | optional | Номер страницы |
| limit | string | optional | Количество записей на странице |
Запрос без пагинации:
GET api-integration.dion.vc/v1/events/get-slug-by-owner-email?email=user@test.ru
Запрос с пагинацией:
GET api-integration.dion.vc/v1/events/get-slug-by-owner-email?email=user@test.ru&limit=10&page=2
Параметры ответа:
| Название параметра | Вложенный параметр | Тип поля | Описание |
|---|---|---|---|
| events_slug | array | Массив адресов комнат | |
| pagination | array | Массив пагинации | |
| all_pages | string | Количество страниц с результатами обработки запроса | |
| all_records | string | Количество записей результата обработки запроса | |
| current_page | string | Текущая страница |
Схема параметров ответа:
{
"events_slug": [
"string",
"string"
],
"pagination": {
"current_page": int,
"all_pages": int,
"all_records": int
}
}
GET api-integration.dion.vc/v1/events/:event_id/users
Ограничение: максимальный временной интервал в запросе — 5 часов.
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор конференции |
| page | string | mandatory | Номер страницы |
| limit | string | mandatory | Количество записей на странице |
| time_start | string | mandatory | Начало временного интервала (datetime UTC в соответствии RFC 3339) |
| time_end | string | mandatory | Окончание временного интервала (datetime UTC в соответствии RFC 3339) |
Схема параметров ответа:
{
"pagination": {
"all_pages": 5,
"all_records": 500,
"current_page": 1
},
"users": [
{
"email": "string",
"name": "string",
"position": "string",
"sessions": [
{
"id": "string",
"session_end": "string",
"session_start": "string"
}
],
"user_id": "string"
}
]
}
GET api-integration.dion.vc/v1/events/params
Параметры запроса:
No parameters
Схема параметров ответа:
{
"description": "string",
"name": "string"
}
GET api-integration.dion.vc/v1/events/slug/:event_slug
Получить список пользователей по slug конференции можно в период времени не более 5 часов.
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_slug | string | mandatory | Slug события |
| page | string | optional | Номер страницы |
| limit | string | optional | Количество записей на странице |
| time_start | string | optional | Начало временного интервала (datetime UTC в соответствии RFC 3339) |
| time_end | string | optional | Окончание временного интервала (datetime UTC в соответствии RFC 3339) |
Схема параметров ответа:
{
"event": {
"event_slug": "string",
"users": [
{
"email": "string",
"join_to_meeting_time": [
"string"
]
}
]
},
"pagination": {
"all_pages": 5,
"all_records": 500,
"current_page": 1
}
}
Endpoint: POST api-integration.dion.vc/v1/invites
Метод позволяет создать индивидуальную ссылку на комнату с ограниченным временем действия для конкретного пользователя. По этой ссылке пользователь попадет в конференцию с заранее определенным на этапе создания ссылки именем в обход авторизации.
Параметры в данном методе должны передаваться в теле запроса в формате JSON.
Параметры запроса:
Body-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор конференции. |
| valid_before | string | mandatory | datetime, до которого действительно приглашение (если не указано, то 24 часа). |
| name | string | mandatory | Имя пользователя, которое будет отображаться при подключении в комнату Dion по созданной ссылке. |
| intermediate_id | string | optional | Идентификатор вызвавшего пользователя во внешней системе. |
Дата-время указывается в формате RFC3339 (например: 2024-10-03T12:53:05Z)
Схема параметров запроса:
{
"event_id": "string",
"intermediate_id": "string",
"name": "string",
"valid_before": "string"
}
Параметры ответа:
| Название параметра | Вложенные параметры | Тип поля | Описание |
|---|---|---|---|
| user | dictionary | Массив пользователя. | |
| id | string | Идентификатор пользователя. | |
| name | string | Имя пользователя, которое будет отображаться при подключении в комнату Dion. | |
| intermediate_id | string | Идентификатор пользователя в системе-потребителе. Если не передан в запросе, не вернется в ответе | |
| link | string | URL приглашения. | |
| invite_link_hash | string | hash link приглашения. | |
| valid_before | string | datetime, до которого валиден действительно приглашение. |
Схема параметров ответа:
{
"user":{
"id": "string",
"name":"string",
"intermediate_id": "string"
},
"link": "string",
"invite_link_hash":"string",
"valid_before": "string"
}
Endpoint: GET api-integration.dion.vc/v1/invites/:hash
Метод позволяет получить информацию о ранее созданном приглашении. Для получения данных необходимо передать hash link этого приглашения в URL запроса.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| hash | string | mandatory | hash link приглашения |
Параметры ответа:
| Название параметра |
Вложенные параметры 1 уровня |
Вложенные параметры 2 уровня |
Тип поля | Описание |
|---|---|---|---|---|
| invite_link | dictionary | Массив данных о приглашении. | ||
| user | dictionary | Массив пользователя. | ||
| id | string | Идентификатор пользователя. | ||
| name | string | Имя пользователя, которое будет отображаться при подключении в комнату Dion. | ||
| intermediate_id | string | Идентификатор пользователя в системе-потребителе. Если не передан в запросе, сгенерируется случайным образом. Может отсутствовать в ответе. | ||
| link | string | URL приглашения. | ||
| invite_link_hash | string | hash link приглашения. | ||
| valid_before | string | datetime, до которого действительно приглашение. | ||
| event | dictionary | Массив конференции. | ||
| id | string | Идентификатор комнаты в системе DION. | ||
| slug | string | Окончание URL комнаты (например: https://dion.vc/ivanov-room-for-smth). |
Схема параметров ответа:
{
"invite_link": {
"user": {
"id": "string",
"name": "string",
"intermediate_id": "string"
},
"link": "string",
"invite_link_hash": "string",
"valid_before": "string",
},
"event": {
"id": "string",
"slug": "string"
}
}
Endpoint: DELETE api-integration.dion.vc/v1/invites/:hash
Метод позволяет удалить ранее созданное приглашение. Для удаления необходимо передать hash этого приглашения в URL запроса.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| hash | string | mandatory | hash link приглашения |
При успешной обработке запроса в ответе будет отправлен HTTP-код 204.
Формат ответа, если приглашение не существует:
{
"code": 404,
"message": "получение инвайта: rpc error: code = NotFound desc = invite not found: unknown entity"
}
Endpoint: GET api-integration.dion.vc/v1/events/:event_id/phone-calls-report
Метод позволяет получить информацию о вызовах из конференции на номера телефонов.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | uuid | mandatory | Идентификатор конференции |
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| time_start | datetime | optional | Время начала рассматриваемого периода |
| time_end | datetime | optional | Время окончания рассматриваемого периода |
| page | string | optional | Номер страницы |
| limit | string | optional | Количество записей на странице |
Дата-время указывается в формате RFC3339.
Параметры ответа:
| Название параметра | Вложенный параметр | Тип поля | Описание |
|---|---|---|---|
| pagination | array of dict | Массив пагинации | |
| current_page | string | Текущая страница | |
| all_pages | string | Количество страниц с результатами обработки запроса | |
| all_records | string | Количество записей результата обработки запроса | |
| event_id | string | Идентификатор конференции | |
| owner_id | string | Идентификатор пользователя, под учетной записью которого создана комната | |
| calls | object | Информация по звонкам из конференции | |
| session_id | string | Идентификатор сессии звонка | |
| initiator_user_id | string | Идентификатор инициатора вызова | |
| phone | string | Номер телефона, на который осуществлен вызов | |
| session_status | string | Массив статусов звонка | |
| status | string | Статус вызова, который передает оператор | |
| time | string | Время получения статуса |
Схема параметров ответа:
{
"pagination": {
"current_page":int,
"all_pages": int,
"all_records": int
},
"event_id" :"string",
"owner_id": "string",
"calls": [
{
"session_id": "string",
"initiator_user_id": "string",
"phone": "string",
"session_status": [
{
"status": "string",
"time":"string"
}
]
}
]
}
При работе с методами из данного раздела учтите следующее:
| Параметры даты и времени передаются в формате RFC3339. На каждом параметре нужно выполнять urlencode. |
Endpoint: GET api-integration.dion.vc/v1/user
Для запроса данных учетной записи пользователя необходимо в query-параметры передать почтовый адрес, который использовался при регистрации.
Параметры запроса:
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| string | mandatory | Почтовый адрес пользователя |
Параметры ответа:
| Название параметра | Тип поля | Описание |
|---|---|---|
| avatar_http_path | string | Ссылка на изображение (аватар) |
| created_at | string | Дата создания учетной записи |
| deleted_at | string | Дата создания учетной записи |
| string | email пользователя | |
| id | string | Идентификатор учетной записи пользователя |
| initials | string | Инициалы пользователя |
| name | string | Полное имя пользователя |
| position | string | Должность |
| status | string | Статус учетной записи пользователя |
Схема параметров ответа:
{
"avatar_http_path": "string",
"created_at": "string",
"deleted_at": "string",
"email": "string",
"id": "string",
"initials": "string",
"name": "string",
"position": "string",
"status": "string"
}
Endpoint: GET api-integration.dion.vc/v1/user/:user_id
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| id | string | Да | Идентификатор пользователя |
Параметры ответа:
| Название параметра | Тип поля | Описание |
|---|---|---|
| id | string | Идентификатор пользователя |
| string | Почта пользователя | |
| avatar_http_path | string | Ссылка на изображение (аватар) |
| status | string | Статус пользователя |
| initials | string | Инициалы пользователя |
| name | string | Полное имя пользователя |
| position | string | Должность пользователя |
| created_at | string | Дата создания учетной записи пользователя |
| deleted_at | string | Дата удаления учетной записи пользователя |
{
"avatar_http_path": "string",
"created_at": "string",
"deleted_at": "string",
"email": "string",
"id": "string",
"initials": "string",
"name": "string",
"position": "string",
"status": "string"
}
Endpoint: GET api-integration.dion.vc/v1/users
Параметры запроса:
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| page | string | Нет | Номер страницы |
| limit | string | Нет | Количество записей на странице |
| created_at_from | string | Нет | Фильтр “Дата создания УЗ с” |
| created_at_to | string | Нет | Фильтр “Дата создания УЗ по” |
Параметры ответа:
| Название параметра | Тип поля | Описание | |
|---|---|---|---|
| pagination | dictionary | Массив пагинации | |
| current_page | string | Текущая страница | |
| all_pages | string | Количество страниц с результатами обработки запроса | |
| all_records | string | Количество записей результата обработки запроса | |
| users | array of dictionaries | Массив пользователей | |
| id | string | Идентификатор пользователя | |
| string | Почта пользователя | ||
| status | string |
Статус пользователя. Возможные значения:
|
|
| avatar_http_path | string | Ссылка на изображение (аватар) | |
| initials | string | Инициалы пользователя | |
| name | string | Полное имя пользователя | |
| position | string | Должность пользователя | |
| created_at | string | Дата создания учетной записи пользователя | |
| deleted_at | string | Дата удаления учетной записи пользователя | |
Важные условия и ограничения:
Максимальный лимит количества записей на странице в методах — 100.
Схема параметров ответа:
{
"pagination": {
"all_pages": 5,
"all_records": 500,
"current_page": 1
},
"users": [
{
"id": "844f90a5-ecd7-4259-80b2-86eabf1a62f8",
"email": "user-mail@test.ru",
"created_at": "2006-01-02T15:04:05Z",
"status": "active"
}
]
}
Endpoint: GET api-integration.dion.vc/v1/users/search
Параметры запроса:
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| string | Да | Электронная почта | |
| page | string | Нет | Номер страницы |
| limit | string | Нет | Количество записей на странице |
Параметры ответа:
| Название параметра | Тип поля | Описание | |
| pagination | dictionary | Массив пагинации | |
| current_page | string | Текущая страница | |
| all_pages | string | Количество страниц с результатами обработки запроса | |
| all_records | string | Количество записей результата обработки запроса | |
| users | array of dictionaries | Массив пользователей | |
| id | string | Идентификатор пользователя | |
| string | Почта пользователя | ||
| avatar_http_path | string | Ссылка на изображение (аватар) | |
| status | string | Статус пользователя | |
| initials | string | Инициалы пользователя | |
| name | string | Полное имя пользователя | |
| position | string | Должность пользователя | |
| created_at | string | Дата создания учетной записи пользователя | |
| deleted_at | string | Дата удаления учетной записи пользователя | |
Для получения данных используются таблицы api_clients.users.
Важные условия и ограничения:
Максимальный лимит количества записей на странице в методах — 100.
Метод получения списка пользователей должен позволять осуществлять поиск по всем полям в query-параметрах, причем поиск должен отрабатывать как по полному вхождению слова, так и по первым введенным символам (первым двум символам) и возвращать список всех возможных значений.
Параметры поиска:
Endpoint: DELETE api-integration.dion.vc/v1/users/user_id
Для удаления пользователя необходимо передать идентификатор его учетной записи в URL запроса.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| user_id | string | Да | Идентификатор учетной записи пользователя |
При успешной обработке запроса в ответе будет отправлен HTTP-код 204.
Ответ, в случае, если пользователь не найден:
{
"code": 404,
"message": "Объект не найден"
}
Endpoint: PUT /v1/users/{user_id}/block
Для блокировки пользователя необходимо передать id пользователя.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| user_id | string | mandatory | Идентификатор учетной записи пользователя |
При успешной обработке запроса в ответе будет отправлен HTTP-код 204.
Возможные ошибки в ответе:
Ответ, в случае, если пользователь не найден:
{
"code": 404,
"message": "Объект не найден"
}
Endpoint: PUT /v1/users/{user_id}/unblock
Для разблокировки пользователя необходимо передать id пользователя.
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| user_id | string | Да | Идентификатор учетной записи пользователя |
При успешной обработке запроса в ответе будет отправлен HTTP-код 204.
Возможные ошибки в ответе:
Ответ, в случае, если пользователь не найден:
{
"code": 404,
"message": "Объект не найден"
}
Endpoint: GET api-integration.dion.vc/v1/events/{event_id}/users
Получение списка пользователей в конференции за заданный промежуток времени (доступны интервалы до пяти часов).
Пример запроса с фильтрацией по дате:
GET api-integration.dion.vc/v1/events/eventid/users?page=1&limit=100&time_start=2022-01-01T03:00:00Z&time_end=2022-01-31T21:00:00Z
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | uuid | Да | Идентификатор конференции |
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| time_start | datetime | Да | Время начала рассматриваемого периода |
| time_end | datetime | Да | Время окончания рассматриваемого периода |
| page | string | Да | Номер страницы |
| limit | string | Да | Количество записей на странице |
Параметры ответа:
| Название параметра | Вложенные параметры | Тип поля | Описание |
|---|---|---|---|
| pagination | dictionary | Массив пагинации | |
| current_page | string | Текущая страница | |
| all_pages | string | Количество страниц с результатами обработки запроса | |
| all_records | string | Количество записей результата обработки запроса | |
| users | array of dictionaries | Массив пользователей | |
| user_id | string | Идентификатор пользователя | |
| name | string | Имя пользователя, указанное в Dion | |
| position | string | Должность, указанная в Dion | |
| sessions | array of strings | Массив пользовательских сессий | |
| id | string | Идентификатор пользовательской сессии | |
| session_start | string | Время создания сессии пользователя | |
| session_end | string | Время окончания сессии пользователя |
Схема параметров ответа:
{
"pagination":{
"current_page":1,
"all_pages":1,
"all_records":13
},
"users":[
{
"user_id":"string",
"name":"string",
"position":"string",
"email":"string",
"sessions":[
{
"id":"string",
"session_start":"datetime",
"session_end":"datetime"
}
]
}
]
}
Получение списка сессий в конференции за заданный промежуток времени.
Endpoint: GET api-integration.dion.vc/v1/events/event_id/sessions
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | uuid | mandatory | Идентификатор конференции |
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| time_start | datetime | optional | Время начала рассматриваемого периода |
| time_end | datetime | optional | Время окончания рассматриваемого периода |
| page | string | mandatory | Номер страницы |
| limit | string | mandatory | Количество записей на странице |
Параметры ответа:
| Название параметра | Вложенные параметры | Тип поля | Описание |
|---|---|---|---|
| pagination | dictionary | Массив пагинации | |
| current_page | string | Текущая страница | |
| all_pages | string | Количество страниц с результатами обработки запроса | |
| all_records | string | Количество записей результата обработки запроса | |
| sessions | object | Объект данных с информацией о сессии конференции | |
| id | string | Идентификатор сессии конференции | |
| session_start | string | Время создания сессии конференции | |
| session_end | string | Время окончания сессии конференции |
Схема параметров ответа:
{
"pagination":{
"current_page":1,
"all_pages":1,
"all_records":13
},
"sessions":[
{
"id":"”string”",
"session_start":"datatime",
"session_end":"datetime"
}
]
}
Метод позволяет отобразить в списке участников заранее выбранный номер телефона ("приглашенный номер"), на который можно позвонить из конференции без ввода номера вручную.
Список приглашенных номеров увидят только модераторы конференции.
Чтобы создать “приглашенный номер” в существующей конференции вашей организации, передайте в URL запроса идентификатор комнаты.
Endpoint: POST api-integration.dion.vc/v1/events/{event_id}/predefined-phone-numbers
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
Body-параметры:
| Название параметра | Вложенные параметры | Тип поля | Обязательность заполнения | Возможные значения | Описание |
|---|---|---|---|---|---|
| predefined_phone_numbers | array of strings | mandatory | Массив номеров | ||
| phone_number | string | mandatory | +79991234567 | Приглашенный номер телефона для конференции |
Максимальный лимит приглашенных номеров в одной конференции — 100.
Номера телефона необходимо передавать в формате: код страны «+7» и номер телефона из 10 цифр (слитно, без разделителей и спецсимволов).
Схема параметров запроса:
{
"predefined_phone_numbers":
[
{
"phone_number":"+74950000000"
}
]
}
Параметры ответа:
| Название параметра | Вложенные параметры | Тип поля | Описание |
|---|---|---|---|
| event_id | string | Идентификатор комнаты в системе DION | |
| predefined_phone_numbers | array of dictionaries | Массив номеров | |
| id | string | Идентификатор “приглашенного номера” в комнате | |
| phone_number | string | “Приглашенный номер” телефона для комнаты |
Схема параметров ответа:
{
"event_id": "string",
"predefined_phone_numbers": [
{
"id": "string",
"phone_number": "string"
}
]
}
Метод позволяет получить список “приглашенных номеров” телефона для конференции.
Чтобы получить список, передайте в URL запроса идентификатор комнаты.
Endpoint: GET api-integration.dion.vc/v1/events/event_id/predefined-phone-numbers
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
Параметры ответа:
| Название параметра | Вложенные параметры | Тип поля | Описание |
|---|---|---|---|
| event_id | string | Идентификатор комнаты в системе DION | |
| predefined_phone_numbers | array of dictionaries | Массив номеров | |
| id | string | Идентификатор “приглашенного номера” в комнате | |
| phone_number | string | “Приглашенный номер” телефона для комнаты |
Схема параметров ответа:
{
"event_id": "string",
"predefined_phone_numbers": [
{
"id": "string",
"phone_number": "string"
}
]
}
Метод позволяет удалить все “приглашенные номера” телефона из конференции.
Чтобы удалить список “приглашенных номеров” в существующей конференции вашей организации, передайте в URL запроса идентификатор комнаты.
Endpoint: DELETE api-integration.dion.vc/v1/events/event_id/predefined-phone-numbers
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
При успешной обработке запроса в ответе будет отправлен HTTP-код 204.
Ответ, в случае, если номеров не существует:
{
"code": 404,
"message": "удаление номеров телефонов: rpc error: code = NotFound desc = predefined phones not found: unknown entity"
}
Endpoint: GET api-integration.dion.vc/v1/users-groups
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Query-параметры
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_codes | Типы групп для поиска. | []string | НЕТ | conference_separate_phone_number |
| limit |
Максимальное количество возвращаемых записей. Если значение не передано, то возвращается 50 записей. |
int | НЕТ | 10 |
| page |
Страница списка, которую необходимо получить. Если значение не передано, то возвращается одна страница. |
int | НЕТ | 1 |
| search | Строка поиска. Допускается 1-3 слова, разделенные пробелами. Поиск ведется по полям name и description. |
string | НЕТ | Тест |
Выходные параметры:
| Параметр | Описание | Тип | Обязательность | Маскирование | Пример | |
| items | ||||||
| id | Идентификатор группы пользователей | uuid | ДА | НЕТ | ||
| description | Описание группы пользователей | string | НЕТ | НЕТ | Тестовое описание | |
| group_code | Тип группы пользователей | string | ДА | НЕТ | conference_separate_phone_number | |
| name | Название группы пользователей | string | ДА | НЕТ | Тестовое название | |
| org_id | Демонстрация. RTT. Исходящий | uuid | ДА | НЕТ | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 | |
| org_name | Название организации | string | ДА | НЕТ | Название организации | |
| users_count | Количество пользователей в группе | ДА | НЕТ | 100 | ||
| pagination | ||||||
| all_pages | Количество страниц | int | ДА | НЕТ | 20 | |
| all_records | Количество записей | int | ДА | НЕТ | 100 | |
| current_page | Текущая страница | int | ДА | НЕТ | 2 | |
Схема ответа:
{
"items": [
{
"description": "string",
"group_code": "string",
"id": "string",
"name": "string",
"org_id": "string",
"org_name": "string",
"users_count": 0
}
],
"pagination": {
"all_pages": 5,
"all_records": 500,
"current_page": 1
}
}
Endpoint: GET api-integration.dion.vc/v1/users-groups/types
Список возвращаемых кодов с кратким описанием:
Выходные параметры:
| Параметр | Описание | Тип | Обязательность | Маскирование | Пример | |
| items | ||||||
| id | Идентификатор типа группы пользователей. | string | Да | НЕТ | video_allow_view_records | |
| name | Название типа группы пользователей. | string | Да | НЕТ | Права на просмотр видео | |
| description | Описание типа группы пользователей. | string | Да | НЕТ | Настройка дает возможность просматривать видео определенной группы владельцев. | |
| hint | Подсказка для типа группы пользователей. | uuid | Нет | НЕТ | ||
| warning_text | Предупреждение для типа группы пользователей. | string | Нет | НЕТ | Вам необходимо будет назначить хотя бы одного администратора из числа участников группы в таблице “Участники”. Максимальное количество администраторов не ограничено. | |
| member_role_codes | Роли пользователей в группе для типа группы пользователей. | []string | Нет | НЕТ | ["group_admin","group_user"] | |
Схема ответа:
{
"items": [
{
"id": "string",
"name": "string",
"description": "string",
"name": "string",
"org_id": "string",
"member_role_codes": "string",
"users_count": 0
}
]
}
Endpoint: POST api-integration.dion.vc/v1/users-groups/organizations/org_id
Параметры запроса:
Path-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| org_id | string | ДА | Идентификатор организации |
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Body-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_code | Тип группы пользователей | string | ДА | conference_separate_phone_number |
| name | Название группы пользователей | string | ДА | Тестовое название |
| description | Описание группы пользователей | string | НЕТ | Тестовое описание |
Схема запроса:
/v1/users-groups/organizations/:org_id
body:
{
"description": "string",
"group_code": "video_disable_delete_records",
"name": "string"
}
Выходные параметры:
| Параметр | Описание | Тип | Обязательность | Маскирование | Пример |
|---|---|---|---|---|---|
| id | Идентификатор группы пользователей | uuid | ДА | НЕТ | |
| description | Описание группы пользователей | string | НЕТ | НЕТ | Тестовое описание |
| group_code | Тип группы пользователей | string | ДА | НЕТ | conference_separate_phone_number |
| name | Название группы пользователей | string | ДА | НЕТ | Тестовое название |
| org_id | Идентификатор организации | uuid | ДА | НЕТ | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
| org_name | Название организации | string | ДА | НЕТ | Название организации |
| users_count | Количество пользователей в группе | int | ДА | НЕТ | 0 |
Схема ответа:
{
"id": "string",
"description": "string",
"group_code": "string",
"name": "string",
"org_id": "string",
"org_name": "string",
"users_count": 0
}
Endpoint: GET api-integration.dion.vc/v1/users-groups/{group_id}
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Path-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_id | Идентификатор группы, по которой необходимо получить данные. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
Пример запроса:
api-integration-dion.vc/v1/users-groups/d322da20-dfd1-4fa9-9beb-6d302a27c5f7
Выходные параметры:
| Параметр | Описание | Тип | Обязательность | Маскирование | Пример |
|---|---|---|---|---|---|
| id | Идентификатор группы пользователей | uuid | ДА | НЕТ | |
| description | Описание группы пользователей | string | НЕТ | НЕТ | Тестовое описание |
| group_code | Тип группы пользователей | string | ДА | НЕТ | conference_separate_phone_number |
| name | Название группы пользователей | string | ДА | НЕТ | Тестовое название |
| org_id | Демонстрация. RTT. Исходящий | uuid | ДА | НЕТ | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
| org_name | Название организации | string | ДА | НЕТ | Название организации |
| users_count | Количество пользователей в группе | ДА | НЕТ | 100 |
Схема ответа:
{
"id": "string",
"description": "string",
"group_code": "string",
"name": "string",
"org_id": "string",
"org_name": "string",
"users_count": 0
}
Endpoint: DELETE api-integration.dion.vc/v1/users-groups/{group_id}
Список возвращаемых кодов с кратким описанием
Входные параметры:
Path-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_id | Идентификатор организации, по которой необходимо получить список групп. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
Пример запроса:
api-integration.dion.vc/v1/users-groups/d322da20-dfd1-4fa9-9beb-6d302a27c5f7
Endpoint: DELETE api-integration.dion.vc/v1/users-groups/{group_id}/members/{user_id}
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Path-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_id | Идентификатор группы, внутри которой необходимо удалить участника. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
| user_id | Идентификатор пользователя, которого необходимо удалить из группы. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f8 |
Пример запроса:
api-integration.dion.vc/v1/users-groups/d322da20-dfd1-4fa9-9beb-6d302a27c5f7/members/d322da20-dfd1-4fa9-9beb-6d302a27c5f8
Endpoint: GET api-integration.dion.vc/v1/users-groups/{group_id}/members
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Path-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_id | Идентификатор группы, по которой запрашивается список участников. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
Query параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| member_role_code | Идентификатор роли пользователей, по которой запрашивается список участников. | string | НЕТ | group_user |
| limit |
Максимальное количество возвращаемых записей. Если значение не передано, то возвращается 50 записей. |
int | НЕТ | 10 |
| page |
Страница списка, которую необходимо получить. Если значение не передано, то возвращается одна страница. |
int | НЕТ | 1 |
Пример запроса:
api-integration.dion.vc/v1/users-groups/d322da20-dfd1-4fa9-9beb-6d302a27c5f7/members?member_role_code=group_user
Выходные параметры:
| Параметр | Описание | Тип | Обязательность | Маскирование | Пример | |
| items | ||||||
| group_id | Идентификатор группы пользователей. | uuid | ДА | НЕТ | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 | |
| user_id | Идентификатор пользователя | uuid | ДА | НЕТ | d322da20-dfd1-4fa9-9beb-6d302a27c5f8 | |
| member_role_code | Идентификатор роли пользователя. | string | ДА | НЕТ | user_group | |
| name | Имя пользователя. | string | ДА | НЕТ | Иванов Иван | |
| Почтовый адрес пользователя. | string | ДА | НЕТ | test@test.ru | ||
| actions |
Возможные действия, которые можно выполнить с пользователями:
|
string | ДА | НЕТ | delete, set_admin |
|
| Pagination | ||||||
| all_pages | Количество страниц. | int | ДА | НЕТ | 20 | |
| all_records | Количество записей. | int | ДА | НЕТ | 100 | |
| current_page | Текущая страница. | int | ДА | НЕТ | 2 | |
Схема ответа:
{
"items": [
{
"actions": [
"string"
],
"email": "string",
"group_id": "string",
"member_role_code": "string",
"name": "string",
"user_id": "string"
}
],
"pagination": {
"all_pages": 5,
"all_records": 500,
"current_page": 1
}
}
Endpoint: GET api-integration.dion.vc/v1/users-groups/members/roles
Выходные параметры:
| Параметр | Описание | Тип | Обязательность | Маскирование | Пример | |
| items | ||||||
| id | Идентификатор роли пользователя | string | Да | НЕТ | group_admin | |
| name | Название роли пользователя | string | Да | НЕТ | Администратор группы | |
Схема ответа:
{
"items": [
{
"id": "string",
"name": "string"
}
]
}
Endpoint: POST api-integration.dion.vc/v1/users-groups/{group_id}/members
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Path-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_id | Идентификатор организации, в рамках которой необходимо создать группу пользователей. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
Body-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| member_role_code | Роль пользователя | string | ДА | group_user |
| user_ids | Идентификаторы добавляемых пользователей | []string | ДА | [ "d322da20-dfd1-4fa9-9beb-6d302a27c5f8", "d322da20-dfd1-4fa9-9beb-6d302a27c5f9" ] |
Схема запроса:
/v1/user-groups/d322da20-dfd1-4fa9-9beb-6d302a27c5f7/members
body:
{
"member_role_code": "group_user",
"user_ids": [
"d322da20-dfd1-4fa9-9beb-6d302a27c5f8",
"d322da20-dfd1-4fa9-9beb-6d302a27c5f9"
]
}
Выходные параметры: отсутствуют
Endpoint: PUT api-integration.dion.vc/v1/users-groups/{group_id}
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Path-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_id | Идентификатор группы, по которой необходимо получить список групп. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
Body-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_code | Тип группы пользователей | string | ДА | conference_separate_phone_number |
| name | Название группы пользователей | string | ДА | Тестовое название |
| description | Описание группы пользователей | string | НЕТ | Тестовое описание |
Схема запроса:
api-integration.dion.vc/v1/users-groups/d322da20-dfd1-4fa9-9beb-6d302a27c5f7
body:
{
"description": "string",
"group_code": "video_disable_delete_records",
"name": "string"
}
Выходные параметры: отсутствуют
Endpoint: PUT api-integration.dion.vc/v1/users-groups/{group_id}/members/{user_id}
Список возвращаемых кодов с кратким описанием:
Входные параметры:
Path-параметры:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| group_id | Идентификатор организации, в рамках которой необходимо создать группу пользователей. | uuid | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f7 |
| user_id | Название группы пользователей. | string | ДА | d322da20-dfd1-4fa9-9beb-6d302a27c5f8 |
Body-параметр:
| Параметр | Описание | Тип | Обязательность | Пример |
|---|---|---|---|---|
| member_role_code | Описание группы пользователей. | string | ДА | group_user |
Схема запроса:
api-integration.dion.vc/v1/users-groups/d322da20-dfd1-4fa9-9beb-6d302a27c5f7/members/d322da20-dfd1-4fa9-9beb-6d302a27c5f8
body:
{
"member_role_code": "group_user"
}
Выходные параметры: отсутствуют
Endpoint: GET api-integration.dion.vc/v1/videos
Метод возвращает все ссылки на записи видео и аудио по event_id.
Параметры запроса:
Query-параметры:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | да | Идентификатор комнаты |
| page | string | да | Номер страницы |
| limit | string | да | Количество ссылок на странице |
| time_start | string | нет | Время начала выборки |
| time_end | string | нет | Время окончания выборки |
Дата-время указывается в формате RFC3339 (пример: 2024-10-03T12:53:05Z).
Параметры ответа:
| Название параметра | Вложенный параметр | Тип поля | Описание |
|---|---|---|---|
| pagination | array | ||
| current_page | string | Текущая страница | |
| all_pages | Количество страниц с результатами обработки запроса | ||
| all_records | Количество записей результата обработки запроса | ||
| video_links | array of strings | Ссылки на записи в DION Видео |
Схема ответа:
{
"pagination": {
"all_pages": 5,
"all_records": 500,
"current_page": 1
},
"video_links": [
"string"
]
}
Endpoint: GET api-integration.dion.vc/v1/events/{event_id}/records
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | да | Идентификатор комнаты |
| page | string | да | Номер страницы |
| limit | string | да | Количество ссылок на странице |
| time_start | string | нет | Время начала выборки |
| time_end | string | нет | Время окончания выборки |
Схема ответа:
| Название параметра | Тип поля | Описание |
|---|---|---|
| pagination | Всего страниц, всего записей, текущая страница | |
| event_id | string | Идентификатор конференции |
| id | string | Идентификатор записи |
| media_record_id | string | Идентификатор записи медиа |
| name | string | Имя записи |
| upload_at | string | Дата и время загрузки |
{
"pagination": {
"all_pages": 5,
"all_records": 500,
"current_page": 1
},
"records": [
{
"event_id": "string",
"id": "string",
"media_record_id": "string",
"name": "string",
"upload_at": "string"
}
]
}
Список возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | OK | Успешный запрос |
| 400 | Bad Request | Неверный запрос |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Forbidden | Доступ запрещен |
| 404 | Not Found | Данные не найдены |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
| Это одноразовая ссылка. |
Endpoint: GET api-integration.dion.vc/v1/video/records/{media_record_id}/video
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| record_id | string | да | id записи |
Схема ответа:
| Название параметра | Тип поля | Описание |
|---|---|---|
| download_video_link | string | ссылка на скачивание записи |
{
"download_video_link": "string"
}Список возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | OK | Успешный запрос |
| 400 | Bad Request | Неверный запрос |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Forbidden | Доступ запрещен |
| 404 | Not Found | Данные не найдены |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
Endpoint: GET api-integration.dion.vc/v1/video/records/{record_id}/speech_to_text
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| record_id | string | да | id записи |
Cписок возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | файл.txt | Успешный запрос вернет файл расшифровки записи |
| 400 | Bad Request | Неверный запрос |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Forbidden |
Доступ запрещен Проверьте, что пользователь интеграционного API и |
| 404 | Not Found | Данные не найдены |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
Endpoint: GET api-integration.dion.vc/v1/video/records/{recordid}/speechtotext_json
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| record_id | string | да | id записи |
Cписок возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | файл.json | Успешный запрос вернет файл расшифровки записи |
| 400 | Bad Request | Неверный запрос |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Forbidden |
Доступ запрещен Проверьте, что пользователь интеграционного API и |
| 404 | Not Found | Данные не найдены |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
Endpoint: GET api-integration.dion.vc/v1/video/records/{record_id}/summarization
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| record_id | string | да | id записи |
Cписок возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | файл.txt | Успешный запрос вернет файл расшифровки записи |
| 400 | Bad Request | Неверный запрос |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Forbidden |
Доступ запрещен Проверьте, что пользователь интеграционного API и |
| 404 | Not Found | Данные не найдены |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
API предоставляет интерфейс для получения данных о событиях аудита организации, что дает возможность интеграции с внешними системами (SIEM) для мониторинга и обработки данных о событиях аудита. Основные функции API в части аудита включают:
Endpoint: GET api-integration.dion.vc/v1/audits
Метод позволяет получить список событий аудита организации.
Ответ на запрос содержит список событий аудита организации в случае успеха или описание ошибки в случае неудачи.
Если параметр last_audit_id не найден, вернется ошибка 400.
Входные параметры (Query):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
| limit | Количество строк для возврата. Максимальное значение. Ограничение < 1000 событий. | Int | Нет |
| last_audit_id | Идентификатор события аудита после которого необходимо вернуть все имеющиеся события аудита. | String | Нет |
| message_type[] | Коды получаемых типов событий аудита. | String | Нет |
Выходные параметры:
| Параметр | Описание | Тип |
|---|---|---|
| items | Массив событий аудита | |
| id | Идентификатор события аудита | String |
| record_id | Идентификатор события аудита в формате int64 | int64 |
| user_id | Идентификатор пользователя | String |
| user_name | ФИО пользователя | String |
| user_email | Почтовый адрес пользователя | String |
| user_roles | Роль пользователя | String |
| event_id | Идентификатор события | String |
| event_slug | Slug события | String |
| message_type | Тип события аудита | String |
| created_at | Дата создания | String |
| platform | Название платформы пользователя | String |
| level | Уровень события | String |
| ip | IP адрес пользователя | String |
| user-agent | User agent пользователя | String |
| payload | Дополнительная информация | String |
Схема ответа:
{
"items": [
{
"created_at": "string",
"event_id": "string",
"event_slug": "string",
"id": "string",
"ip": "string",
"level": "string",
"message_type": "string",
"payload": "string",
"platform": "string",
"record_id": 0,
"user_agent": "string",
"user_email": "string",
"user_id": "string",
"user_name": "string",
"user_roles": [
"string"
]
}
]
}
Список возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | OK | Успешный запрос |
| 400 | Bad Request | Неверный запрос |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
Endpoint: GET api-integration.dion.vc/v1/audits/types
Метод позволяет получить список типов событий аудита.
Входные параметры: отсутствуют
Выходные параметры:
| Параметр | Описание | Тип | |
|---|---|---|---|
| items | Массив типов событий аудита | ||
| name | Название | String | |
| translation | Описание | String | |
| level | Уровень | String | |
Схема ответа:
{
"items": [
{
"level": "string",
"name": "string",
"translation": "string"
}
]
}
Пример ответа:
{
"additional_fields": {
"additionalProp1": {}
},
"code": 0,
"message": "string",
"validation_errors": [
{
"message": "string",
"path": "string"
}
]
}
Список возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | OK | Успешный запрос |
| 401 | Unauthorized | Интеграционный токен не валиден |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
Endpoint: GET api-integration.dion.vc/v1/audits/platforms
Метод позволяет получить список платформ, десктоп-приложение, веб-клиент и т.д.
Входные параметры: отсутствуют
Выходные параметры:
| Параметр | Описание | Тип | |
|---|---|---|---|
| items | Массив возможных значений платформ | ||
| name | Название | String | |
| translation | Описание | String | |
Схема ответа:
{
"items": [
{
"name": "string",
"translation": "string"
}
]
}
Пример ответа:
{
"items": [
{
"name": "ios",
"translation": "iOS приложение"
},
{
"name": "desktop",
"translation": "Десктопное приложение"
}
]
}
Список возвращаемых кодов:
| HTTP status code | errorMesage | Описание |
|---|---|---|
| 200 | OK | Успешный запрос |
| 400 | Bad Request | Неверный запрос |
| 500 | Internal Server Error | Произошла непредвиденная техническая ошибка |
Endpoint: GET api-integration.dion.vc/v1/events/params
Метод возвращает все доступные параметры для настройки комнаты при создании/редактировании.
В ответе возвращается массив словарей с параметрами.
Параметры ответа:
| Название параметра | Тип поля | Описание |
|---|---|---|
| description | string | Описание параметра |
| name | string | Название параметра. Для изменения параметра именно имя необходимо указывать в массиве event_params. |
Схема ответа:
[
{
"description": "string",
"name": "string"
}
]