Максимальное количество обновлений:
-
минимальное значение:
1; -
максимальное значение:
100; -
значение по умолчанию:
100
Для создания технической учётной записи (ТУЗ) используйте инструкцию.
После создания ТУЗ и пароля Администратор может передать учетные данные (email и пароль) разработчику бота.
Каждый бот, перед тем как обращаться к API Dion.Чаты, должен получить токен доступа.
Для получения токена чат-боту нужно использовать POST-запрос: https://bots-api.dion.vc/platform/v1/token.
Срок действия токена — 12 часов (720 минут). По истечении этого срока токен необходимо обновить, отправив повторный POST-запрос: https://bots-api.dion.vc/platform/v1/token.
Токен, полученный методом /platform/v1/token, передается в заголовке Authorization всех методов, описанных в разделе Доступные методы для работы в Dion.Чаты.
Чтобы бота можно было добавлять в групповые чаты, каналы, либо писать ему сообщения в ДМ-чате (личный чат с ботом) необходимо установить боту соответствующие настройки, используя метод POST /chats/v2/setMySettings.
Хост: https://bots-api.dion.vc/;
Метод: POST /platform/v1/token.
Входные параметры:
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
|
Адрес электронной почты пользователя |
|
* |
|
Пароль пользователя |
|
* |
Выходные параметры:
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Токен доступа ТУЗ |
|
* |
|
|
Данные ТУЗ |
* |
||
|
Данные ТУЗ |
|
* |
|
|
Адрес электронной почты |
|
* |
|
|
Инициалы |
|
||
|
ФИО |
|
||
|
Путь к аватару |
|
||
|
Должность |
|
||
|
Роли |
|
* |
|
|
Признак заполненности профиля |
|
||
Список возвращаемых HTTP-кодов:
200 Ok — запрос успешно выполнен;
400 Bad Request — неверно заполнены параметры запроса;
500 Internal Server Error — внутренняя ошибка сервера.
Токен доступа Bearer необходимо передавать в заголовке Authorization.
Хост: https://bots-api.dion.vc/.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/getUpdates;
Версия: v2;
URL: /getUpdates;
Назначение: Получение входящего обновления с использованием Long Polling;
Потребители: Боты Dion.Чаты.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
С 17 марта 2026 параметр offset передаётся как ID. Дополнительную информацию см. по ссылке.
|
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
|
Идентификатор первого обновления |
|
|
|
Максимальное количество обновлений:
|
|
|
|
Таймаут Long Polling в секундах:
|
|
|
|
Типы обновлений для получения:
|
||
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
||||
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
|||||
|
Идентификатор обновления |
|
|||||
|
Новое входящее сообщение. В том числе содержит информацию при удалении сообщения |
|
|||||
|
Список вложений |
|
|||||
|
Тип вложения. Возможные значения:
|
|
* |
||||
|
Изображение (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Видео (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Длительность видео в секундах |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Название файла |
|
* |
||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Документ (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Изображение миниатюры/обложки |
|
|||||
|
Название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Аудио (приходит, если type=audio) |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Длительность аудиозаписи в секундах |
|
* |
||||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
|||||
|
Название аудиозаписи, указанное в аудиотегах |
|
|||||
|
Оригинальное название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Информация о чате |
|
|||||
|
UUID-идентификатор чата |
|
* |
||||
|
Количество участников в чате |
|
|||||
|
Название чата/собеседника |
|
|||||
|
UUID-идентификатор родительского чата (для тредов) |
|
|||||
|
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) |
|
|||||
|
Тип чата. Возможные значения:
|
|
* |
||||
|
Дата отправки сообщения (Unix-время) |
|
* |
||||
|
Дата редактирования сообщения (Unix-время) |
|
|||||
|
Объект автора сообщения |
|
* |
||||
|
UUID-идентификатор пользователя |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя пользователя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
UUID-идентификатор сообщения |
|
* |
||||
|
Тип сообщения. Возможные значения:
|
|
* |
||||
|
Текст сообщения |
|
|||||
|
Объект исходного сообщения, на которое сделан ответ |
|
|||||
|
Ошибка при работе с сообщением (создание/удаление/редактирование) |
||||||
|
Отредактированное сообщение |
|
|||||
|
Список вложений |
|
|||||
|
Тип вложения. Возможные значения:
|
|
* |
||||
|
Изображение (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Видео (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Длительность видео в секундах |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Название файла |
|
* |
||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Документ (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Изображение миниатюры/обложки |
|
|||||
|
Название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Аудио (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Длительность аудиозаписи в секундах |
|
* |
||||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
|||||
|
Название аудиозаписи, указанное в аудиотегах |
|
|||||
|
Оригинальное название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Информация о чате |
|
|||||
|
UUID-идентификатор чата |
|
* |
||||
|
Количество участников в чате |
|
|||||
|
Название чата/собеседника |
|
|||||
|
UUID-идентификатор родительского чата (для тредов) |
|
|||||
|
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) |
|
|||||
|
Тип чата. Возможные значения:
|
|
* |
||||
|
Дата отправки сообщения (Unix-время) |
|
* |
||||
|
Дата редактирования сообщения (Unix-время) |
|
|||||
|
Объект автора сообщения |
|
* |
||||
|
UUID-идентификатор пользователя |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя пользователя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
UUID-идентификатор сообщения |
|
* |
||||
|
Тип сообщения. Возможные значения:
|
|
* |
||||
|
Текст сообщения |
|
|||||
|
Объект исходного сообщения, на которое сделан ответ |
|
|||||
|
Изменение статуса участника чата |
|
|||||
|
Информация о чате |
|
|||||
|
UUID-идентификатор чата |
|
* |
||||
|
Количество участников в чате |
|
|||||
|
Название чата/собеседника |
|
|||||
|
UUID-идентификатор родительского чата (для тредов) |
|
|||||
|
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) |
|
|||||
|
Тип чата. Возможные значения:
|
|
* |
||||
|
Объект автора сообщения |
|
* |
||||
|
UUID-идентификатор пользователя |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя пользователя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
Дата изменения (Unix timestamp) |
|
* |
||||
|
Предыдущий статус участника |
|
* |
||||
|
Статус участника. Возможные значения:
|
|
* |
||||
|
Информация о пользователе |
|
* |
||||
|
UUID-идентификатор |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
Предыдущий статус участника |
|
* |
||||
|
Статус участника. Возможные значения:
|
|
* |
||||
|
Информация о пользователе |
|
* |
||||
|
UUID-идентификатор |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
Изменение статуса участника чата |
|
|||||
|
Информация о чате |
|
|||||
|
UUID-идентификатор чата |
|
* |
||||
|
Количество участников в чате |
|
|||||
|
Название чата/собеседника |
|
|||||
|
UUID-идентификатор родительского чата (для тредов) |
|
|||||
|
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) |
|
|||||
|
Тип чата. Возможные значения:
|
|
* |
||||
|
Объект автора сообщения |
|
* |
||||
|
UUID-идентификатор пользователя |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя пользователя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
Дата изменения (Unix timestamp) |
|
* |
||||
|
Предыдущий статус участника |
|
* |
||||
|
Статус участника. Возможные значения:
|
|
* |
||||
|
Информация о пользователе |
|
* |
||||
|
UUID-идентификатор |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
Предыдущий статус участника |
|
* |
||||
|
Статус участника. Возможные значения:
|
|
* |
||||
|
Информация о пользователе |
|
* |
||||
|
UUID-идентификатор |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
Сообщение в канале |
|
|||||
|
Список вложений |
|
|||||
|
Тип вложения. Возможные значения: * |
|
* |
||||
|
Изображение (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Видео (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Длительность видео в секундах |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Название файла |
|
* |
||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Документ (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Изображение миниатюры/обложки |
|
|||||
|
Название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Аудио (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Длительность аудиозаписи в секундах |
|
* |
||||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
|||||
|
Название аудиозаписи, указанное в аудиотегах |
|
|||||
|
Оригинальное название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Информация о чате |
|
|||||
|
UUID-идентификатор чата |
|
* |
||||
|
Количество участников в чате |
|
|||||
|
Название чата/собеседника |
|
|||||
|
UUID-идентификатор родительского чата (для тредов) |
|
|||||
|
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) |
|
|||||
|
Тип чата. Возможные значения:
|
|
* |
||||
|
Дата отправки сообщения (Unix-время) |
|
* |
||||
|
Дата редактирования сообщения (Unix-время) |
|
|||||
|
Объект автора сообщения |
|
* |
||||
|
UUID-идентификатор пользователя |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя пользователя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
UUID-идентификатор сообщения |
|
* |
||||
|
Тип сообщения. Возможные значения:
|
|
* |
||||
|
Текст сообщения |
|
|||||
|
Объект исходного сообщения, на которое сделан ответ |
|
|||||
Пример ответа |
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и событие отправлено на создание. Дальнейшую информацию о сообщение можно получить с помощью метода getUpdates.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, сообщение отправлено в очередь на создание;
400 Bad Request — неверно заполнены параметры запроса, не существует сообщения, на которое отвечают;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на создание сообщения;
404 Not Found — чат не найден;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/sendMessage;
Версия: v2;
URL: /sendMessage;
Назначение: Отправка текстового сообщения;
Потребители: Боты Dion.Чаты;
Привилегии: Бот может отправить сообщение в чат, в котором является участником.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
Параметры тела запроса |
||||
|
UUID-идентификатор чата |
|
* |
|
|
Текст сообщения:
|
|
* |
|
|
Режим форматирования текста. Возможные значения:
Значение по умолчанию: |
|
||
|
Массив объектов форматирования. Имеет приоритет над |
|
||
|
Язык программирования для типа |
|
||
|
Длина сущности в кодовых единицах UTF-16 |
|
* |
|
|
Смещение относительно начала текста (UTF-16) |
|
* |
|
|
Тип сущности. Возможные значения:
|
|
* |
|
|
URL-адрес для типа |
|
||
|
Упоминание пользователя для типа |
|
||
|
Параметры ответа на сообщение |
|
||
|
UUID сообщения ( |
|
* |
|
Пример запроса (cURL) |
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
||||
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
|||||
|
Список вложений |
|
|||||
|
Тип вложения. Возможные значения:
|
|
* |
||||
|
Изображение (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Видео (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Длительность видео в секундах |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
int |
* |
||||
|
Название файла |
|
* |
||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Документ (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Изображение миниатюры/обложки |
|
|||||
|
Название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Документ (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Длительность аудиозаписи в секундах |
|
* |
||||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
|||||
|
Название аудиозаписи, указанное в аудиотегах |
|
|||||
|
Оригинальное название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Информация о чате |
|
|||||
|
UUID-идентификатор чата |
|
* |
||||
|
Количество участников в чате |
|
|||||
|
Название чата/собеседника |
|
|||||
|
UUID-идентификатор родительского чата (для тредов) |
|
|||||
|
UUID-идентификатор родительского сообщения (для тредов) |
|
|||||
|
Тип чата. Возможные значения:
|
|
* |
||||
|
Дата отправки сообщения (Unix-время) |
|
* |
||||
|
Дата редактирования сообщения (Unix-время) |
|
|||||
|
Объект автора сообщения |
|
* |
||||
|
UUID-идентификатор пользователя |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя пользователя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при is_bot=true). Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
UUID-идентификатор сообщения |
|
* |
||||
|
Тип сообщения. Возможные значения:
|
|
* |
||||
|
Текст сообщения |
|
|||||
|
Объект исходного сообщения, на которое сделан ответ |
|
|||||
Пример ответа |
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и событие отправлено на создание. Дальнейшую информацию о сообщение можно получить с помощью метода getUpdates.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, сообщение отправлено в очередь на создание;
400 Bad Request — неверно заполнены параметры запроса, не существует сообщения, на которое отвечают;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на создание сообщения;
404 Not Found — чат не найден;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/editMessageText;
Версия: v2;
URL: /editMessageText;
Назначение: Изменение текстового сообщения;
Потребители: Боты Dion.Чаты;
Привилегии:
бот может редактировать только свои сообщения;
сообщения можно редактировать в течение 24 часов после отправки;
системные сообщения редактировать нельзя.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
Параметры тела запроса |
||||
|
UUID-идентификатор чата |
|
* |
|
|
UUID-идентификатор сообщения. Можно передать как |
|
* |
|
|
Текст сообщения:
|
|
* |
|
|
Режим форматирования текста. Возможные значения:
Значение по умолчанию: |
|
||
|
Массив объектов форматирования/специального элемента в тексте сообщения |
|
||
|
Язык программирования для типа pre (блок кода) |
|
||
|
Длина сущности в кодовых единицах UTF-16 |
|
* |
|
|
Смещение от начала текста в кодовых единицах UTF-16 |
|
* |
|
|
Тип сущности. Возможные значения:
|
|
* |
|
|
URL-адрес для сущностей типа |
|
||
|
Данные пользователя для сущностей типа |
|
||
Пример запроса (cURL) |
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
||||
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
|||||
|
Список вложений |
|
|||||
|
Тип вложения. Возможные значения:
|
|
* |
||||
|
Изображение (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Видео (если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Длительность видео в секундах |
|
* |
||||
|
Ширина |
|
* |
||||
|
Высота |
|
* |
||||
|
Название файла |
|
* |
||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Документ (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
||||
|
Изображение миниатюры/обложки |
|
|||||
|
Название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Документ (приходит, если |
|
|||||
|
UUID-идентификатор файла |
|
* |
||||
|
Уникальный идентификатор файла (первые 16 символов fingerprint) |
|
* |
||||
|
Длительность аудиозаписи в секундах |
|
* |
||||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
|||||
|
Название аудиозаписи, указанное в аудиотегах |
|
|||||
|
Оригинальное название файла |
|
|||||
|
MIME-тип файла |
|
|||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
|||||
|
Изображение миниатюры/обложки |
|
|||||
|
Информация о чате |
|
|||||
|
UUID-идентификатор чата |
|
* |
||||
|
Количество участников в чате |
|
|||||
|
Название чата/собеседника |
|
|||||
|
UUID-идентификатор родительского чата (для тредов) |
|
|||||
|
UUID-идентификатор родительского сообщения (для тредов) |
|
|||||
|
Тип чата. Возможные значения:
|
|
* |
||||
|
Дата отправки сообщения (Unix-время) |
|
* |
||||
|
Дата редактирования сообщения (Unix-время) |
|
|||||
|
Объект автора сообщения |
|
* |
||||
|
UUID-идентификатор пользователя |
|
* |
||||
|
Является ли ботом |
|
* |
||||
|
Имя пользователя |
|
* |
||||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
||||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
||||
|
Описание |
|
|||||
|
UUID-идентификатор сообщения |
|
* |
||||
|
Тип сообщения. Возможные значения:
|
|
* |
||||
|
Текст сообщения |
|
|||||
|
Объект исходного сообщения, на которое сделан ответ |
|
|||||
Пример ответа |
|||||||
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и событие отправлено на создание. Дальнейшую информацию о сообщение можно получить с помощью метода getUpdates.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, сообщение отправлено в очередь на изменение;
400 Bad Request — неверно заполнены параметры запроса;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на изменение сообщения;
404 Not Found — сообщение или чат не найдены;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/deleteMessage;
Версия: v2;
URL: /deleteMessage;
Назначение: Удаление текстового сообщения;
Потребители: Боты Dion.Чаты;
Привилегии: Удаление чужих сообщений доступно только администраторам чата.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор чата |
|
* |
|
UUID-идентификатор сообщения. Можно передать как |
|
* |
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
||
|
UUID-идентификатор удаляемого сообщения |
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение удалено. Это означает, что запрос обработан и отправлено событие на удаление.
Список возвращаемых HTTP-кодов:
202 Accepted — успешный ответ, сообщение отправлено в очередь на удаление;
400 Bad Request — неверно заполнены параметры запроса;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на удаление сообщения;
404 Not Found — сообщение или чат не найдены;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/file/{file_id};
Версия: v2.
URL: /file/{file_id};
Назначение: Скачивание файла по идентификатору;
Потребители: Боты Dion.Чаты;
Привилегии: Бот может отправить сообщение в чат, в котором является участником.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор файла из сообщения ( |
|
* |
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
В ответе содержатся расшифрованные бинарные данные файла.
Заголовки ответа:
Content-Type — MIME-тип файла;
Content-Disposition — имя файла для скачивания;
Content-Length — размер файла в байтах.
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, в ответе содержатся расшифрованные бинарные данные файла;
400 Bad Request — неверно заполнены параметры запроса, например, недействительный идентификатор файла;
401 Unauthorized — пользователь не авторизован: отсутствует или недействительный токен авторизации (Authorization);
403 Forbidden — нет доступа к файлу;
404 Not Found — файл не найден;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/getFile;
Версия: v2;
URL: /getFile;
Назначение: Получение информации о файле по его идентификатору;
Потребители: Боты Dion.Чаты.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор файла из сообщения ( |
|
* |
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
UUID-идентификатор файла |
|
||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||
|
Уникальный идентификатор файла (первые 16 символов |
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Список возвращаемых HTTP-кодов:
202 Accepted — успешный ответ;
400 Bad Request — неверно заполнены параметры запроса, например, недействительный идентификатор файла;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
403 Forbidden — нет доступа к файлу;
404 Not Found — файл не найден;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/getChat;
Версия: v2;
URL: /getChat;
Назначение: Получение информации о чате по его идентификатору;
* Потребители: Боты Dion.Чаты.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор чата |
|
* |
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
UUID-идентификатор чата |
|
* |
|
|
Количество участников в чате |
|
||
|
Название чата/собеседника |
|
||
|
UUID-идентификатор родительского чата. Актуально для типа |
|
||
|
UUID-идентификатор родительского сообщения, из которого начался тред. Актуально для типа |
|
||
|
Тип чата. Возможные значения:
|
string |
* |
|
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Список возвращаемых HTTP-кодов:
202 Accepted — успешный ответ;
400 Bad Request — неверно заполнены параметры запроса, например, недействительный идентификатор чата или чат не найден;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
403 Forbidden — бот не является участником чата / нет доступа к чату;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/getMe;
Версия: v2;
URL: /getMe;
Назначение: Получение информации о себе (текущем боте);
Потребители: Боты Dion.Чаты.
| Токен доступа Bearer передается в заголовке Authorization. |
Пример запроса (cURL):
curl --location 'https://bots-api.dion.vc/chats/v2/getMe' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
UUID-идентификатор |
|
* |
|
|
Является ли ботом |
|
* |
|
|
Имя |
|
* |
|
|
Может ли бот отправлять личные сообщения (актуально для Возможные значения:
|
|
* |
|
|
Может ли бот вступать в группы (актуально для Возможные значения:
|
|
* |
|
|
Может ли бот вступать в каналы (актуально для Возможные значения:
|
|
* |
|
|
Описание |
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или недействительный токен Authorization;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/getMyCommands;
Версия: v2;
URL: /getMyCommands;
Назначение: Получение команды бота (текущего);
Потребители: Боты Dion.Чаты.
| Токен доступа Bearer передается в заголовке Authorization. |
Пример запроса (cURL):
curl --location 'https://bots-api.dion.vc/chats/v2/getMyCommands' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
Название команды. Должно начинаться с «/». Ограничения:
|
|
||
|
Описание команды. Ограничения:
|
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы: Если команды не заданы, в параметре result возвращается пустой массив.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/getMyDescription;
Версия: v2;
URL: /getMyDescription;
Назначение: Получение описания бота (текущего);
Потребители: Боты Dion.Чаты.
| Токен доступа Bearer передается в заголовке Authorization. |
Пример запроса (cURL):
curl --location 'https://bots-api.dion.vc/chats/v2/getMyDescription' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
Описание команды. Ограничения:
|
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы: Если команды не заданы, в параметре result возвращается пустой массив.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
404 Not Found — бот не зарегистрирован в системе;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: GET /chats/v2/getMyName;
Версия: v2;
URL: /getMyName;
Назначение: Получение имени бота (текущего);
Потребители: Боты Dion.Чаты.
| Токен доступа Bearer передается в заголовке Authorization. |
Пример запроса (cURL):
curl --location 'https://bots-api.dion.vc/chats/v2/getMyName' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Массив объектов с командами бота |
|
||
|
Отображаемое имя/название бота. Ограничение по длине строки: 3-255 символов |
|
* |
|
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы: Если команды не заданы, в параметре result возвращается пустой массив.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
404 Not Found — бот не зарегистрирован в системе;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/setMyCommands;
Версия: v2;
URL: /setMyCommands;
Назначение: Установка списка команд бота, отображаемых в меню команд;
Потребители: Боты Dion.Чаты.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
Параметры тела запроса |
||||
|
Список команд бота. Максимум 20 команд. Пустой массив удаляет все команды |
|
* |
|
|
Название команды. Должно начинаться с «/». Ограничение по длине строки: 1-32 символов. Ограничения по символам: английские буквы, цифры и «_» |
|
* |
|
|
Описание команды. Ограничение по длине строки: 1-64 символов |
|
* |
|
Пример запроса (cURL) |
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
UUID-идентификатор |
|
* |
|
|
Является ли ботом |
boolean |
* |
|
|
Имя |
|
* |
|
|
Может ли бот отправлять личные сообщения. Актуально для пользователей с Возможные значения:
|
|
* |
|
|
Может ли бот вступать в группы. Актуально для пользователей с |
|
* |
|
|
Может ли бот вступать в каналы. Актуально для пользователей с |
|
* |
|
|
Описание |
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
дубликаты команд автоматически удаляются (сохраняется первое вхождение);
команды автоматически приводятся к нижнему регистру.
Список возвращаемых HTTP-кодов:
202 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
404 Not Found — бот не зарегистрирован в системе;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/setMyDescription;
Версия: v2;
URL: /setMyDescription;
Назначение: Установка описания, отображаемого в профиле бота;
Потребители: Боты Dion.Чаты.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
Описание бота. Ограничения по длине строки: 3-64 символов |
|
* |
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
UUID-идентификатор |
|
* |
|
|
Является ли ботом |
|
* |
|
|
Имя |
|
* |
|
|
Может ли бот отправлять личные сообщения. Актуально для пользователей с Возможные значения:
|
|
* |
|
|
Может ли бот вступать в группы. Актуально для пользователей с |
|
* |
|
|
Может ли бот вступать в каналы. Актуально для пользователей с |
|
* |
|
|
Описание |
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Список возвращаемых HTTP-кодов:
202 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
404 Not Found — бот не зарегистрирован в системе;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/setMyName;
Версия: v2;
URL: /setMyName;
Назначение: Установка названия бота;
Потребители: Боты Dion.Чаты.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
Отображаемое имя/название бота. Ограничения по длине строки: 3-255 символов |
|
* |
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
UUID-идентификатор |
|
* |
|
|
Является ли ботом |
|
* |
|
|
Имя |
|
* |
|
|
Может ли бот отправлять личные сообщения. Актуально для пользователей с Возможные значения:
|
|
* |
|
|
Может ли бот вступать в группы. Актуально для пользователей с |
|
* |
|
|
Может ли бот вступать в каналы. Актуально для пользователей с |
|
* |
|
|
Описание |
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Список возвращаемых HTTP-кодов:
202 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
404 Not Found — бот не зарегистрирован в системе;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/setMySettings;
Версия: v2;
URL: /setMySettings;
Назначение: Установка настройки бота;
Потребители: Боты Dion.Чаты.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
Может ли бот отправлять личные сообщения. Актуально для пользователей с Возможные значения:
|
|
|
|
Может ли бот вступать в группы. Актуально для пользователей с Возможные значения:
|
|
|
|
Может ли бот вступать в каналы. Актуально для пользователей с Возможные значения:
|
|
|
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
|
Объект с результатом операции |
|
||
|
UUID-идентификатор |
|
* |
|
|
Является ли ботом |
|
* |
|
|
Имя |
|
* |
|
|
Может ли бот отправлять личные сообщения. Актуально для пользователей с Возможные значения:
|
|
* |
|
|
Может ли бот вступать в группы. Актуально для пользователей с Возможные значения:
|
|
* |
|
|
Может ли бот вступать в каналы. Актуально для пользователей с Возможные значения:
|
|
* |
|
|
Описание |
|
||
Пример ответа |
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ;
401 Unauthorized — пользователь не авторизован: отсутствует или у него недействительный токен авторизации (Authorization);
404 Not Found — бот не зарегистрирован в системе;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/sendDocument;
Версия: v2;
URL: /sendDocument;
Назначение: Отправка сообщения с документом (опционально с текстом);
Потребители: Боты Dion.Чаты;
Привилегии: Бот может отправить сообщение в чат, в котором является участником.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор чата |
|
* |
|
Файл документа |
|
* |
|
Текст к сообщению с документом:
|
|
|
|
Режим форматирования текста. Возможные значения:
|
|
|
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |||
|---|---|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|||
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
||||
|
Список вложений |
|
||||
|
Тип вложения. Возможные значения:
|
|
* |
|||
|
Изображение (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Видео (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность видео в секундах |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Название файла |
|
* |
|||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Изображение миниатюры/обложки |
|
||||
|
Название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность аудиозаписи в секундах |
|
* |
|||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
||||
|
Название аудиозаписи, указанное в аудиотегах |
|
||||
|
Оригинальное название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Информация о чате |
|
||||
|
UUID-идентификатор чата |
|
* |
|||
|
Количество участников в чате |
|
||||
|
Название чата/собеседника |
|
||||
|
UUID-идентификатор родительского чата (для тредов) |
|
||||
|
UUID-идентификатор родительского сообщения (для тредов) |
|
||||
|
Тип чата. Возможные значения:
|
|
* |
|||
|
Дата отправки сообщения (Unix-время) |
|
* |
|||
|
Дата редактирования сообщения (Unix-время) |
|
||||
|
Объект автора сообщения |
|
* |
|||
|
UUID-идентификатор пользователя |
|
* |
|||
|
Является ли ботом |
|
* |
|||
|
Имя пользователя |
|
* |
|||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
|||
|
Описание |
|
||||
|
UUID-идентификатор сообщения |
|
* |
|||
|
Тип сообщения. Возможные значения:
|
|
* |
|||
|
Текст сообщения |
|
||||
|
Объект исходного сообщения, на которое сделан ответ |
|
||||
Пример ответа |
||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
ограничения:
максимальный размер файла определяется настройками организации;
некоторые расширения файлов могут быть запрещены политикой безопасности — это определяется настройками организации.
получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и отправлено событие на создание. Дальнейшую информацию о сообщение можно получить из запроса getUpdates.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, сообщение отправлено в очередь на создание;
400 Bad Request — неверно заполнены параметры запроса, не найден чат;
401 Unauthorized — пользователь не авторизован: отсутствует или недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на создание сообщения, загрузка файлов запрещена политикой;
413 Payload Too Large — файл превышает максимальный размер;
415 Unsupported Media Type — тип файла или расширение запрещены;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/sendPhoto;
Версия: v2;
URL: /sendPhoto;
Назначение: Отправка сообщения с изображением (опционально с текстом);
Потребители: Боты Dion.Чаты;
Привилегии: Бот может отправить сообщение в чат, в котором является участником.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор чата |
|
* |
|
Файл документа |
|
* |
|
Текст к сообщению с документом:
|
|
|
|
Режим форматирования текста. Возможные значения:
|
|
|
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |||
|---|---|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|||
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
||||
|
Список вложений |
|
||||
|
Тип вложения. Возможные значения:
|
|
* |
|||
|
Изображение (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Видео (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность видео в секундах |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Название файла |
|
* |
|||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Изображение миниатюры/обложки |
|
||||
|
Название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность аудиозаписи в секундах |
|
* |
|||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
||||
|
Название аудиозаписи, указанное в аудиотегах |
|
||||
|
Оригинальное название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Информация о чате |
|
||||
|
UUID-идентификатор чата |
|
* |
|||
|
Количество участников в чате |
|
||||
|
Название чата/собеседника |
|
||||
|
UUID-идентификатор родительского чата (для тредов) |
|
||||
|
UUID-идентификатор родительского сообщения (для тредов) |
|
||||
|
Тип чата. Возможные значения:
|
|
* |
|||
|
Дата отправки сообщения (Unix-время) |
|
* |
|||
|
Дата редактирования сообщения (Unix-время) |
|
||||
|
Объект автора сообщения |
|
* |
|||
|
UUID-идентификатор пользователя |
|
* |
|||
|
Является ли ботом |
|
* |
|||
|
Имя пользователя |
|
* |
|||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
|||
|
Описание |
|
||||
|
UUID-идентификатор сообщения |
|
* |
|||
|
Тип сообщения. Возможные значения:
|
|
* |
|||
|
Текст сообщения |
|
||||
|
Объект исходного сообщения, на которое сделан ответ |
|
||||
Пример ответа |
||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
ограничения:
максимальный размер файла определяется настройками организации;
некоторые расширения файлов могут быть запрещены политикой безопасности — это определяется настройками организации.
получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и отправлено событие на создание. Дальнейшую информацию о сообщение можно получить из запроса getUpdates.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, сообщение отправлено в очередь на создание;
400 Bad Request — неверно заполнены параметры запроса, не найден чат;
401 Unauthorized — пользователь не авторизован: отсутствует или недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на создание сообщения, загрузка файлов запрещена политикой;
413 Payload Too Large — файл превышает максимальный размер;
415 Unsupported Media Type — тип файла или расширение запрещены;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service;
Метод: POST /chats/v2/sendVideo;
Версия: v2;
URL: /sendVideo;
Назначение: Отправка сообщения с видео (опционально с текстом);
Потребители: Боты Dion.Чаты;
Привилегии: Бот может отправить сообщение в чат, в котором является участником.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор чата |
|
* |
|
Файл документа |
|
* |
|
Текст к сообщению с документом:
|
|
|
|
Режим форматирования текста. Возможные значения:
|
|
|
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |||
|---|---|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|||
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
||||
|
Список вложений |
|
||||
|
Тип вложения. Возможные значения:
|
|
* |
|||
|
Изображение (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Видео (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность видео в секундах |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Название файла |
|
* |
|||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Изображение миниатюры/обложки |
|
||||
|
Название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность аудиозаписи в секундах |
|
* |
|||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
||||
|
Название аудиозаписи, указанное в аудиотегах |
|
||||
|
Оригинальное название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Информация о чате |
|
||||
|
UUID-идентификатор чата |
|
* |
|||
|
Количество участников в чате |
|
||||
|
Название чата/собеседника |
|
||||
|
UUID-идентификатор родительского чата (для тредов) |
|
||||
|
UUID-идентификатор родительского сообщения (для тредов) |
|
||||
|
Тип чата. Возможные значения:
|
|
* |
|||
|
Дата отправки сообщения (Unix-время) |
|
* |
|||
|
Дата редактирования сообщения (Unix-время) |
|
||||
|
Объект автора сообщения |
|
* |
|||
|
UUID-идентификатор пользователя |
|
* |
|||
|
Является ли ботом |
|
* |
|||
|
Имя пользователя |
|
* |
|||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
|||
|
|
|
||||
|
UUID-идентификатор сообщения |
|
* |
|||
|
Тип сообщения. Возможные значения:
|
|
* |
|||
|
Текст сообщения |
|
||||
|
Объект исходного сообщения, на которое сделан ответ |
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
ограничения:
максимальный размер файла определяется настройками организации;
некоторые расширения файлов могут быть запрещены политикой безопасности — это определяется настройками организации.
получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и отправлено событие на создание. Дальнейшую информацию о сообщение можно получить из запроса getUpdates.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, сообщение отправлено в очередь на создание;
400 Bad Request — неверно заполнены параметры запроса, не найден чат;
401 Unauthorized — пользователь не авторизован: отсутствует или недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на создание сообщения, загрузка файлов запрещена политикой;
413 Payload Too Large — файл превышает максимальный размер;
415 Unsupported Media Type — тип файла или расширение запрещены;
500 Internal Server Error — внутренняя ошибка сервера.
Микросервис: chats-backend-bot-api-service.
Метод: POST /chats/v2/sendMediaGroup.
Версия: v2.
URL: /sendMediaGroup.
Назначение: Отправка сообщения с несколькими файлами (опционально с текстом).
Потребители: Боты Dion.Чаты.
Привилегии: Бот может отправить сообщение в чат, в котором является участником.
Входные параметры:
| Токен доступа Bearer передается в заголовке Authorization. |
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
Параметры тела запроса |
|||
|
UUID-идентификатор чата |
|
* |
|
Первый файл |
|
* |
|
Первый файл |
|
* |
|
Второй файл |
|
|
|
Третий файл |
|
|
|
Четвертый файл |
|
|
|
Пятый файл |
|
|
|
Шестой файл |
|
|
|
Седьмой файл |
|
|
|
Восьмой файл |
|
|
|
Девятый файл |
|
|
|
Десятый файл |
|
|
|
Текст к сообщению с документом.
|
|
|
|
Режим форматирования текста. Возможные значения:
|
|
|
Пример запроса (cURL) |
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |||
|---|---|---|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|||
|
Массив объектов с обновлениями. Если обновлений нет, массив пустой |
|
||||
|
Список вложений |
|
||||
|
Тип вложения. Возможные значения:
|
|
* |
|||
|
Изображение (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Видео (если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность видео в секундах |
|
* |
|||
|
Ширина |
|
* |
|||
|
Высота |
|
* |
|||
|
Название файла |
|
* |
|||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Изображение миниатюры/обложки |
|
||||
|
Название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Документ (приходит, если |
|
||||
|
UUID-идентификатор файла |
|
* |
|||
|
Уникальный идентификатор файла (первые 16 символов |
|
* |
|||
|
Длительность аудиозаписи в секундах |
|
* |
|||
|
Исполнитель аудиозаписи, указанный в аудиотегах |
|
||||
|
Название аудиозаписи, указанное в аудиотегах |
|
||||
|
Оригинальное название файла |
|
||||
|
MIME-тип файла |
|
||||
|
Размер файла в байтах (оригинальный, до шифрования) |
|
||||
|
Изображение миниатюры/обложки |
|
||||
|
Информация о чате |
|
||||
|
UUID-идентификатор чата |
|
* |
|||
|
Количество участников в чате |
|
||||
|
Название чата/собеседника |
|
||||
|
UUID-идентификатор родительского чата (для тредов) |
|
||||
|
UUID-идентификатор родительского сообщения (для тредов) |
|
||||
|
Тип чата. Возможные значения:
|
|
* |
|||
|
Дата отправки сообщения (Unix-время) |
|
* |
|||
|
Дата редактирования сообщения (Unix-время) |
|
||||
|
Объект автора сообщения |
|
* |
|||
|
UUID-идентификатор пользователя |
|
* |
|||
|
Является ли ботом |
|
* |
|||
|
Имя пользователя |
|
* |
|||
|
Может ли бот отправлять личные сообщения (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в группы (актуально при Возможные значения:
|
|
* |
|||
|
Может ли бот вступать в каналы (актуально при Возможные значения:
|
|
* |
|||
|
|
|
||||
|
UUID-идентификатор сообщения |
|
* |
|||
|
Тип сообщения. Возможные значения:
|
|
* |
|||
|
Текст сообщения |
|
||||
|
Объект исходного сообщения, на которое сделан ответ |
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
|
Статус операции. Возможные значения:
|
|
* |
|
Код ошибки |
|
|
|
Описание ошибки |
|
Особенности работы:
ограничения:
максимальный размер файла определяется настройками организации;
некоторые расширения файлов могут быть запрещены политикой безопасности — это определяется настройками организации.
максимум 10 файлов в одном запросе;
минимум 1 файл обязателен;
поддерживаемые типы: photo, video, document;
формат файлов: файлы передаются как media[0], media[1], …, media[9].
Получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и отправлено событие на создание. Дальнейшую информацию о сообщение можно получить из запроса getUpdates.
Список возвращаемых HTTP-кодов:
200 Accepted — успешный ответ, сообщение отправлено в очередь на создание;
400 Bad Request — неверно заполнены параметры запроса, не найден чат, нет файлов или превышен лимит файлов;
401 Unauthorized — пользователь не авторизован: отсутствует или недействительный токен авторизации (Authorization);
403 Forbidden — нет прав на создание сообщения, загрузка файлов запрещена политикой;
413 Payload Too Large — файл превышает максимальный размер;
500 Internal Server Error — внутренняя ошибка сервера.
Разработчики ботов могут значительно ускорить процесс интеграции с нашим API v2, используя готовые SDK для Golang, Javascript и Python: