SpaceChat Bot API

Программный интерфейс для создания ботов в SpaceChat. API построен на привычных для бот-платформ принципах, поэтому переход с других платформ требует минимальной адаптации.

Эндпоинт

Все запросы к API выполняются по адресу:

https://api.spacechat.org/botway/bot{TOKEN}/{METHOD}

Где {TOKEN} — токен бота, {METHOD} — имя метода. Токен бота выдаётся через @BotFather.

Соглашения вызова

• Параметры запроса принимаются как строками, так и нативными типами (числа, логические значения): "chat_id": 123 и "chat_id": "123" равнозначны.
• Идентификатор канала или супергруппы принимается в обоих форматах: полном (-1001073805824) и коротком (-1073805824). Для совместимости с библиотеками для ботов используйте полный.
• Клавиатуры передаются в параметре reply_markup — объектом или JSON-строкой, оба варианта работают.
• Медиа можно отправлять загрузкой файла (multipart/form-data) или по ссылке (URL).
• Получение обновлений — long polling (getUpdates) или вебхук (setWebhook).

Методы

Доступны

• Сообщения: getMe, getUpdates, sendMessage, forwardMessage, copyMessage, deleteMessage, sendChatAction, answerCallbackQuery
• Редактирование: editMessageText, editMessageCaption, editMessageReplyMarkup, editMessageMedia
• Медиа: sendPhoto, sendVideo, sendDocument, sendAudio, sendVoice, sendSticker, sendMediaGroup, sendPoll, sendDice, sendContact, sendLocation, sendVenue, getFile
• Управление чатами: getChat, getChatMember, getChatMemberCount, getChatAdministrators, getUserProfilePhotos, banChatMember, unbanChatMember, restrictChatMember, promoteChatMember, pinChatMessage, unpinChatMessage, exportChatInviteLink, createChatInviteLink, setChatDescription
• Команды и профиль бота: setMyCommands, getMyCommands, deleteMyCommands, getMyDescription
• Форумные топики: createForumTopic и связанные
• Вебхуки: setWebhook, getWebhookInfo, deleteWebhook

Пока не доступны

• инлайн-режим (answerInlineQuery).

Список доступных методов расширяется.

Платежи (sendInvoice и связанные методы) не поддерживаются.

Примеры запросов

Отправка сообщения

POST https://api.spacechat.org/botway/bot{TOKEN}/sendMessage
Content-Type: application/json

{
  "chat_id": "123456789",
  "text": "Привет!"
}

Сообщение с форматированием

{
  "chat_id": "123456789",
  "text": "<b>Жирный</b> и <i>курсив</i>",
  "parse_mode": "HTML"
}

Сообщение с кнопками

{
  "chat_id": "123456789",
  "text": "Выберите:",
  "reply_markup": "{\"inline_keyboard\":[[{\"text\":\"Да\",\"callback_data\":\"yes\"},{\"text\":\"Нет\",\"callback_data\":\"no\"}]]}"
}

Отправка фото (загрузка файла)

curl -X POST "https://api.spacechat.org/botway/bot{TOKEN}/sendPhoto" \
  -F "chat_id=123456789" \
  -F "photo=@/path/to/photo.jpg" \
  -F "caption=Описание"

Отправка фото (по ссылке)

{
  "chat_id": "123456789",
  "photo": "https://example.com/photo.jpg",
  "caption": "Описание"
}

Получение обновлений

{
  "offset": "0",
  "limit": "100",
  "timeout": "10"
}

Установка вебхука

{
  "url": "https://example.com/my-bot-webhook"
}

Текущие ограничения

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

• Реализована часть методов (см. раздел «Методы»).
• У входящих медиа в getUpdates часть метаданных приходит не в полном объёме (например у альбомов нет группировки, у видео — превью).
• Информация о пересылке сообщения (forward) в getUpdates приходит не всегда.
• Часть сервисных сообщений группы (создание, смена названия или фото) доходит до бота не всегда.
• editMessageText с HTML-разметкой может задваивать текст.
• На некоторых ошибках API возвращает HTTP-статус 200, а признак ошибки — в теле ответа.

Поддержка

Вопросы по работе бота и сообщения о проблемах — в поддержку SpaceChat: @support.