IAPI DION активно развивается, добавляются новые методы и функции.
Если вы не нашли нужный вам метод, сообщите об этом, мы постараемся помочь.
Взаимодействие с IAPI происходит по HTTPS-протоколу с использованием mTLS.
Аутентификация запросов в DION происходит по токену доступа. Выпустить токен доступа необходимо в административной панели DION. Токен имеет ограниченный срок действия, указанный при создании. В запросах к DION токен необходимо передать в заголовке X-Client-Access-Token. Количество токенов для организации не ограничено. Инструкция по созданию токена доступна здесь.
Максимальная рекомендуемая нагрузка указана в таблице:
| Метрика | Значение |
|---|---|
| Общее количество запросов | 100/ 60s |
| Количество единовременных запросов | 10/1s |
При работе с методами из данного раздела учтите следующие правила:
❗ Все e-mail адреса, которые вы передаете в запросе, должны быть зарегистрированы в DION (созданы учетные записи). Пользователи этих учетных записей должны хотя бы раз войти в DION.
❗ Владелец комнаты (owner_email) автоматически является и модератором. Не нужно передавать его e-mail в параметре “moderators_emails”.
Endpoint: POST api-integration.dion.vc/v1/events
Метод позволяет:
- Задать владельца конференции (в рамках его учетной записи будет создана комната)
- Выбрать, на каких серверах будет проходить медиа-трафик:
- Назначить модераторов
- Выбрать тип ссылки:
- Настроить параметры конференции:
- Настроить отображение конференции в личном кабинете
💡 Иногда релизы DION могут выходить чаще, чем обновления данного документа.
Все настройки, доступные для конференций, можно получить при помощи метода:
GET api-integration.dion.vc/v1/events/params
Параметры запроса:
| Название параметра | Вложенный параметр | Тип | Обязательность заполнения | Описание |
|---|---|---|---|---|
| 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 |
Признак “Где будет проходить медиа-трафик конференции” для гибридного DION
Для полной On-Premise инсталляции
|
|
| link_settings | array of dict | mandatory | Параметры URL комнаты | |
| is_impersonal_slug | boolean | mandatory | Тип ссылки на комнату: с возможностью кастомизации и с привязкой к пользователю (например, https://dion.vc/ivanov-room-for-smth) или обезличенная (случайно созданная из 9 символов, например, https://dion.vc/aaa-bbb-ddd) | |
| slug | string | mandatory |
Окончание URL комнаты (пример: https://dion.vc/ivanov-room-for-smth). Для обезличенной комнаты значение не применяется, можно указать любое, так как поле все равно является обязательным |
|
| moderators_emails | array of strings | optional | Дополнительные модераторы конференции. Передаются e-mail-адреса УЗ пользователей в DION. Разделитель — запятая | |
| owner_email | string | mandatory | E-mail организатора: пользователя, под учетной записью которого необходимо создать комнату | |
| 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 | E-mail адрес пользователя, под учетной записью которого создана комната | |
| moderators_emails | string | Дополнительные модераторы конференции. Передаются e-mail-адреса пользователей в DION. | |
| is_on_cloud | boolean |
Признак “Где будет проходить медиа-трафик конференции” ◦ true — конференция будет проходить на облачных серверах DION ◦ false — конференция будет проходить на серверах организации Для полной On-Premise инсталляции
|
|
| 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 |
Признак “Где будет проходить медиа-трафик конференции” для гибридного DION
Для полной On-Premise инсталляции
|
|
| 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 | Добавочный номер для подключения к комнате при помощи телефонии | |
| 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,
},
"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 | E-mail адрес пользователя, под учетной записью которого создана комната | |
| moderator_emails | string | Дополнительные модераторы конференции. Передаются e-mail-адреса пользователей в DION. | |
| is_on_cloud | boolean |
Признак “Где будет проходить медиа-трафик конференции” ◦ true — конференция будет проходить на облачных серверах DION ◦ false — конференция будет проходить на серверах организации Для полной On-Premise инсталляции
|
|
| 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: POST api-integration.dion.vc/v1/events/sessions
Для получения списка сесий комнаты.
Входные параметры - 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 запроса необходимо передать идентификатор комнаты. В теле — новые значения параметров.
Параметры запроса:
| Название параметра | Вложенный параметр | Тип | Обязательность заполнения | Описание |
|---|---|---|---|---|
| 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 |
Признак “Где будет проходить медиа-трафик конференции” для гибридного DION
Для полной On-Premise инсталляции
|
|
| link_settings | array of dict | optional | Параметры URL комнаты | |
| is_impersonal_slug | boolean | optional | Тип ссылки на комнату: с возможностью кастомизации и с привязкой к пользователю (например, https://dion.vc/ivanov-room-for-smth) или обезличенная (случайно созданная из 9 символов, например, https://dion.vc/aaa-bbb-ddd) | |
| slug | string | optional |
Окончание URL комнаты (пример: https://dion.vc/ivanov-room-for-smth). Для обезличенной комнаты значение не применяется, можно указать любое, так как поле все равно является обязательным |
|
| moderator_emails | array of strings | optional | Дополнительные модераторы конференции. Передаются e-mail-адреса УЗ пользователей в DION. Разделитель — запятая | |
| owner_email | string | mandatory | E-mail организатора: пользователя, под учетной записью которого необходимо создать комнату | |
| 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 | E-mail адрес пользователя, под учетной записью которого создана комната | |
| moderator_emails | string | Дополнительные модераторы конференции. Передаются e-mail-адреса пользователей в DION. | |
| is_on_cloud | boolean |
Признак “Где будет проходить медиа-трафик конференции” ◦ true — конференция будет проходить на облачных серверах DION ◦ false — конференция будет проходить на серверах организации Для полной On-Premise инсталляции
|
|
| 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-code 204.
Endpoint: GET api-integration.dion.vc/v1/events/get-slug-by-owner-email
Метод позволяет получить список адресов (slug) созданных и не удаленных пользователем комнат по его почте.
Для получения списка комнат необходимо передать в запросе параметры:
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| 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
}
}
Endpoint: POST api-integration.dion.vc/v1/invites
Метод позволяет создать индивидуальную ссылку на комнату с ограниченным временем действия для конкретного пользователя. По этой ссылке пользователь попадет в конференцию с заранее определенным на этапе создания ссылки именем в обход авторизации.
Параметры в данном методе должны передаваться в теле запроса в формате json.
Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор конференции |
| valid_before | string | optional | datetime, до которого валиден инвайт (если не указано, то 24 часа) |
| name | string | mandatory | Имя пользователя, которое будет отображаться при подключении в комнату Dion по созданной ссылке |
| intermadiate_id | string | optional | Идентификатор пользователя в системе-потребителе. Если не передан в запросе, генерируется случайным образом |
Дата-время указывается в формате RFC3339 (пример: 2024-10-03T12:53:05Z)
Схема параметров запроса:
{
"event_id": "string",
"valid_before": "string",
"name":"string",
"intermadiate_id":"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-code 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 параметры передать email, который использовался при регистрации.
Query параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| string | mandatory | email пользователя |
Параметры ответа:
| Название параметра | Тип поля | Описание |
|---|---|---|
| id | string | Идентификатор учетной записи пользователя |
| string | email пользователя | |
| created_at | string | Дата создания учетной записи |
Схема параметров ответа:
{
"id": "844f90a5-ecd7-4259-80b2-86eabf1a62f8",
"email": "user-mail@test.ru",
"created_at": "2006-01-02T15:04:05Z"
}
REST API
| № | Endpoint | Request | Response |
|---|---|---|---|
| integration-api | |||
| 1 | GET api-integration.dion.vc/v1/user/user_id - Получить данные пользоваетеля по id |
path:
|
Нажмите здесь для раскрытия... |
Параметры запроса
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| user_id | string | mandatory | Идентификатор пользователя |
Параметры ответа
| Название параметра | Тип поля | Описание |
|---|---|---|
| Название параметра | Тип поля | Описание |
| id | string | Идентификатор пользователя |
| string | Почта пользователя | |
| avatar_http_path | string | Ссылка на автар |
| status | string | Статус пользователя |
| initials | string | Инициалы пользователя |
| name | string | Полное имя пользователя |
| position | string | Должность пользователя |
| created_at | string | Дата создания учетной записи пользователя |
| deleted_at | string | Дата удаления учетной записи пользователя |
REST API
| № | Endpoint | Request | Response |
|---|---|---|---|
| integration-api | |||
| 1 |
GET api-integration.dion.vc/v1/users - Получить список пользователей Новый выходной параметр status Возможные значения:
|
query:
|
Нажмите здесь для раскрытия... |
Параметры запроса
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| page | string | optional | Номер страницы |
| limit | string | optional | Количество записей на странице |
| created_at_from | string | optional | Фильтр “Дата создания УЗ с” |
| created_at_to | string | optional | Фильтр “Дата создания УЗ по” |
Параметры ответа
| Название параметра | Тип поля | Описание | |
|---|---|---|---|
| Название параметра | Тип поля | Описание | |
| 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"
}
]
}
REST API
| № | Endpoint | Request | Response |
|---|---|---|---|
| integration-api | |||
| 1 | GET api-integration.dion.vc/v1/users/search - Получить список пользователей по поисковой строке |
query:
|
Нажмите здесь для раскрытия... |
Параметры запроса
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| string | mandatory | Электронная почта | |
| page | string | optional | Номер страницы |
| limit | string | optional | Количество записей на странице |
Параметры ответа
| Название параметра | Тип поля | Описание | |
|---|---|---|---|
| Название параметра | Тип поля | Описание | |
| 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-параметрах, причем поиск должен отрабатывать как по полному вхождению слова, так и по первым введенным символам (первым 2 символам) и возвращать список всех возможных значений.
Параметры поиска:
Удалить пользователя
Endpoint: DELETE api-integration.dion.vc/v1/users/user_id
Для удаления пользователя необходимо передать идентификатор его учетной записи в URL запроса.
Path параметры запроса
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| user_id | string | mandatory | Идентификатор учетной записи пользователя |
При успешной обработке запроса в ответе будет отправлен http-code 204.
Если пользователь не найден:
{
"code": 404,
"message": "Объект не найден"
}
Endpoint: PUT /v1/users/{user_id}/block
Для блокировки пользователя необходимо передать id пользователя.
Path параметры запроса
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| user_id | string | mandatory | Идентификатор учетной записи пользователя |
При успешной обработке запроса в ответе будет отправлен http-code 204.
Ошибки:
|
|
Endpoint: PUT /v1/users/{user_id}/unblock
Для разблокировки пользователя необходимо передать id пользователя.
Path параметры запроса
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| user_id | string | mandatory | Идентификатор учетной записи пользователя |
При успешной обработке запроса в ответе будет отправлен http-code 204.
Ошибки:
|
|
Endpoint: GET api-integration.dion.vc/v1/events/event_id/users
Получение списка пользователей в конференции за заданный промежуток времени (Доступны интервалы до 5 часов)
Запрос с фильтрацией по дате:
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 | mandatory | Идентификатор конференции |
Query Параметры запроса
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| time_start | datetime | mandatory | Время начала рассматриваемого периода |
| time_end | datetime | mandatory | Время окончания рассматриваемого периода |
| page | string | mandatory | Номер страницы |
| limit | string | mandatory | Количество записей на странице |
Параметры ответа:
| Название параметра | Вложенные параметры | Тип поля | Описание |
|---|---|---|---|
| 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"
}
]
}
Endpoint: POST api-integration.dion.vc/v1/events/event_id/predefined-phone-numbers
Метод позволяет отобразить в списке участников заранее выбранный номер телефона ("приглашенный номер"), на который можно позвонить из конференции без ввода номера вручную.
Список приглашенных номеров увидят только модераторы конференции.
Для создания приглашенного номера в существующей конференции вашей организации, необходимо передать в URL запроса идентификатор комнаты.
Path параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
Параметры запроса в таблице ниже необходимо передать в теле запроса:
| Название параметра | Вложенные параметры | Тип поля | Обязательность заполнения | Возможные значения | Описание |
|---|---|---|---|---|---|
| predefined_phone_numbers | array of strings | mandatory | Массив номеров | ||
| phone_number | string | mandatory | +79991234567 | Приглашенный номер телефона для конференции |
Максимальный лимит приглашенных номеров в 1 конференции = 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"
}
]
}
Endpoint: GET api-integration.dion.vc/v1/events/event_id/predefined-phone-numbers
Метод позволяет получить список приглашенных номеров телефона для конференции. .
Для получения списка, необходимо передать в URL запроса идентификатор комнаты.
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"
}
]
}
Endpoint: DELETE api-integration.dion.vc/v1/events/event_id/predefined-phone-numbers
Метод позволяет удалить все приглашенные номера телефона из конференции.
Для удаления списка приглашенных номеров в существующей конференции вашей организации, необходимо передать в URL запроса идентификатор комнаты.
Path параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
При успешной обработке запроса в ответе будет отправлен http-code 204.
Если номеров не существует:
{
"code": 404,
"message": "удаление номеров телефонов: rpc error: code = NotFound desc = predefined phones not found: unknown entity"
}
Endpoint: GET api-integration.dion.vc/v1/events/params
Метод возвращает все доступные параметры для настройки комнаты при создании/редактировании.
В ответе возвращается массив словарей с настройками.
Параметры ответа:
| Название параметра | Тип поля | Описание |
|---|---|---|
| description | string | Описание настройки |
| name | string | Название настройки. Для изменения настройки именно имя необходимо указывать в массиве event_params |
Схема параметров ответа:
[
{
"description": "string",
"name": "string"
}
]
Endpoint: GET api-integration.dion.vc/v1/videos
Метод возвращает все ссылки на записи видео и аудио по event_id
Query Параметры запроса:
| Название параметра | Тип поля | Обязательность заполнения | Описание |
|---|---|---|---|
| event_id | string | mandatory | Идентификатор комнаты |
| page | string | optional | Номер страницы |
| limit | string | optional | Количество записей на странице |
| time_start | datetime | optional | Начало временного интервала |
| time_end | datetime | optional | Окончание вренеменного интервала |
Дата-время указывается в формате RFC3339 (пример: 2024-10-03T12:53:05Z)
Параметры ответа:
| Название параметра | Вложенный параметр | Тип поля | Описание |
|---|---|---|---|
| pagination | array | ||
| current_page | string | Текущая страница | |
| all_pages | Количество страниц с результатами обработки запроса | ||
| all_records | Количество записей результата обработки запроса | ||
| video_links | array of strings | Ссылки на записи в Дион.Видео |
Схема параметров ответа:
{
"pagination": {
"current_page": 1,
"all_pages": 1,
"all_records": 2
},
"video_links": [
"https://https://video.dion.vc/video/bda3573р-0081-4cbc-111a-753fe3a36af0",
"https://https://video.dion.vc/video/0f921310-68p5-44dc-8870-4f2ef03ea2eb"
]
}