Метод createList
Метод для создания нового списка рассылки.
Предполагается, что каждый список задаёт отдельную тематику рассылок. Подписчик может подписаться или отписатья от рассылки определённой тематики, поставив или убрав галочку напротив списка на странице управления подпиской, доступной по ссылке в письме. Поэтому неправильной практикой будет создание нового списка для каждой новой рассылки.
В случае необходимости изменения списка адресатов перед рассылкой рассмотрите возможность использования методов importContacts/exportContacts, либо указания конкретных адресов/телефонов в методе createCampaign.
Принцип использования
| Синтаксис и URL для вызова метода |
|---|
| createList (string title) |
| http://api.unisender.com/ru/api/createList?format=json&api_key=KEY&title=NewListName |
| Аргументы | |
|---|---|
| api_key * | Ключ доступа к API |
| title * |
Название списка. Должно быть уникальным в вашем аккаунте. Примеры:
title=NewListTitle
title=%D0%9D%D0%BE%D0%B2%D1%8B%D0%B9 («Новый» в кодировке UTF-8)
|
| Возвращаемое значение |
|---|
|
Объект с полем id (кодом списка). Этот id далее можно использовать в прочих методах, где требуется id списка рассылки. Примеры возвращаемого значения:
{"result":{"id":353358}}
{
"error":"Список с именем \"Новый\" уже существует",
"code":"invalid_arg",
"result":""
}
|
Смотрите также
Примеры на PHP
Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Подробнее о методах соединения здесь.
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxxxxxxx";
// Имя нового списка
$new_list_name = "Новый список рассылки";
// Создаём POST-запрос
// Если файл скрипта в кодировке UTF-8, то удалите вызов iconv
$POST = array (
'api_key' => $api_key,
'title' => iconv('cp1251', 'utf-8', $new_list_name)
);
// Устанавливаем соединение
$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/createList?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 "New list successfully created. List id is " . $jsonObj->result->id;
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxxxx";
// Имя нового списка
$new_list_name = urlencode(iconv('cp1251', 'utf-8', "Это новый список"));
// Если файл скрипта в кодировке UTF-8, то используйте такую строчку
// $new_list_name = rawurlencode("Это новый список");
// Создаём GET-запрос
$api_url = "http://api.unisender.com/ru/api/createList?format=json".
"&api_key=$api_key&title=$new_list_name";
// Устанавливаем соединение
$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 "New list successfully created. List id is " . $jsonObj->result->id;
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
Правила использования | Политика конфиденциальности
| Анти-спам политика
© UniSender 2008-2011