Документация API Test.Botbrother.Ru

API работает с JSON данными, отправляются параметры метода в JSON формате и ответ так же приходит в JSON

Адрес для вызова апи https://test.botbrother.ru/Api.php

Задав через вкладку "Token" ключ API бота(Не токен бота, а именно ключ апи, взять из настроек бота), можно переключаясь по вкладкам, тестировать различные методы API и посмотреть входящие параметры или результат

SendMessage - Отсылает сообщение и возможно переход к категории. Группе пользователей или отдельным пользователям.

GetGroups - Список всех групп бота

GetGroupUsers - Список пользователей указанной группы

GetSignals - Список сигналов от указанной даты. Опционально - по указанному пользователю.

GetStorage - Список записей в хранилище от указанной даты. Опционально - по указанному пользователю.

GetAccess - Список запросов доступа от указанной даты. Опционально - по указанному пользователю.

GetUserProfile - Получить профиль пользователя. Указывается один из параметров поиска: user, login, phone, email.

GetCategories - Получает группы рубрик и входящие в них группы.

SetAccess - Разрешает или запрещает доступ.

GetBotUsers - Получает все id пользователей бота.

GetBalanceTypes - Получает типы балансов бота.

SetUserBalance - Изменяет баланс указанного пользователя.

SetBalanceTypeExchangeRate - Изменяет курс обмена баланса относительно курсов других балансов.

GetChannels - Получает список каналов где бот - управляющий.

GetInviteLinks - Получает список ссылок для выбранного канала.

CreateInviteLink - Создает ссылку в выбранном канале.

EditInviteLink - Редактирует ссылку.

DeleteInviteLink - Удаляет ссылку.

GetBookingObjects - Получение списка объектов бронирования.

GetBookingServices - Получение списка услуг.

GetBookingLots - Получение списка свободных лотов для бронирования.

GetBookingStatusList - Получение возможных статусов брони.

SetBooking - Создание брони.

GetBooking - Получение существующей брони.

SetBookingStatus - Изменить статус брони.

GetBookingList - Получение списка броней.


Пример вызова через curl в php:

$ch = curl_init( 'https://test.botbrother.ru/Api.php' );

$request = [
"token"    => "",
"method"   => "SendMessage",
"users"    => [1],
"group"    => 1,
"category" => 44,
"message"  => "test message"
];

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode($request, JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES|JSON_PRETTY_PRINT));
curl_setopt( $ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$result = curl_exec($ch);
curl_close($ch);
print $result;
$JSON = json_decode($result);
Введите токен апи бота. Находится в настройках бота
Он подставится во все примеры вызова апи в других вкладках


Адрес для вызова апи https://test.botbrother.ru/Api.php


Пример вызова апи:
$ch = curl_init( 'https://test.botbrother.ru/Api.php' );

$request = [
"token"    => "",
"method"   => "SendMessage",
"users"    => [1],
"group"    => 1,
"category" => 44,
"message"  => "test message"
];

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode($request, JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES|JSON_PRETTY_PRINT));
curl_setopt( $ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$result = curl_exec($ch);
curl_close($ch);
print $result;
$JSON = json_decode($result);
Метод SendMessage
Отсылает сообщение и возможно переход к категории. Обязательно users и/или group. Обязательно category и/или message.
Метод GetGroups
Результат: список всех групп бота
Метод GetGroupUsers
Результат: список пользователей указанной группы
Метод GetSignals
Результат: список сигналов от указанной даты. Параметр user опциональный.
Метод GetStorage
Результат: список записей в хранилище от указанной даты. Параметр user опциональный.
Метод GetAccess
Результат: список запросов доступа от указанной даты. Параметр user опциональный.
Метод GetUserProfile
Указывается один из параметров поиска: user, login, phone, email. Если указано несколько параметров то будет использован один из списка по порядку: user, login, phone, email.
Метод GetCategories
Получает группы рубрик и входящие в них группы
Метод SetAccess
Разрешает или запрещает доступ. accessid можно получить из GetAccess
Значения status: "allow", "deny"
Метод GetBotUsers
Получает все id пользователей бота
Метод GetBalanceTypes
Метод SetUserBalance
Укажите amount со знаком минус для уменьшения баланса
Метод SetBalanceTypeExchangeRate
устанавливает курс обмена для выбранного баланса
Метод GetChannels
Получает список каналов где бот является управляющем.
"id" - Идентификатор канала для использования в других методах
Метод GetInviteLinks
Получает список ссылок указанного канала.
Метод GetInviteLink
Получает параметры указанной ссылки.
Метод CreateInviteLink
Создает ссылку в указанном канале.
"member_limit" и "join_request" не могут быть заданны одновременно.
.
.
Метод EditInviteLink
Редактирует ссылку.
"member_limit" и "join_request" не могут быть заданны одновременно.
.
.
Метод DeleteInviteLink
Удаляет ссылку.
.
.
Метод GetBookingObjects
Объекты бронирования
Например для получения Id объекта, для использования в других методах.
.
Метод GetBookingLots
Получение лотов свободных для бронирования. Формат результата немного отличается в зависимости от типа брони, множественная-суточная
Указывается объект бронирования.
Дата для получения лотов.
Сервисы важны только для динамических лотов.
Дни - только для суточных лотов, кол-во дней для получения лотов.
.
Результат:.
id - не для всех типов лотов.
uxstart и uxend - время старта и окончания лота в unixtime, нулевой часовой пояс, тоесть по гринвичу.
Метод GetBookingServices
Все услуги броней в боте
.
.
Метод GetBookingStatusList
Статусы броней, при создании, изменении статуса и в списке созданных броней
.
.
Метод SetBooking
Создание брони.
Указывается объект бронирования, от настроек объекта зависят передаваемые параметры.
lot - ID лота или 0 для множественных броней, динамических броней.
date - в формате YYYY-MM-DD.
services - услуги брони.
user - Id пользователя в боте.
status - статус.
uxstart, uxend - время в unixtime, начало и конец брони, из метода получения лотов бронирования. Нулевой часовой пояс, по гринвичу
lotlist - список лотов для множественного бронирования, множественного бронирования подряд(все id подряд).
datelist - список дат для множественного посуточного бронирования, используются только даты из метода получения лотов, для бронирования подряд - все даты.
Список дат или лотов используется для объекта с настройкой множественного бронирования, только один список из двух. В случае одной даты или одного лота, но с этой настройкой, все равно используется список с одним значением.
.
Результат - id созданной брони или ошибка.
Метод GetBooking
Получение брони по Id
.
.
Метод SetBookingStatus
Изменение статуса брони
.
.
Метод GetBookingList
Получение списка всех броней на указанное кол-во дней days, указанного объекта бронирования object
.
.