Skip to content

green-api/maxbot-api-client-1c

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MAX Bot API SDK для 1С:Предприятие

Версия: 1.1.1 · CHANGELOG

Внешняя обработка для работы с MAX Bot API из 1С:Предприятие 8.x. Разработано компанией GREEN-API.

Возможности

SDK покрывает все методы MAX Bot API:

Область Описание Кол-во
🤖 Бот Информация о боте 1
💬 Чаты Управление групповыми чатами, участниками, админами, закреплёнными сообщениями 15
✉️ Сообщения Получение, отправка, редактирование, удаление 5
🔔 Подписки Webhook: подписка, отписка, список подписок 3
🔄 Обновления Long Polling для получения событий 1
📁 Файлы Загрузка изображений, видео, аудио и документов 2
🎬 Видео Информация о видео 1
⌨️ Callback Ответ на нажатие inline-кнопок 1

Дополнительно:

  • Интерактивная форма тестирования — встроенная форма с полями для каждого метода API, таблицами вложений и выбором типов событий
  • Регистрация в БСП — обработка может быть зарегистрирована как дополнительная обработка в конфигурациях на базе «Библиотеки стандартных подсистем»

Быстрый старт

Требования

Установка

  1. Скопируйте папку maxbotapi в конфигурацию или загрузите готовый файл bin/greenapi_maxbotapi.epf как внешнюю обработку
  2. Задайте реквизит AccessToken — токен вашего бота

Примечание: для конфигураций на базе БСП обработка автоматически регистрируется через СведенияОВнешнейОбработке() с идентификатором GREENAPIMAXBOTAPI.

Примеры использования

// Инициализация
API = ВнешниеОбработки.Создать("GREENAPIMaxBotAPI");
API.AccessToken = "ВАШ_ТОКЕН_БОТА";

// Получение информации о боте
ИнфоБота = API.ПолучитьИнфоБота();
Сообщить("Имя бота: " + ИнфоБота.first_name);

// Отправка сообщения в чат
Ответ = API.ОтправитьСообщение("Привет от 1С!", 12345);

// Отправка сообщения пользователю
Ответ = API.ОтправитьСообщение("Личное сообщение",, 67890);

// Отправка с форматированием Markdown
Ответ = API.ОтправитьСообщение("**Жирный** и _курсив_", 12345,,,,, "markdown");

// Отправка с inline-клавиатурой
Кнопка = Новый Структура;
Кнопка.Вставить("type", "callback");
Кнопка.Вставить("text", "Нажми меня!");
Кнопка.Вставить("payload", "button1");

Ряд = Новый Массив;
Ряд.Добавить(Кнопка);

Кнопки = Новый Массив;
Кнопки.Добавить(Ряд);

Клавиатура = Новый Структура;
Клавиатура.Вставить("type", "inline_keyboard");
КлавиатураPayload = Новый Структура;
КлавиатураPayload.Вставить("buttons", Кнопки);
Клавиатура.Вставить("payload", КлавиатураPayload);

Вложения = Новый Массив;
Вложения.Добавить(Клавиатура);

Ответ = API.ОтправитьСообщение("Выберите действие:", 12345,,Вложения);

// Long Polling — получение обновлений
Маркер = Неопределено;
Пока Истина Цикл
    Обновления = API.ПолучитьОбновленияLP(100, 30, Маркер);
    Маркер = Обновления.marker;
    Для каждого Событие Из Обновления.updates Цикл
        // Обработка события
        Сообщить("Тип: " + Событие.update_type);
    КонецЦикла;
КонецЦикла;

// Загрузка файла
ИнфоЗагрузки = API.ПолучитьURLЗагрузки("image");
Ответ = API.ЗагрузитьФайл(ИнфоЗагрузки.url, "C:\photo.jpg");
// Ответ — Соответствие с вложенной структурой:
// {"photos": {"<хеш>": {"token": "<токен_вложения>"}}}

Справочник методов

Бот

Метод Описание
ПолучитьИнфоБота() Информация о боте (user_id, name, username и др.)

Чаты

Метод Описание
ПолучитьСписокЧатов(Количество, Маркер) Список всех групповых чатов
ПолучитьИнфоЧата(ИдЧата) Информация о групповом чате
ИзменитьЧат(ИдЧата, Параметры) Изменение чата (title, icon, pin)
УдалитьЧат(ИдЧата) Удаление группового чата
ОтправитьДействиеВЧат(ИдЧата, Действие) Действие бота (typing_on, mark_seen и др.)
ПолучитьЗакрепленноеСообщение(ИдЧата) Закреплённое сообщение
ЗакрепитьСообщение(ИдЧата, ИдСообщения, Уведомлять) Закрепить сообщение
ОткрепитьСообщение(ИдЧата) Открепить сообщение
ПолучитьЧленствоБота(ИдЧата) Членство бота в чате
УдалитьБотаИзЧата(ИдЧата) Выход бота из чата
ПолучитьАдминовЧата(ИдЧата) Список администраторов
НазначитьАдмина(ИдЧата, ИдПользователя) Назначить администратора
СнятьАдмина(ИдЧата, ИдПользователя) Снять администратора
ПолучитьУчастниковЧата(ИдЧата, Количество, Маркер) Список участников
ДобавитьУчастниковВЧат(ИдЧата, ИдПользователей) Добавить участников
УдалитьУчастникаИзЧата(ИдЧата, ИдПользователя, Блок) Удалить участника (с возможной блокировкой)

Сообщения

Метод Описание
ПолучитьСообщения(ИдЧата, ИдСообщений, ДатаС, ДатаПо, Количество) Получение сообщений
ОтправитьСообщение(Текст, ИдЧата, ИдПользователя, Вложения, Ссылка, Уведомлять, Формат, ОтключитьПревью) Отправка сообщения
РедактироватьСообщение(ИдСообщения, Текст, Вложения, Ссылка, Уведомлять, Формат) Редактирование
УдалитьСообщение(ИдСообщения) Удаление сообщения
ПолучитьСообщениеПоИд(ИдСообщения) Получение по ID

Подписки (Webhooks)

Метод Описание
ПолучитьПодписки() Список подписок
Подписаться(URLВебхука, ТипыОбновлений, Секрет) Создание подписки
Отписаться(URLВебхука) Удаление подписки

Обновления (Long Polling)

Метод Описание
ПолучитьОбновленияLP(Лимит, Таймаут, Маркер, ТипыОбновлений) Получение обновлений

Загрузка файлов

Метод Описание
ПолучитьURLЗагрузки(ТипФайла) URL для загрузки (image/video/audio/file)
ЗагрузитьФайл(URLЗагрузки, ПутьКФайлу) Загрузка файла на сервер (⚠️ возвращает Соответствие)

Видео

Метод Описание
ПолучитьИнфоВидео(ТокенВидео) Информация о видео

Callback-ответы

Метод Описание
ОтветитьНаCallback(ИдCallback, Сообщение, Уведомление) Ответ на нажатие inline-кнопки

Интерактивная форма тестирования

Обработка включает встроенную форму для тестирования всех методов API без написания кода:

  • Авторизация — при вводе токена автоматически загружается информация о боте и аватар
  • Чаты — интерфейс для работы со всеми методами чатов, включая управление участниками и администраторами
  • Сообщения — отправка с поддержкой вложений (таблица type/url/token), форматирования (Markdown/HTML) и ответов на сообщения
  • Медиа — загрузка файлов через диалог выбора, информация о видео
  • Подписки — управление вебхуками с выбором типов событий из списка
  • Обновления — Long Polling с настройками лимита, таймаута и фильтрации по типам событий
  • Ссылки на документацию — каждый метод в форме содержит гиперссылку на соответствующую страницу документации MAX API
  • JSON-вывод — все ответы API отображаются в форматированном JSON

Авторизация

Все запросы к API авторизуются через HTTP-заголовок:

Authorization: <ваш_токен>

Токен задаётся реквизитом AccessToken обработки.

Ограничения API

  • Максимум 30 запросов в секунду к platform-api.max.ru
  • Текст сообщения — до 4000 символов
  • Клавиатура — до 210 кнопок (30 рядов × 7 кнопок)
  • Описание бота — до 16000 символов

Ссылки

Разработчик

Проект разработан компанией GREEN-API — провайдером решений для интеграции мессенджеров.

Лицензия

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors