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

Метод deleteMessage

Метод для удаления сообщения.

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

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

Примеры возвращаемых значений:

{"result":{}}
{"error":"message not found","code":"unspecified","result":""}

Примеры на PHP

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

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

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

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

// Создаём POST-запрос
$POST = array (
  'api_key' => $api_key,
  'message_id' => $message_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/deleteMessage');
$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 message successfully deleted.";
  }
} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}

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

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

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

// Создаём GET-запрос
$api_url = "https://api.unisender.com/ru/api/deleteMessage?".
           "api_key=$api_key&message_id=$message_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 message successfully deleted.";
  }

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