Обзор API Multi API
API Multi API — OMNI API и Broadcasts API. Эндпоинты, базовый URL, аутентификация, Swagger UI
Коротко: Multi API предоставляет доступ к двум группам API — OMNI API для отправки сообщений и Broadcasts API для рассылок. API единое с двумя другими сервисами платформы.
Кому подходит
- Роль: Разработчик, Интегратор
- Уровень: Опытный
Что такое API Multi API
Через API Multi API можно:
- Отправлять одиночные и массовые сообщения по всем каналам.
- Запускать каскадную отправку с автоматическим переключением между каналами.
- Управлять рассылками и их шаблонами.
- Получать баланс, список каналов, имена отправителей, EDR-записи.
- Работать с шаблонами сообщений и WhatsApp.
Базовый URL
https://web.multiapi.ru/api/v1
Аутентификация
Заголовок X-API-Key с вашим API-ключом в каждом запросе.
Как получить ключ: API-ключи.
При создании ключа вы выбираете имена отправителей. От выбранных имён зависит, по каким каналам сможет отправлять ключ.
Две группы API
| API | Что делает | Доступен в Multi API |
|---|---|---|
| OMNI API | Отправка сообщений, работа с балансом, каналами, EDR, шаблонами | ✅ |
| Broadcasts API | Запуск рассылок, управление шаблонами рассылок | ✅ |
| Recipients API | Управление контактами, атрибутами, фильтрами, тегами | ❌ |
Recipients API в Multi API недоступен. Для работы с получателями используйте интерфейс Мой диалог.
OMNI API — эндпоинты
| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | /messages | Отправка одного сообщения |
| POST | /omnimessages | Каскадная отправка |
| POST | /messages/revoke | Отозвать верификационное сообщение Telegram Gateway |
| POST | /messages/verification | Проверить статус верификации Telegram Gateway |
| GET | /balance | Баланс компании |
| GET | /channels | Список каналов, доступных компании |
| GET | /edrs | Записи о доставке сообщений |
| GET | /senders | Список имён отправителей компании |
| GET | /templates | Список шаблонов сообщений |
| GET | /wa_templates | Список шаблонов WhatsApp |
Broadcasts API — эндпоинты
| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | /broadcast/broadcasts | Запуск рассылки |
| GET | /broadcast/templates | Список шаблонов рассылок |
| POST | /broadcast/templates | Создать шаблон рассылки |
| GET | /broadcast/templates/{id} | Детали шаблона рассылки |
| PUT | /broadcast/templates/{id} | Обновить шаблон рассылки |
| DELETE | /broadcast/templates/{id} | Удалить шаблон рассылки |
Swagger UI
- OMNI API: https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API
- Broadcasts API: https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API
Что дальше
Нужна помощь?
- Multi API: support@multiapi.ru