• Главная
• Ресурсы
• Документация
• API
• createCampaign

Метод createCampaign

Запланировать или начать немедленно рассылку e-mail или SMS-сообщения. Одно и то же сообщение можно отправлять несколько раз, но моменты отправки не должны быть ближе, чем на час друг к другу.

Этот метод используется для отправки уже созданных сообщений. Для предварительного создания сообщений надо использовать методы createEmailMessage и createSmsMessage

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

{"result":{"campaign_id":932188,"status":"scheduled","count":134}}

Технические ограничения

Обычное время ответа для createCampaign с параметром defer=1 составляет около секунды. Таймаут на вызов с defer=1 составляет 15 секунд с момента полной передачи запроса.

Время выполнения запроса с параметром defer=0 пропорционально количеству контактов, таймаут для рассылок до 50,000 адресов составляет 30 секунд, при большем количестве увеличивается – поэтому не рекомендуется использовать defer=0 для больших рассылок.

В случае неполучения ответа по истечении таймаута рекомендуется максимум два раза попытаться повторить запрос. Если повторный запрос заканчивается сообщением об ошибке с кодом 'campaign_already_exists' – значит, одна из предыдущих попыток всё-таки сработала, хотя и с запозданием. Если же повторные попытки опять приводят к таймауту – нужно обращаться в техподдержку.

Смотрите также

• createEmailMessage
• createSmsMessage
• getCampaignDeliveryStats
• getCampaignStatus

Примеры на PHP

Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Подробнее о методах соединения здесь.

// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxx";

// Параметры для отправки сообщения
$email_id = "361988";

// Запланируем отправку на определённое время
// (закомментируйте, чтобы отправить немедленно)
// $email_starttime = urlencode("2012-12-20 14:40");

// Параметры сбора статистики
// Если 1, собираем, если 0 - нет
$email_stats_links = "1";
$email_stats_read = "1";

// Создаём POST-запрос
$POST = array (
  'api_key' => $api_key,
  'message_id' => $email_id,
  'start_time' => $email_starttime,
  'track_read' => $email_stats_read,
  'track_links' => $email_stats_links
);

// Устанавливаем соединение
$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_URL,
            'http://api.unisender.com/ru/api/createCampaign?format=json');
$result = curl_exec($ch);

echo $result;

if ($result) {
  // Раскодируем ответ API-сервера
  $jsonObj = json_decode($result);

  if(null===$jsonObj) {
    // Ошибка в полученном ответе
    echo "Invalid JSON";

  }
  elseif(!empty($jsonObj->error)) {
    // Ошибка отправки сообщения
    echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";

  } else {
    // Рассылка успешно отправлена (или запланирована к отправке)
    echo "Success. Newsletter delivery status is " . $jsonObj->result->status;

  }
} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}

// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxxx";

// Параметры для отправки сообщения
$email_id = "361988";

// Запланируем отправку на определённое время
// (закомментируйте, чтобы отправить немедленно)
$email_starttime = urlencode("2012-12-20 14:40");

// Параметры сбора статистики
// Если 1, собираем, если 0 - нет
$email_stats_links = "1";
$email_stats_read = "1";

// Создаём GET-запрос
$api_url = "http://api.unisender.com/ru/api/createCampaign?format=json".
           "&api_key=$api_key&message_id=$email_id".
           "&start_time=$email_starttime&track_read=$email_stats_read".
           "&track_links=$email_stats_links";

// Делаем запрос на API-сервер
$result = file_get_contents($api_url);

if ($result) {
  // Раскодируем ответ API-сервера
  $jsonObj = json_decode($result);

  if(null===$jsonObj) {
    // Ошибка в полученном ответе
    echo "Invalid JSON";

  }
  elseif(!empty($jsonObj->error)) {
    // Ошибка отправки сообщения
    echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";

  } else {
    // Рассылка успешно отправлена (или запланирована к отправке)
    echo "Success. Newsletter delivery status is " . $jsonObj->result->status;
  }

} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}