ReferenceCampaigns API
Предпросмотр рассылки
GET
Считает получателей и сколько из них вне окна 24 часа. tierDailyLimit — лимит канала. Цена и стоимость не возвращаются. Ничего не отправляется.
bearerheader
AuthorizationBearer <API key>Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.
campaignId*stringid рассылки из ответа на создание или из списка.
application/json- response
campaignId*stringid рассылки.
segmentId*stringid сегмента-аудитории.
contentMode*stringЧто отправляет рассылка: шаблон или текст сессии.
Value in
"template""text"recipientCount*numberУчастники сегмента.
closedWindowCount*numberУчастники вне окна 24 часа.
tierDailyLimit*|Сколько отправок шаблонов этот канал может начать за скользящие 24 часа. Берётся из лимита канала, а не из поля, которое вы задаёте. null, если лимит неизвестен или его нет.
exceedsTierDailyLimit*booleantrue, если отправка шаблонов превысит лимит канала.
warnings*array<>Предупреждения предпросмотра. Ничего не отправляется.
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/preview'Example Response200
{ "campaignId": "cm3campaign01", "segmentId": "cm3segment01", "contentMode": "template", "recipientCount": 12, "closedWindowCount": 3, "tierDailyLimit": 1000, "exceedsTierDailyLimit": false, "warnings": [ { "code": "closed_window_skipped", "message": "Closed-window recipients will be skipped." } ]}