TS Api

Начало работы | Общие сведения

Что такое API?

API (от англ. application programming interface – программный интерфейс приложения) – это интерфейс, который дает возможность с помощью специальных команд управлять каким-либо программным обеспечением (приложением, сервисом, программой и т.п.).

Для чего используют API

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

Начало работы | Особенности API

Протокол передачи данных

API поддерживает как HTTP-, так и HTTPS-протоколы.

Формат запросов

В API используются POST- и GET-запросы. Тип запроса указан отдельно для каждого метода.

Авторизация

Все запросы требуют Basic Auth, доступы аналогичны доступам в личный кабинет.

Структура запроса

Используется JSON-формат для отправляемых данных

Формат ответа

Форматом ответа является JSON.

Формат запросов

В API используются POST- и GET-запросы. Тип запроса указан отдельно для каждого метода.

Структура имени URL-запросов

Каждый URL начинается с адреса API (https://tg.bizandsoft.ru/api), за ним следует название метода.

Сообщения | Отправить сообщение

Метод

POST send/message

Описание

Метод позволяет отправить сообщение в подключенные каналы.

Если необходимо отправить сообщение во все каналы бота, то необходимо передать bot_id, поле channel_id в таком случае передавать не требуется.

Если используете шаблон template_id, то поле text передавать не требуется.

Ограничения

Метод доступен в соответствии с правами пользователя.

{
    "status": true,
    "result_code": 200,
    "message": "Success!"
}