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

Метод subscribe

Этот метод добавляет контакты (e-mail адрес и/или мобильный телефон) подписчика в один или несколько списков, а также позволяет добавить/поменять значения дополнительных полей и меток.

По умолчанию, на e-mail подписчика отправляется письмо с просьбой подтвердить подписку, но если Вы уже проверили существование адреса самостоятельно, то можете отключить это с помощью установки параметра double_optin=1.

Количество добавлений подписчиков без подтверждения e-mail ограничено:

• не более 20 в сутки без указания IP-адресов,
• не более 30 с указанием адреса и времени запроса
• не более 50 в с указанием IP-адресов и времён запроса и подтверждения

В случае превышения лимита подписчик не переводится в статус «активный», а в зависимости от значения параметра double_optin подписчик либо получит статус «новый», либо ему будет отправлено письмо с просьбой подтвердить подписку и он получит статус «запрошено подтверждение», либо будет возвращено сообщение об ошибке (подробнее о статусах).

При наличии продолжительной истории работы мы может существенно увеличить лимиты. Просьба связаться с нами для изменения лимитов.

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

list_ids=123456
list_ids=123456,345678,2344423

fields[NAME1]=VALUE1&fields[NAME2]=VALUE2

fields[email]=test@example.org
fields[email]=test@example.org&fields[Name]=UserName

{"result":{"person_id":139709428}}

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

• unsubscribe
• exclude
• importContacts
• activateContacts

Примеры формирования URL-запроса

http://api.unisender.com/ru/api/subscribe?format=json&api_key=KEY&list_ids=555777
&fields[email]=test@example.org&fields[Name]=John+Doe

http://api.unisender.com/ru/api/subscribe?format=json&api_key=KEY&list_ids=555777
&fields[email]=test@example.org&fields[Name]=John+Doe
&double_optin=1&request_ip=22.33.44.55&tags=RedRoseCustomer

Примеры на PHP

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

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

// Данные о новом подписчике
$user_email = "new@aol.de";
$user_name = iconv('cp1251', 'utf-8', "Василий Иванович Чапаев");
$user_lists = "354168";
$user_ip = "12.34.56.78";
$user_tag = urlencode("Added using API");

// Создаём POST-запрос
$POST = array (
  'api_key' => $api_key,
  'list_ids' => $user_lists,
  'fields[email]' => $user_email,
  'fields[Name]' => $user_name,
  'request_ip' => $user_ip,
  'tags' => $user_tag
);

// Устанавливаем соединение
$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/subscribe?format=json');
$result = curl_exec($ch);

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 "Added. ID is " . $jsonObj->result->person_id;

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

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

// Данные о новом подписчике
// Если скрипт в кодировке UTF-8, то удалите вызов iconv
$user_email = "new@aol.com";
$user_name = urlencode(iconv('cp1251', 'utf-8', "Василий Иванович"));
$user_lists = "354168";
$user_ip = "12.34.56.78";
$user_tag = urlencode("Added using API");

// Создаём GET-запрос
$api_url = "http://api.unisender.com/ru/api/subscribe?format=json".
           "&api_key=$api_key&list_ids=$user_lists".
           "&fields[email]=$user_email&fields[Name]=$user_name".
           "&request_ip=$user_ip&tags=$user_tag";

// Делаем запрос на 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 "Added. ID is " . $jsonObj->result->person_id;

  }

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