Український
English
ItalianМетод exclude
Метод исключает e-mail или телефон подписчика из одного или нескольких списков. В отличие от метода unsubscribe, он не помечает контакт как "отписавшийся", и его позднее снова можно включить в список с помощью метода subscribe.
Мы рекомендуем использовать метод exclude в случае, когда управление подпиской/отпиской выполняется по инициативе отправителя (то есть вас, автора рассылки), и метод unsubscribe в случае, когда сам подписчик отказывается от подписки.
Принцип использования
| Синтаксис URL для вызова метода |
|---|
| exclude (string contact_type, string contact [, string list_ids]) |
| http://api.unisender.com/ru/api/exclude?format=json&api_key=KEY&contact=test@example.org&contact_type=TYPE&list_ids=134,135 |
| Аргументы | |
|---|---|
| api_key * | Ключ доступа к API |
| contact_type * |
Тип исключаемого контакта - либо 'email', либо 'phone'. Примеры: contact_type=email contact_type=phone |
| contact * |
E-mail или телефон, который исключаем. Примеры: contact=test@example.org contact=89091234567 |
| list_ids |
Перечисленные через запятую коды списков, из которых мы исключаем подписчика.
Если не указаны, то исключаем из всех списков.
Коды списков можно узнать с помощью метода getLists.
Они совпадают с кодами, используемыми в форме подписки. Примеры: list_ids=662572 list_ids=112233,887789,6665576 |
| Возвращаемое значение |
|---|
| Пустой объект в случае успеха. Если возникнут ошибки или предупреждения, они будут возвращены стандартным способом. |
Смотрите также
Примеры на PHP
Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Подробнее о методах соединения здесь.
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxx";
// Данные о подписчике, которого надо отписать от списков
$user_email = "address_to_exclude@aol.com";
$user_lists = "354168";
$user_type = "email";
// Создаём POST-запрос
$POST = array (
'api_key' => $api_key,
'list_ids' => $user_lists,
'contact_type' => $user_type,
'contact' => $user_email
);
// Устанавливаем соединение
$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/exclude?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 "Excluded";
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxx";
// Данные о подписчике, которого надо отписать от списков
$user_email = "address_to_exclude@aol.com";
$user_lists = "354168";
$user_type = "email";
// Создаём GET-запрос
$api_url = "http://api.unisender.com/ru/api/exclude?format=json".
"&api_key=$api_key&list_ids=$user_lists".
"&contact=$user_email&contact_type=$user_type";
// Делаем запрос на 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 "Excluded";
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
Правила использования | Политика конфиденциальности
| Анти-спам политика
© UniSender 2008-2011