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

Метод importContacts

Метод массового импорта подписчиков. Может использоваться также для периодической синхронизации с базой подписчиков, хранящейся на вашем собственном сервере (см. также описание метода exportContacts). Импортировать можно данные не более 500 подписчиков за вызов. Списки большего размера надо импортировать за несколько вызовов (данное ограничение связано с ораничениями POST-запроса).

Если среди подписываемых e-mail адресов есть новые, то по умолчанию они получают статус "новый" и их можно позже активировать через веб-интерфейс или методом activateContacts. Часть адресов можно активировать сразу во время импорта (см. описание аргумента double_optin).

Технические ограничения: максимальное количество пользовательских полей равно 50. Таймаут на один вызов составляет 30 секунд с момента полной передачи запроса на сервер. Если по истечении таймаута ответ не получен, то рекомендуется сделать до двух повторных попыток, и если ответа снова нет, тогда обращаться в техническую поддержку.

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

field_names[0]=email&field_names[1]=email_list_ids&
data[0][0]=a@example.com&data[0][1]=123&data[1][0]=b@example.org

{
  "result":{
    "total":4, "inserted":2, "updated":1, "deleted":2, "new_emails":1,
    "log":[
      {"index":0,"code":"e_email_invalid", 
       "message":"Неправильный формат e-mail"},
      {"index":2,"code":"e_phone_not_unique", 
       "message":"Повторно встретившийся телефон"}
    ]
  }
}

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

• subscribe
• exportContacts
• activateContacts

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

http://api.unisender.com/ru/api/importContacts?format=json&api_key=KEY&
field_names[0]=email&field_names[1]=Name&field_names[2]=email_list_ids&
data[0][0]=1@example.com&data[0][1]=Anna&data[0][2]=778899&
data[1][0]=2@example.com&data[1][1]=Kate&data[1][2]=778899&
data[2][0]=3@example.com&data[2][1]=John&data[2][2]=778899&
data[3][0]=4@example.com&data[3][1]=Mike&data[3][2]=778899&
data[4][0]=5@example.com&data[4][1]=Bill&data[4][2]=778899

— добавить 5 новых подписчиков с адресами 1 .. 5@example.org и именами Anna, Kate, John, Mike и Bill в список с кодом 778899. Стоит заметить, что запросы правильнее делать через POST, так как в GET-запросе допустимая длина запроса существенно меньше.

Пример на PHP

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

Более того, так как в данном методе возможная передача больших массивов данных, то метод GET будет категорически неприемлем из-за своего небольшого лимита на длину запроса.

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

// Новые подписчики
$new_emails = array ('1@example.org', '2@example.org', '3@example.org',
                     '4@example.org', '5@example.org');
$new_names = array ('Аня', 'Женя', 'Лев', 'Иван', 'Ира');

// Список, куда их добавить
$list = "234234";

// Создаём POST-запрос
$POST = array (
  'api_key' => $api_key,
  'field_names[0]' => 'email',
  'field_names[1]' => 'Name',
  'field_names[21]' => 'email_list_ids'
);
for ($i=0;$i<5;$i++){
  $POST['data[' . $i .'][0]'] = $new_emails[$i];
  $POST['data[' . $i .'][1]'] = iconv('cp1251', 'utf-8', $new_names[$i]);
  $POST['data[' . $i .'][2]'] = $list;
}

// Устанавливаем соединение
$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/importContacts?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 "Success! Added " . $jsonObj->result->new_emails . " new e-mail addresses";

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