Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод deleteList

Метод для удаления списка.

Внимание: будут утеряны данные о дате и вермени подписки адресатов на этот список. Те адресаты, которые состояли только в этом списке, и более ни в каких других, после удаления будут отображаться в разделе «вне списков» в веб-интерфейсе.

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

Синтаксис и URL для вызова метода
deleteList (int list_id)
https://api.unisender.com/ru/api/deleteList?format=json&api_key=KEY&list_id=ID
Аргументы
api_key * Ключ доступа к API
list_id * Код списка, полученный методом getLists или createList.
Возвращаемое значение
Пустой объект JSONЕсли были ошибки или предупреждения, они возвращаются в полях error/warnings в соответствии с описанием.

Примеры на PHP

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

Пример с использованием POST-запроса

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

// Код списка для удаления
$list_id = "123456";

// Создаём POST-запрос
$POST = array (
  'api_key' => $api_key,
  'list_id' => $list_id
);

// Устанавливаем соединение
$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, 
            'https://api.unisender.com/ru/api/deleteList?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 "The list successfully deleted.";
  }
} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}

Пример с использованием GET-запроса

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

// Код списка для удаления
$list_id = "123456";

// Создаём GET-запрос
$api_url = "https://api.unisender.com/ru/api/deleteList?format=json".
           "&api_key=$api_key&list_id=$list_id";

// Устанавливаем соединение
$handle = fopen($api_url, "r");

if ($handle) {
  $result = fgets($handle, 4096);
  fclose($handle);

  // Раскодируем ответ 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 "The list successfully deleted.";
  }

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