Для создания ТУЗ используйте инструкцию.
После создания ТУЗ и пароля Администратор может передать учетные данные (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/
Входные параметры:
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
email |
Адрес электронной почты пользователя | string | * |
password |
Пароль пользователя | string | * |
Выходные параметры:
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
access_token |
Токен доступа ТУЗ | string | * | |
user |
Данные ТУЗ | * | ||
id |
Данные ТУЗ | uuid | * | |
email |
Адрес электронной почты | string | * | |
initials |
Инициалы | string | ||
name |
ФИО | string | ||
avatar_http_path |
Путь к изображению (аватару) | string | ||
position |
Должность | string | ||
roles |
Роли | string[] | * | |
is_profile_filled_in |
Признак заполненности профиля | boolean | ||
Список возвращаемых HTTP-кодов:
200 Ok – запрос успешно выполнен;400 Bad Request – неверно заполнены параметры запроса;500 Internal Server Error – внутренняя ошибка сервера.Токен доступа Bearer необходимо передавать в заголовке Authorization.
Хост – https://bots-api.dion.vc/
Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный |
|---|---|---|---|
offset |
Идентификатор первого обновления update_id |
int64 | |
limit |
Максимальное количество обновлений:
|
int | |
timeout |
Таймаут Long Polling в секундах:
|
int | |
allowed_updates |
Типы обновлений для получения:
|
string[] | |
|
Пример запроса (cURL)
|
|||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | ||||
result |
Массив объектов с обновлениями. Если обновлений нет, массив пустой. | object[] | |||||
update_id |
Идентификатор обновления | int64 | |||||
message |
Новое входящее сообщение. В том числе содержит информацию при удалении сообщения | Message | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Аудио (приходит, если type=audio) |
Audio | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int64 | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int64 | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
message_failed |
Ошибка при работе с сообщением (создание/удаление/редактирование) | ||||||
edited_message |
Отредактированное сообщение | Message | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Аудио (приходит, если type=audio) |
Audio | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int64 | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int64 | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
chat member |
Изменение статуса участника чата | ChatMemberUpdated | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
date |
Дата изменения (Unix timestamp) | int64 | * | ||||
old_chat_member |
Предыдущий статус участника | ChatMember | * | ||||
status |
Статус участника.
|
string | * | ||||
user |
Информация о пользователе | User | * | ||||
id |
UUID-идентификатор | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
old_chat_member |
Предыдущий статус участника | ChatMember | * | ||||
status |
Статус участника.
|
string | * | ||||
user |
Информация о пользователе | User | * | ||||
id |
UUID-идентификатор | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
my_chat_member |
Изменение статуса участника чата | ChatMemberUpdated | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
date |
Дата изменения (Unix timestamp) | int64 | * | ||||
old_chat_member |
Предыдущий статус участника | ChatMember | * | ||||
status |
Статус участника.
|
string | * | ||||
user |
Информация о пользователе | User | * | ||||
id |
UUID-идентификатор | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
old_chat_member |
Предыдущий статус участника | ChatMember | * | ||||
status |
Статус участника.
|
string | * | ||||
user |
Информация о пользователе | User | * | ||||
id |
UUID-идентификатор | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
channel_post |
Сообщение в канале | Message | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Аудио (приходит, если type=audio) |
Audio | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения, из которого начался тред (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int64 | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int64 | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
|
Пример ответа
|
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и событие отправлено на создание. Дальнейшую информацию о сообщение можно получить с помощью метода *getUpdates*.
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ, сообщение отправлено в очередь на создание;400 Bad Request – неверно заполнены параметры запроса, не существует сообщения, на которое отвечают;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);403 Forbidden – нет прав на создание сообщения;404 Not Found – чат не найден;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
| Параметры тела запроса | |||||||
chat_id |
UUID-идентификатор чата | string | * | ||||
text |
Текст сообщения:
|
string | * | ||||
parse_mode |
Режим форматирования текста. Возможные значения:
|
string | |||||
entities |
Массив объектов форматирования в тексте. Имеет приоритет над parse_mode |
object[] | |||||
language |
Язык программирования для типа pre (блок кода) |
string | |||||
length |
Длина сущности в кодовых единицах UTF-16 | int | * | ||||
offset |
Смещение относительно начала текста в кодовых единицах UTF-16 | int | * | ||||
type |
Тип сущности. Возможные значения:
|
string | * | ||||
url |
URL-адрес для типа text_link |
string | |||||
user |
Упоминание пользователя для типа text_mention | User | |||||
reply_parameters |
Параметры ответа на сообщение | object | |||||
message_id |
UUID сообщения (intermediate_id или message_id), на которое отправляется ответ |
string | * | ||||
|
Пример запроса (cURL)
|
|||||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | ||||
result |
Массив объектов с обновлениями. Если обновлений нет, массив пустой. | object[] | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int64 | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int64 | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
|
Пример ответа
|
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и событие отправлено на создание. Дальнейшую информацию о сообщение можно получить с помощью метода *getUpdates*.
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ, сообщение отправлено в очередь на создание;400 Bad Request – неверно заполнены параметры запроса, не существует сообщения, на которое отвечают;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);403 Forbidden – нет прав на создание сообщения;404 Not Found – чат не найден;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательность | |
|---|---|---|---|---|
| Параметры тела запроса | ||||
chat_id |
UUID-идентификатор чата | string | * | |
message_id |
UUID-идентификатор сообщения. Можно передать как intermediate_id , полученный из sendMessage, так и реальный message_id полученный из getUpdates . |
string | * | |
text |
Текст сообщения:
|
string | * | |
parse_mode |
Режим форматирования текста. Возможные значения:
|
string | ||
entities |
Массив объектов форматирования/специального элемента в тексте сообщения | object[] | ||
language |
Язык программирования для типа pre (блок кода) |
string | ||
length |
Длина сущности в кодовых единицах UTF-16 | int | * | |
offset |
Смещение от начала текста в кодовых единицах UTF-16 | int | * | |
type |
Тип сущности. Возможные значения:
|
string | * | |
url |
URL-адрес для сущностей типа text_link |
string | ||
user |
Данные пользователя для сущностей типа text_mention |
User | ||
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | ||||
result |
Массив объектов с обновлениями. Если обновлений нет, массив пустой. | object[] | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
|
Пример ответа
|
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение создано, это значит, что запрос обработан и событие отправлено на создание. Дальнейшую информацию о сообщение можно получить с помощью метода *getUpdates*.
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ, сообщение отправлено в очередь на изменение;400 Bad Request – неверно заполнены параметры запроса;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);403 Forbidden – нет прав на изменение сообщения;404 Not Found – сообщение или чат не найдены;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| Параметры тела запроса | ||||
chat_id |
UUID-идентификатор чата | string | * | |
message_id |
UUID-идентификатор сообщения. Можно передать как intermediate_id, полученный из sendMessage, так и реальный message_id, полученный из getUpdates |
string | * | |
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |||
|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |||
result |
Объект с результатом операции | object | ||||
message_id |
UUID-идентификатор удаляемого сообщения | string | ||||
|
Пример ответа
|
||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа HTTP 200 (ok=true) не означает, что сообщение удалено. Это означает, что запрос обработан и отправлено событие на удаление.
Список возвращаемых HTTP-кодов:
202 Accepted – успешный ответ, сообщение отправлено в очередь на удаление;400 Bad Request – неверно заполнены параметры запроса;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);403 Forbidden – нет прав на удаление сообщения;404 Not Found – сообщение или чат не найдены;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| Параметры тела запроса | ||||
file_id |
UUID-идентификатор файла из сообщения (document.file_id, photo[].file_id и т.д.). |
string | * | |
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
В ответе содержатся расшифрованные бинарные данные файла.
Заголовки ответа:
Content-Type – MIME-тип файла;Content-Disposition – имя файла для скачивания;Content-Length – размер файла в байтах.Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ, в ответе содержатся расшифрованные бинарные данные файла;400 Bad Request – неверно заполнены параметры запроса, например, недействительный идентификатор файла;401 Unauthorized – пользователь не авторизован – отсутствует или недействительный токен авторизации (Authorization);403 Forbidden – нет доступа к файлу;404 Not Found – файл не найден;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| Параметры тела запроса | ||||
file_id |
UUID-идентификатор файла из сообщения (document.file_id, photo[].file_id и т.д.) |
string | * | |
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |||
|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |||
result |
Объект с результатом операции | object | ||||
file_id |
UUID-идентификатор файла | string | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | ||||
|
Пример ответа
|
||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Список возвращаемых HTTP-кодов:
202 Accepted – успешный ответ;400 Bad Request – неверно заполнены параметры запроса, например, недействительный идентификатор файла;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);403 Forbidden – нет доступа к файлу;404 Not Found – файл не найден;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| Параметры тела запроса | ||||
chat_id |
UUID-идентификатор чата | string | * | |
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |
result |
Объект с результатом операции | object | ||
id |
UUID-идентификатор чата | string | * | |
members_count |
Количество участников в чате | int | ||
name |
Название чата/собеседника | string | ||
parent_conversation_id |
UUID-идентификатор родительского чата. Актуально для типа thread |
string | ||
parent_message_id |
UUID-идентификатор родительского сообщения, из которого начался тред. Актуально для типа thread |
string | ||
type |
Тип чата. Возможные значения:
|
string | * | |
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Список возвращаемых HTTP-кодов:
202 Accepted – успешный ответ;400 Bad Request – неверно заполнены параметры запроса, например, недействительный идентификатор чата или чат не найден;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);403 Forbidden – бот не является участником чата / нет доступа к чату;500 Internal Server Error – внутренняя ошибка сервера.Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
Пример запроса (cURL)
curl --location 'https://bots-api.dion.vc/chats/v2/getMe' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |
result |
Объект с результатом операции | object | ||
id |
UUID-идентификатор | string | * | |
is_bot |
Является ли ботом | boolean | * | |
name |
Имя | string | * | |
can_send_dm |
Может ли бот отправлять личные сообщения (актуально для
|
boolean | * | |
can_join_groups |
Может ли бот вступать в группы (актуально для
|
boolean | * | |
can_join_channels |
Может ли бот вступать в каналы (актуально для
|
boolean | * | |
description |
Описание | string | ||
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или недействительный токен Authorization;500 Internal Server Error – внутренняя ошибка сервера.Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
Пример запроса (cURL)
curl --location 'https://bots-api.dion.vc/chats/v2/getMyCommands' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |
result |
Массив объектов с командами бота | object[] | ||
command |
Название команды. Должно начинаться с «/»
|
string | ||
description |
Описание команды.
|
string | ||
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы: Если команды не заданы, в параметре *result* возвращается пустой массив.
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);500 Internal Server Error – внутренняя ошибка сервера.Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
Пример запроса (cURL)
curl --location 'https://bots-api.dion.vc/chats/v2/getMyDescription' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |
result |
Массив объектов с командами бота | object[] | ||
description |
Описание команды.
|
string | ||
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы: Если команды не заданы, в параметре *result* возвращается пустой массив.
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);404 Not Found – бот не зарегистрирован в системе;500 Internal Server Error – внутренняя ошибка сервера.Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
Пример запроса (cURL)
curl --location 'https://bots-api.dion.vc/chats/v2/getMyName' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsImtpZCI6ImRpb24tYWNjZXNzLWp3dC12MiIsInR5cCI6IkpXVCJ9.eyJhdXRoX3Byb3ZpZGVyIjoiQ0xPVUQtTE9DQUwiLCJleHAiOjE3NzA3NDkxMDUsIm9yZ19pZCI6Ijk4ODdlMzk3LTgwMDktNDAyMi1hNTFkLTFmNzZmMjJkYzliMiIsInJvbGVzIjoiY2hhdF9ib3QiLCJzaWQiOiJlYjQzOTBiMy05ZDI5LTQ3MzgtODQyYi05MjAxMzBmOGY4NzIiLCJ0ZWNoIjp0cnVlLCJ1c2VyX2lkIjoiMTM0MjBjMGUtYmIyZC00YWM2LTkxNDktZWJlYjVjZTc0MWE0In0.29ZhiC0H2qZFOKR5HgfhDkQ2lWJWJMvr8wmicRdQ9hY'
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |
result |
Массив объектов с командами бота | object[] | ||
name |
Отображаемое имя/название бота. Ограничение по длине строки: 3-255 символов | string | * | |
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы: Если команды не заданы, в параметре *result* возвращается пустой массив.
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);404 Not Found – бот не зарегистрирован в системе;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
commands |
Список команд бота. Максимум 20 команд. Пустой массив удаляет все команды |
object[] | * | |
command |
Название команды. Должно начинаться с «/» Ограничение по длине строки: 1-32 символов. Ограничения по символам: английские буквы, цифры и «_» |
string | * | |
description |
Описание команды. Ограничение по длине строки: 1-64 символов |
string | * | |
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения: - true – успешно, запрос отправлен на обработку;- false – ошибка |
boolean | * | |
result |
Объект с результатом операции | object | ||
id |
UUID-идентификатор | string | * | |
is_bot |
Является ли ботом | boolean | * | |
name |
Имя | string | * | |
can_send_dm |
Может ли бот отправлять личные сообщения. Актуально для пользователей с is_bot=true.- true – может;- false – не может |
boolean | * | |
can_join_groups |
Может ли бот вступать в группы. Актуально для пользователей с is_bot=true |
boolean | * | |
can_join_channels |
Может ли бот вступать в каналы. Актуально для пользователей с is_bot=true |
boolean | * | |
description |
Описание | string | description |
|
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Список возвращаемых HTTP-кодов:
202 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);404 Not Found – бот не зарегистрирован в системе;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| Параметры тела запроса | ||||
description |
Описание бота. Ограничения по длине строки: 3-64 символов | string | * | |
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |
result |
Объект с результатом операции | object | ||
id |
UUID-идентификатор | string | * | |
is_bot |
Является ли ботом | boolean | * | |
name |
Имя | string | * | |
can_send_dm |
Может ли бот отправлять личные сообщения. Актуально для пользователей с is_bot=true.Возможные значения: - true – может;- false – не может |
boolean | * | |
can_join_groups |
Может ли бот вступать в группы. Актуально для пользователей с is_bot=true |
boolean | * | |
can_join_channels |
Может ли бот вступать в каналы. Актуально для пользователей с is_bot=true |
boolean | * | |
description |
Описание | string | description |
|
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Список возвращаемых HTTP-кодов:
202 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);404 Not Found – бот не зарегистрирован в системе;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
name |
Отображаемое имя/название бота. Ограничения по длине строки: 3-255 символов | string | * | |
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения: - true – успешно, запрос отправлен на обработку;- false – ошибка |
boolean | * | |
result |
Объект с результатом операции | object | ||
id |
UUID-идентификатор | string | * | |
is_bot |
Является ли ботом | boolean | * | |
name |
Имя | string | * | |
can_send_dm |
Может ли бот отправлять личные сообщения. Актуально для пользователей с is_bot=true.Возможные значения: - true – может;- false – не может |
boolean | * | |
can_join_groups |
Может ли бот вступать в группы. Актуально для пользователей с is_bot=true |
boolean | * | |
can_join_channels |
Может ли бот вступать в каналы. Актуально для пользователей с is_bot=true |
boolean | * | |
description |
Описание | string | description |
|
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Список возвращаемых HTTP-кодов:
202 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);404 Not Found – бот не зарегистрирован в системе;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
can_send_dm |
Может ли бот отправлять личные сообщения.
|
boolean | ||
can_join_groups |
Может ли бот вступать в группы.
|
boolean | ||
can_join_channels |
Может ли бот вступать в каналы.
|
boolean | ||
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | |
result |
Объект с результатом операции | object | ||
id |
UUID-идентификатор | string | * | |
is_bot |
Является ли ботом | boolean | * | |
name |
Имя | string | * | |
can_send_dm |
Может ли бот отправлять личные сообщения.
|
boolean | * | |
can_join_groups |
Может ли бот вступать в группы.
|
boolean | * | |
can_join_channels |
Может ли бот вступать в каналы.
|
boolean | * | |
description |
Описание | string | description |
|
|
Пример ответа
|
||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Список возвращаемых HTTP-кодов:
200 Accepted – успешный ответ;401 Unauthorized – пользователь не авторизован – отсутствует или у него недействительный токен авторизации (Authorization);404 Not Found – бот не зарегистрирован в системе;500 Internal Server Error – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| form-data | ||||
chat_id |
UUID-идентификатор чата. | string | * | |
document |
Файл документа | File | * | |
text |
Текст к сообщению с документом.
|
string | ||
parse_mode |
Режим форматирования текста. Возможные значения:
|
string | ||
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | ||||
result |
Массив объектов с обновлениями. Если обновлений нет, массив пустой. | object[] | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
|
Пример ответа
|
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа 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 – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| form-data | ||||
chat_id |
UUID-идентификатор чата. | string | * | |
document |
Файл документа | File | * | |
text |
Текст к сообщению с документом.
|
string | ||
parse_mode |
Режим форматирования текста. Возможные значения:
|
string | ||
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | ||||
result |
Массив объектов с обновлениями. Если обновлений нет, массив пустой. | object[] | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
|
Пример ответа
|
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа 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 – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа*
*Bearer*передается в заголовке*Authorization*.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| form-data | ||||
chat_id |
UUID-идентификатор чата. | string | * | |
document |
Файл документа | File | * | |
text |
Текст к сообщению с документом.
|
string | ||
parse_mode |
Режим форматирования текста. Возможные значения:
|
string | ||
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | ||||
result |
Массив объектов с обновлениями. Если обновлений нет, массив пустой. | object[] | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int64 | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int64 | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
|
Пример ответа
|
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа 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 – внутренняя ошибка сервера.Входные параметры:
Примечание! Токен доступа
Bearerпередается в заголовкеAuthorization.
| Параметр | Описание | Тип | Обязательный | |
|---|---|---|---|---|
| form-data | ||||
chat_id |
UUID-идентификатор чата | string | * | |
media[0] |
Первый файл | File | * | |
media[0] |
Первый файл | File | * | |
media[1] |
Второй файл | File | ||
media[2] |
Третий файл | File | ||
media[3] |
Четвертый файл | File | ||
media[4] |
Пятый файл | File | ||
media[5] |
Шестой файл | File | ||
media[6] |
Седьмой файл | File | ||
media[7] |
Восьмой файл | File | ||
media[8] |
Девятый файл | File | ||
media[9] |
Десятый файл | File | ||
text |
Текст к сообщению с документом.
|
string | ||
parse_mode |
Режим форматирования текста. Возможные значения:
|
string | ||
|
Пример запроса (cURL)
|
||||
Выходные параметры (успешно):
| Параметр | Описание | Тип | Обязательный | ||||
|---|---|---|---|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * | ||||
result |
Массив объектов с обновлениями. Если обновлений нет, массив пустой. | object[] | |||||
attachments |
Список вложений | Attachment[] | |||||
type |
Тип вложения. Возможные значения:
|
string | * | ||||
photo |
Изображение (если type=photo) |
Photo | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
video |
Видео (если type=video) |
Video | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность видео в секундах | int | * | ||||
width |
Ширина | int | * | ||||
height |
Высота | int | * | ||||
file_name |
Название файла | string | * | ||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
document |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
file_name |
Название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
audio |
Документ (приходит, если type=document) |
Document | |||||
file_id |
UUID-идентификатор файла | string | * | ||||
file_unique_id |
Уникальный идентификатор файла (первые 16 символов fingerprint) | string | * | ||||
duration |
Длительность аудиозаписи в секундах | int64 | * | ||||
performer |
Исполнитель аудиозаписи, указанный в аудиотегах | string | |||||
title |
Название аудиозаписи, указанное в аудиотегах | string | |||||
file_name |
Оригинальное название файла | string | |||||
mime_type |
MIME-тип файла | string | |||||
file_size |
Размер файла в байтах (оригинальный, до шифрования) | int64 | |||||
thumbnail |
Изображение миниатюры/обложки | Photo | |||||
chat |
Информация о чате | Chat | |||||
id |
UUID-идентификатор чата | string | * | ||||
members_count |
Количество участников в чате | int | |||||
name |
Название чата/собеседника | string | |||||
parent_conversation_id |
UUID-идентификатор родительского чата (для тредов) | string | |||||
parent_message_id |
UUID-идентификатор родительского сообщения (для тредов) | string | |||||
type |
Тип чата.
|
string | * | ||||
date |
Дата отправки сообщения (Unix-время) | int | * | ||||
edit_date |
Дата редактирования сообщения (Unix-время) | int | |||||
from |
Объект автора сообщения | User | * | ||||
id |
UUID-идентификатор пользователя | string | * | ||||
is_bot |
Является ли ботом | boolean | * | ||||
name |
Имя пользователя | string | * | ||||
can_send_dm |
Может ли бот отправлять личные сообщения (актуально при
|
boolean | * | ||||
can_join_groups |
Может ли бот вступать в группы (актуально при
|
boolean | * | ||||
can_join_channels |
Может ли бот вступать в каналы (актуально при
|
boolean | * | ||||
description |
Описание | string | |||||
message_id |
UUID-идентификатор сообщения | string | * | ||||
message_type |
Тип сообщения.
|
string | * | ||||
text |
Текст сообщения | string | |||||
reply_to_message |
Объект исходного сообщения, на которое сделан ответ | Message | |||||
|
Пример ответа
|
|||||||
Выходные параметры (ошибка):
| Параметр | Описание | Тип | Обязательность |
|---|---|---|---|
ok |
Статус операции. Возможные значения:
|
boolean | * |
error_code |
Код ошибки | int | |
description |
Описание ошибки | string |
Особенности работы:
Получение ответа 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.