API для Multi API
API Multi API — эндпоинты для отправки сообщений, рассылок, получателей
API для Multi API
Коротко: API Multi API позволяет отправлять сообщения по всем каналам, работать с рассылками и получателями. Три группы эндпоинтов.
Кому подходит
- Роль: Разработчик
- Уровень: Опытный
Базовый URL
https://web.multiapi.ru/api/v1
Аутентификация
Заголовок X-API-Key с вашим ключом. Как получить ключ: API-ключи.
Три группы API
OMNI API
Отправка сообщений через единый API.
| Эндпоинт | Метод | Для чего |
|---|---|---|
| /messages | POST | Отправка одного сообщения |
| /omnimessages | POST | Каскадная отправка |
| /balance | GET | Баланс компании |
| /channels | GET | Список каналов |
| /edrs | GET | Записи о доставке |
| /senders | GET | Список имён отправителей |
| /templates | GET | Шаблоны сообщений |
| /wa_templates | GET | Шаблоны WhatsApp |
Broadcasts API
Управление рассылками.
| Эндпоинт | Метод | Для чего |
|---|---|---|
| /broadcasts | GET / POST | Список / создание рассылок |
Recipients API
Управление получателями.
| Эндпоинт | Метод | Для чего |
|---|---|---|
| /recipients | GET / POST | Список / создание получателей |
Формат запросов
Все запросы — POST или GET с заголовками:
- Content-Type: application/json
- X-API-Key: ваш-ключ
Пример отправки сообщения
Эндпоинт: POST /messages
Параметры в теле:
- contact — номер получателя
- channel — номер канала (1 = SMS, 2 = RCS, 4 = WhatsApp и так далее)
- senderId — имя отправителя
- payload — содержимое сообщения
- webhook — URL для статусов (необязательно)
Ссылки на 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
- Recipients API: https://web.multiapi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Recipients_API
См. также
Нужна помощь?
- Multi API: support@multiapi.ru