Карта интеграции Multi API
Что вызывать и в каком порядке — эндпоинты OMNI API, Broadcasts API и справочные методы по задачам интеграции
Коротко: карта интеграции Multi API — какая задача каким эндпоинтом решается. Для тех, кто уже отправил первое сообщение и строит интеграцию дальше.
Кому подходит
- Роль: Разработчик, Интегратор
- Уровень: Опытный
Что это
Карта интеграции — навигация по API Multi API по задачам. Не описание эндпоинтов (оно — в API-обзорах), а указатель: «вот задача — вот эндпоинт — вот где читать».
Если вы ещё не отправили первое сообщение — начните с быстрого старта.
Отправка сообщений
| Задача | Эндпоинт | Где читать |
|---|---|---|
| Отправить одно сообщение | POST /messages | OMNI API |
| Отправить каскад | POST /omnimessages | OMNI API · Настройка каскада |
| Отправить по шаблону | POST /messages с template | OMNI API · Шаблоны |
| Отозвать верификационное сообщение Telegram Gateway | POST /messages/revoke | Справочные эндпоинты |
| Проверить статус верификации Telegram Gateway | POST /messages/verification | Справочные эндпоинты |
Статусы
| Задача | Эндпоинт | Где читать |
|---|---|---|
| Получить статусы (pull) | GET /edrs | Статусы сообщений |
| Получать статусы в реальном времени (push) | Вебхук | Вебхуки |
| Получить статус рассылки | Вебхук, указанный при запуске | Broadcasts API |
Рассылки
| Задача | Эндпоинт | Где читать |
|---|---|---|
| Запустить рассылку | POST /broadcast/broadcasts | Broadcasts API |
| Получить список шаблонов рассылок | GET /broadcast/templates | Broadcasts API |
| Создать шаблон рассылки | POST /broadcast/templates | Broadcasts API |
| Получить детали шаблона | GET /broadcast/templates/{id} | Broadcasts API |
| Обновить шаблон | PUT /broadcast/templates/{id} | Broadcasts API |
| Удалить шаблон | DELETE /broadcast/templates/{id} | Broadcasts API |
Шаблоны сообщений
| Задача | Эндпоинт | Где читать |
|---|---|---|
| Получить список шаблонов сообщений | GET /templates | Справочные эндпоинты · Шаблоны |
| Получить список шаблонов WhatsApp | GET /wa_templates | Справочные эндпоинты · Шаблоны WhatsApp |
Справочные данные
| Задача | Эндпоинт | Где читать |
|---|---|---|
| Получить список каналов | GET /channels | Справочные эндпоинты |
| Получить список имён отправителей | GET /senders | Справочные эндпоинты |
| Получить баланс | GET /balance | Справочные эндпоинты |
Умные сервисы
| Задача | Способ | Где читать |
|---|---|---|
| HLR, MNP, IMSI через каналы или API | Подключение через поддержку | Умные сервисы в Multi API |
| AMD (только через каналы TTS/FlashCall) | Подключение через поддержку | AMD |
См. также
Нужна помощь?
- Multi API: support@multiapi.ru