Сообщения и уведомления
Обновлено: 2026-06-24 17:30 MSK
Это страница-указатель по исходящим коммуникациям с гостями: рассылкам, триггерным сообщениям и шаблонам. В типичной интеграции партнёру обычно не нужно отправлять сообщения вручную — большинство уведомлений гостю (подтверждение брони, напоминание, изменение статуса) срабатывают автоматически как реакция на события брони, по правилам, настроенным в ресторане.
Если же нужна точечная работа с рассылками или шаблонами — ниже основные группы эндпоинтов с примерами. Все запросы — под Bearer-токеном (см. Аутентификация).
Входящие сообщения, статусы доставки в реальном времени и сами каналы связи (SMS, WhatsApp, Telegram, Email) — это отдельный сервис Chat API на другом хосте. В данную документацию он не входит. Здесь описаны только исходящие рассылки, триггеры и шаблоны Host Panel API.
Рассылки (Mailing)
Создание и отправка рассылок по сегменту гостей. Базовый путь: /api/restaurants/{restaurantId}/mailings.
| Метод | Путь | Назначение |
|---|---|---|
GET | /mailings | Список рассылок (параметры Page, PageSize, MailingStatus) |
POST | /mailings | Создать рассылку (тело AddMailingContract) |
POST | /mailings/{mailingId}/start | Запустить рассылку |
GET | /mailings/segments | Размер сегмента и предпросмотр получателей |
У рассылки указываются channels (например email, sms, whatsApp), segment (фильтр аудитории: визиты, теги, средний чек и т.п.) и контент по каналам (smsText, whatsAppText, pushTitle/pushText, emailTemplate). После создания рассылку можно протестировать (/test), запустить (/start) или отменить (/cancel).
curl https://api.hostmeapp.com/api/restaurants/123/mailings \ -H "Authorization: Bearer $TOKEN" \ --data-urlencode "Page=1" \ --data-urlencode "PageSize=20" \ -G
Триггеры (MailingTrigger)
Триггерные рассылки отправляются автоматически по событию (например, после визита или при определённом статусе брони). Базовый путь: /api/restaurants/{restaurantId}/mailings/triggers.
| Метод | Путь | Назначение |
|---|---|---|
GET | /mailings/triggers | Все триггерные рассылки |
POST | /mailings/triggers | Создать триггерную рассылку с контентом за один запрос |
POST | /mailings/{mailingId}/trigger | Настроить условие срабатывания (тело TriggerFilter) |
POST | /mailings/triggers/{triggerMailingId}/activate | Активировать триггер |
Условие срабатывания (TriggerFilter) задаётся полями triggerType, dateMode, days, bookingStatuses, tags, delayMinutes, sendTimeLocal — то есть привязывается к статусам брони, тегам гостя и задержке/времени отправки.
Шаблоны сообщений (MessageTemplates)
Шаблоны текста по каналам и языкам. Базовый путь: /api/msg/restaurants/{restaurantId}/templates.
| Метод | Путь | Назначение |
|---|---|---|
GET | /templates/folders | Список папок шаблонов |
GET | /templates/names | Имена шаблонов (параметр folder) |
GET | /templates | Получить шаблон (параметры name, lng) |
PUT | /templates | Сохранить шаблон |
Шаблон (MessageTemplateContract) содержит name, displayName, subject, header, content, footer, smsText, waText, pushTitle, language и тип (templateType).
curl https://api.hostmeapp.com/api/msg/restaurants/123/templates \ -H "Authorization: Bearer $TOKEN" \ --data-urlencode "name=reservation_confirmed" \ --data-urlencode "lng=ru" \ -G
Возможные ошибки — ProblemDetails, коды 400/401/403/404. Общие правила см. в Соглашениях и разделе Ошибки.