Обзор API «Мой диалог»

Коротко: «Мой диалог» предоставляет доступ к трём группам API — OMNI API для отправки сообщений, Broadcasts API для рассылок и Recipients API для управления получателями.

Кому подходит

Роль: Разработчик, Интегратор
Уровень: Опытный

Что такое API «Мой диалог»

Через API «Мой диалог» можно:

Отправлять одиночные сообщения по всем каналам.
Запускать каскадную отправку с автоматическим переключением между каналами.
Управлять рассылками и их шаблонами.
Работать с получателями: контактами, атрибутами, фильтрами, тегами.
Получать баланс, список каналов, имена отправителей, EDR-записи.
Работать с шаблонами сообщений и WhatsApp.
Отправлять и отзывать верификационные сообщения Telegram Gateway.

Базовый URL

https://web.mydialogi.ru/api/v1

Аутентификация

Заголовок X-API-Key с вашим API-ключом в каждом запросе.

Как получить ключ: API-ключи.

При создании ключа вы выбираете имена отправителей. От выбранных имён зависит, по каким каналам сможет отправлять ключ.

Три группы API

API	Что делает	Доступен в «Мой диалог»
OMNI API	Отправка сообщений, работа с балансом, каналами, EDR, шаблонами	✅
Broadcasts API	Запуск рассылок, управление шаблонами рассылок	✅
Recipients API	Управление контактами, атрибутами, фильтрами, тегами	✅

Recipients API доступен только в сервисе «Мой диалог». В OTP-кодах и 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}`	Удалить шаблон рассылки

Recipients API — эндпоинты

Метод	Эндпоинт	Для чего
GET	`/recipient/recipients`	Список получателей
POST	`/recipient/recipients`	Создать получателя
PUT	`/recipient/recipients`	Обновить получателя
DELETE	`/recipient/recipients`	Удалить получателя
GET	`/recipient/attributes`	Список атрибутов
POST	`/recipient/attributes`	Создать атрибут
PUT	`/recipient/attributes/{id}`	Обновить атрибут
DELETE	`/recipient/attributes/{id}`	Удалить атрибут
GET	`/recipient/attributes/types`	Типы атрибутов
GET	`/recipient/filters`	Список фильтров (таргетов)
GET	`/recipient/tags`	Список тегов

Swagger UI

OMNI API: https://web.mydialogi.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API
Broadcasts API: https://web.mydialogi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API
Recipients API: https://web.mydialogi.ru/api/v1/swagger-ui/index.html?urls.primaryName=Recipients_API

Что дальше

Подключение к API

Аутентификация, базовый URL, формат запросов

OMNI API

Отправка сообщений и шаблонов, каскад

Broadcasts API

Запуск рассылок, шаблоны рассылок

Recipients API

Контакты, атрибуты, фильтры, теги

Нужна помощь?

Мой диалог: support@mydialogi.ru