меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод getCampaignStatus

Узнать статус рассылки, созданной методом createCampaign.

Принцип использования

Синтаксис и URL для вызова метода
getCampaignStatus (int campaign_id)
https://api.unisender.com/ru/api/getCampaignStatus?format=json&api_key=KEY&campaign_id=ID
Аргументы
api_key * Ключ доступа к API.
campaign_id * Код рассылки, полученный методом createCampaign.
Возвращаемое значение
JSON-объект со следующими полями:
status Статус рассылки. Возможные варианты:

  • waits_censor — рассылка ожидает проверки.
  • censor_hold — фактически эквивалентна waits_censor: рассмотрена администратором, но отложена для дальнейшей проверки.
  • declined — рассылка отклонена администратором.
  • waits_schedule — задание на постановку рассылки в очередь получено и рассылка ждёт постановки в очередь. Обычно рассылка в этом состоянии находится одну-две минуты перед тем, как перейти в состояние scheduled.
  • scheduled — рассылка запланирована к запуску. Как только настанет время отправки, она будет запущена.
  • in_progress — рассылка выполняется.
  • analysed — все сообщения отправлены, идёт анализ результатов.
  • completed — все сообщения отправлены и анализ результатов закончен.
  • stopped — рассылка поставлена «на паузу».
  • canceled — рассылка отменена (обычно из-за нехватки денег или по желанию пользователя).
creation_time Дата и время создания рассылки в формате «ГГГГ-ММ-ДД чч:мм:сс», в часовом поясе UTC.
start_time Дата и время запуска рассылки в формате «ГГГГ-ММ-ДД чч:мм:сс», в часовом поясе UTC.
Если были ошибки или предупреждения, они возвращаются в полях error/warnings в соответствии с описанием. Пример ответа:

{
  "result":{
  	"status":"completed",
  	"creation_time":"2011-09-21 19:47:31",
  	"start_time":"2011-09-21 20:00:00"
  	}
}