Справочник методов API
Все методы одним списком: что делает, какие принимает параметры и какой уровень доступа нужен ключу. Список формируется из кода сервиса, поэтому не расходится с тем, что работает на самом деле.
Все вызовы — POST /api/v1 с заголовком
Authorization: Bearer bb_….
Метод указывается полем method, бот — полем
botId.
Ответ всегда приходит с кодом 200 — успех и отказ различаются полем
success или
error в теле, а не HTTP-статусом.
Это унаследовано от прежней версии API и сохранено намеренно: по нему уже работают чужие скрипты.
Уровень доступа задаётся при выпуске ключа в разделе «API, MCP» панели. Машиночитаемое описание всех методов —
/api/v1/openapi.json: его можно скормить
генератору клиента или Swagger UI.
Подписчики и группы
AddUserToGroup изменение
Добавить подписчика в группу или убрать из неё.
| Параметр | Тип | Описание |
|---|---|---|
| user* | integer | id подписчика |
| group* | integer | id группы |
| remove | boolean | true — убрать из группы |
CreateGroup изменение
Создать группу подписчиков.
| Параметр | Тип | Описание |
|---|---|---|
| name* | string | название группы |
| description | string | |
| grouplist | integer | id папки сегментов; по умолчанию первая |
DeleteGroup полный
Удалить группу вместе с членством. Подписчики остаются. Необратимо.
| Параметр | Тип | Описание |
|---|---|---|
| id* | integer | id группы (GetGroups) |
GetBotUsers чтение
Подписчики бота с признаками «закрыл чат» и «заблокирован».
| Параметр | Тип | Описание |
|---|---|---|
| limit | integer | по умолчанию 1000, максимум 5000 |
| offset | integer |
GetGroupUsers чтение
Подписчики группы.
| Параметр | Тип | Описание |
|---|---|---|
| group* | integer | id группы |
| limit | integer | по умолчанию 1000, максимум 5000 |
| offset | integer |
GetGroups чтение
Группы подписчиков (сегменты).
GetUserProfile чтение
Профиль подписчика: поиск по id, логину, телефону или email.
| Параметр | Тип | Описание |
|---|---|---|
| user | integer | id подписчика |
| login | string | логин Telegram без @ |
| phone | string | |
| string |
Сообщения и рассылки
CancelBroadcast изменение
Отменить запланированную рассылку. Ушедшую в отправку отменить нельзя.
| Параметр | Тип | Описание |
|---|---|---|
| id* | integer | id рассылки (GetBroadcasts) |
CreateBroadcast полный
Разовая рассылка подписчикам: сейчас или по расписанию. Тратит деньги и внимание аудитории.
| Параметр | Тип | Описание |
|---|---|---|
| text | string | текст (HTML-разметка Telegram); обязателен, если нет mediaFileId |
| mediaFileId | integer | id файла в хранилище бота |
| groupId | integer | id группы; 0 или пусто — всем подписчикам |
| sendAt | string | 'now' или 'YYYY-MM-DD HH:MM' по Москве |
| buttons | array | кнопки: {text, url} либо {text, categoryId} |
GetBroadcasts чтение
Разовые рассылки бота со статусом (запланирована / отправляется / отправлена).
| Параметр | Тип | Описание |
|---|---|---|
| limit | integer | по умолчанию 200, максимум 200 |
| offset | integer |
SendMessage полный
Отправить сообщение конкретным подписчикам или группе. Списывает средства.
| Параметр | Тип | Описание |
|---|---|---|
| users | array | до 1000 id подписчиков |
| group | integer | id группы — альтернатива users |
| message | string | текст сообщения |
| category | integer | id рубрики: вместо текста запустить сценарий |
Переменные
GetVariables чтение
Справочник переменных бота (id, ключ, лимит длины, тип значения).
SetUserVariable изменение
Записать значение переменной подписчику. Если у переменной задан тип (число, дата, телефон, почта, да/нет), значение проверяется и приводится к единому виду — телефон, например, к +7…
| Параметр | Тип | Описание |
|---|---|---|
| user* | integer | id подписчика |
| variable* | integer | id типа переменной (GetVariables) |
| value* | string | значение; проверяется по типу переменной и обрезается по её strlimit |
Балансы
GetBalanceTypes чтение
Типы внутренних балансов бота и курсы обмена.
SetBalanceTypeExchangeRate изменение
Изменить курс обмена типа баланса.
| Параметр | Тип | Описание |
|---|---|---|
| balancetype* | integer | id типа (GetBalanceTypes) |
| exchangerate* | number | новый курс |
SetUserBalance полный
Изменить внутренний баланс подписчика. Движение денег — операция необратимая.
| Параметр | Тип | Описание |
|---|---|---|
| user* | integer | id подписчика |
| balancetype* | integer | id типа баланса |
| amount* | number | сумма: со знаком — изменение, иначе установка |
| comment | string | комментарий в историю операций |
Каналы и ссылки
CreateInviteLink изменение
Создать инвайт-ссылку канала.
| Параметр | Тип | Описание |
|---|---|---|
| channel* | integer | id канала |
| name | string | название ссылки (видно только вам) |
| expire_date | string | срок действия, YYYY-MM-DD |
| member_limit | integer | лимит переходов |
| join_request | boolean | вступление по заявке |
| advercost | string | стоимость размещения (для отчёта по рекламе) |
| description | string | заметка |
DeleteInviteLink полный
Отозвать инвайт-ссылку. Необратимо.
| Параметр | Тип | Описание |
|---|---|---|
| channel* | integer | id канала |
| link* | string | сама ссылка |
EditInviteLink изменение
Изменить инвайт-ссылку.
| Параметр | Тип | Описание |
|---|---|---|
| channel* | integer | id канала |
| link* | string | сама ссылка (GetInviteLinks) |
| name | string | |
| expire_date | string | |
| member_limit | integer | |
| join_request | boolean | |
| advercost | string | |
| description | string |
GetChannels чтение
Каналы и группы, к которым подключён бот.
GetInviteLinks чтение
Инвайт-ссылки канала со статистикой переходов.
| Параметр | Тип | Описание |
|---|---|---|
| channel* | integer | id канала (GetChannels) |
События и структура
GetAccess чтение
Заявки на доступ с даты.
| Параметр | Тип | Описание |
|---|---|---|
| date* | string | с какого момента |
| user | integer | |
| limit | integer | |
| offset | integer |
GetCategories чтение
Структура бота: списки рубрик и рубрики внутри них.
GetSignals чтение
Сигналы (события сценариев) с даты.
| Параметр | Тип | Описание |
|---|---|---|
| date* | string | с какого момента: 'YYYY-MM-DD' или 'YYYY-MM-DD HH:MM:SS' |
| user | integer | только по одному подписчику |
| limit | integer | |
| offset | integer |
GetStorage чтение
Файлы и тексты, присланные подписчиками, с даты.
| Параметр | Тип | Описание |
|---|---|---|
| date* | string | с какого момента |
| user | integer | |
| limit | integer | |
| offset | integer |
SetAccess изменение
Одобрить или отклонить заявку на доступ.
| Параметр | Тип | Описание |
|---|---|---|
| accessid* | integer | id заявки (GetAccess) |
| status* | string | allow | deny |
Бронирование
GetBooking чтение
Одна бронь по id.
| Параметр | Тип | Описание |
|---|---|---|
| booking* | integer | id брони |
GetBookingList чтение
Брони объекта на ближайшие дни.
| Параметр | Тип | Описание |
|---|---|---|
| object* | integer | id объекта |
| days | integer | горизонт в днях: по умолчанию 14, максимум 90 |
GetBookingLots чтение
Свободные слоты объекта по услугам.
| Параметр | Тип | Описание |
|---|---|---|
| object* | integer | id объекта (GetBookingObjects) |
| services | array | id услуг |
| days | integer | горизонт в днях |
| date | string | конкретный день, YYYY-MM-DD |
GetBookingObjects чтение
Объекты бронирования (готовые к записи).
GetBookingServices чтение
Услуги бронирования: длительность и цена.
GetBookingStatusList чтение
Справочник статусов брони.
SetBookingStatus изменение
Изменить статус брони.
| Параметр | Тип | Описание |
|---|---|---|
| booking* | integer | id брони |
| status* | string | ключ статуса (GetBookingStatusList) |
Звёздочкой отмечены обязательные параметры. Поле botId обязательно во всех методах и здесь не повторяется.
Нужен ключ доступа?
Ключи выпускаются в разделе «API, MCP» панели: выберите уровень доступа — чтение, изменение или полный — и скопируйте ключ.