Skip to Content
1MSG
ReferenceCampaigns API

Предпросмотр рассылки

GET
/api/v1/campaigns/{campaignId}/preview

Считает получателей и сколько из них вне окна 24 часа. tierDailyLimit — лимит канала. Цена и стоимость не возвращаются. Ничего не отправляется.

Authorization

bearer
headerAuthorizationBearer <API key>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Path Parameters

campaignId*string

id рассылки из ответа на создание или из списка.

Response Body

application/json
  1. response
campaignId*string

id рассылки.

segmentId*string

id сегмента-аудитории.

contentMode*string

Что отправляет рассылка: шаблон или текст сессии.

Value in"template""text"
recipientCount*number

Участники сегмента.

closedWindowCount*number

Участники вне окна 24 часа.

tierDailyLimit*|

Сколько отправок шаблонов этот канал может начать за скользящие 24 часа. Берётся из лимита канала, а не из поля, которое вы задаёте. null, если лимит неизвестен или его нет.

exceedsTierDailyLimit*boolean

true, если отправка шаблонов превысит лимит канала.

warnings*array<>

Предупреждения предпросмотра. Ничего не отправляется.

Example Request
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."    }  ]}