listNew — создание списка рассылки

listNew (string apikey, string name)

Метод позволяет создать новый список рассылки.

Параметры
apikey API-ключ доступа к вашему аккаунту
name Название создаваемого списка рассылки
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listNew?apikey=APIKEY&name=NAME

Возвращаемое значение: данные созданного списка
success 1 при успешном вызове метода, 0 при ошибке
errors Количество ошибок при вызове метода
error Описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными списка
MailLst Массив с номером и названием списка
id идентификатор списка
name

название списка

Пример (XML)

<ResultOfMailList>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<MailList>
<id>int</id>
<name>string</name>
</MailList>
</data>
</ResultOfMailList>

Пример (JSON)

{
"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"id":"int",
"name":"string"},
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listNew";
echo "Method: " . $method. "<br>";
//параметры
$name = "list1";
$parameters = "apikey=$api_key&campaign_id=$campaign_id&name=$name";
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
// Ошибка получения данных списка
if(!empty($jsonObj->error)) {echo "An error occured: " . $jsonObj->error . "<br/>";}
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>";
foreach ($custom as $one) {
echo "&nbsp;&nbsp;&nbsp;&nbsp;->" . $one->name . ":" . $one->value . "<br/>";
}
} else {
echo $key . ":" . $custom . "<br/>";
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listNew>
<tem:apikey>string</tem:apikey>
<tem:name>string</tem:name>
</tem:listNew>
</soapenv:Body>
</soapenv:Envelope>

listGetAll — получение данных всех списков рассылки

listGetAll (string ApiKey)

Метод выводит Id (уникальный идентификатор) и name (названия) всех списков рассылки из вашего аккаунта.

Параметры
apikey API-ключ доступа к вашему аккаунту
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listGetAll?apikey=API_KEY

Возвращаемое значение
success 1 при успешном вызове метода, 0 при ошибке
errors Количество ошибок при вызове метода
error Описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
total Общее количество списков рассылки в аккаунте
data Массив с переченем списков
MailLst Массив с идентификатором и названием списка
id идентификатор списка
name название списка

Пример (XML)

<ResultOfMailList>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<MailList>
<id>int</id>
<name>string</name>
</MailList>
<MailList>
<id>int</id>
<name>string</name>
</MailList>
</data>
</ResultOfMailList>

Пример (JSON)

{
"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"id":"int",
"name":"string"},
{"id":"int",
"name":"string"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listGetAll";
echo "Method: " . $method. "<br>";
// Создаём GET-запрос
$api_url = "http://api.test.feedgee.com/1.0/$method?apikey=$api_key&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на 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;
} else {
// Выводим коды и названия всех имеющихся списков
echo "Here's a list of your mailing lists:<br>";
foreach ($jsonObj->data as $one) {
echo "List #" . $one->id . " (" . $one->name. ")". "<br>";
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listUnsubscribe>
<tem:apikey>string</tem:apikey>
<tem:emails>string</tem:emails>
<tem:phones>string</tem:phones>
</tem:listUnsubscribe>
</soapenv:Body>
​</soapenv:Envelope>

listSubscribeOptInNow — добавить подписчика в список рассылки

listSubscribeOptInNow (string apikey, int list_id, string email, string phone, string mobilecountry, string fname, string lname, string names, string values, bool optin, bool update_existing)

Метод позволяет импортировать подписчика в Адресную книгу вашего аккаунта и добавить в указанный список рассылки со статусом Подписан или обновить информацию об уже имеющемся подписчике. Новый подписчик в списке добавляется со статусом Подписан. В запросе обязательно к заполнению одно из полей: email или phone.

Параметры
apikey API-ключ доступа к вашему аккаунту
list_id Id списка рассылки для добавления
email Email
phone Номер мобильного телефона
mobilecountry Страна для валидации номера мобильного телефона подписчика (по-английски)
fname Имя подписчика
lname Фамилия подписчика
names Названия дополнительных полей подписчика. Необходимо указать через запятую
gender Пол
language Язык
dateofbirth Дата рождения
city Город проживания
zip Почтовый индекс
stateorprovince Штат или область
country Страна
interests Род интересов
occupation Род занятий
values Значения дополнительных полей подписчика. Необходимо указать через запятую
optin Параметр указывающий на необходимость отправить уведомление о добавлении в список подписку
update_existing Параметр указывающий на необходимость обновить данные подписчиков ранее загруженных в аккаунт
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listSubscribeOptInNow?apikey=APIKEY&list_id=LIST_ID&email=EMAIL&phone=PHONE&
mobilecountry=COUNTRY&fname=FNAME&lname=LNAME&names=NAMES&values=VALUES&optin=TRUE&update_existing=TRUE

Возвращаемое значение содержит импортированный профиль подписчика со статусом imported. Если профиль подписчика был загружен ранее и в запросе указано значение update_existing=TRUE, то в ответе будут данные обновленного профиля со статусом updated. При совпадении в запросе одного из передаваемых значений email или phone с данными уже существующего профиля подписчика, а второго значения с данными уже существующего профиля другого подписчика, подписчик не будет добавлен или обновлен для сохранения уникальности контактов в Адресной книге вашего аккаунта и в ответе status будет содержать ошибку 'More than one profile found'.

Возвращаемое значение
success Количество успешных запросов
errors Количество ошибок при вызове метода
error Описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными подписчиков
Profile Массив с данными одного подписчика
email Email
phone Номер мобильного телефона
firstname Имя
lastname Фамилия
customfields
Массив с дополнительными полями подписчика
customfield Название и значение дополнительного поля
name Название, например «Gender»
value Значение, например «Male»
status Статус подписчика

Пример (XML)

<ResultOfProfile>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<customfields>
<CustomField>
<name>string</name>
<value>string</value>
</CustomField>
<CustomField>
<name>string</name>
<value>string</value>
</CustomField>
<status>string</status>
</Profile>
</data>
</ResultOfProfile>

Пример (JSON)

{"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"email":"string",
"phone":"string",
"firstname":"string",
"lastname":"string",
"customfields":
[{"name":"string","value":"string"},
{"name":"string","value":"string"}],
"status":"Updated"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listSubscribeOptInNow";
echo "Method: " . $method. "<br>";
//параметры
$email = "test@test.com";
$phone = urlencode("+380500000000");
$fname = "fname";
$lname = "lname";
$country = "country";
$parameters = "apikey=$api_key&list_id=$list_id&email=$email&phone=$phone&mobilecountry=$mobilecountry&
fname=$fname&lname=$lname&names=&values=&optin=$optin&update_existing=true";
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
// Ошибка получения перечня подписчиков
if(!empty($jsonObj->error))
{ echo "An error occured: " . $jsonObj->error . "<br/>";}
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>";
foreach ($custom as $one) {
echo " ->" . $one->name . ":" . $one->value . "<br/>";
}
} else {
echo $key . ":" . $custom . "<br/>";
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listSubscribeOptinNow>
<tem:apikey>string</tem:apikey>
<tem:list_id>int</tem:list_id>
<tem:email>string</tem:email>
<tem:phone>string</tem:phone>
<tem:country>string</tem:country>
<tem:fname>string</tem:fname>
<tem:lname>string</tem:lname>
<tem:names>string</tem:names>
<tem:values>string</tem:values>
<tem:optin>boolean</tem:optin>
<tem:update_existing>boolean</tem:update_existing>
</tem:subscriberImport>
</soapenv:Body>
</soapenv:Envelope>

listSubscribeDoubleOptInNow — добавить подписчика с запросом на подтверждение согласия

listSubscribeDoubleOptInNow (string apikey, int list_id, string email, string phone, string mobilecountry, string fname, string lname, string names, string values, bool update_existing)

Метод позволяет импортировать подписчика в Адресную книгу вашего аккаунта и добавить в указанный список рассылки или обновить информацию об уже имеющемся подписчике. Новый подписчик в списке добавляется со статусом Приглашен. В запросе обязательно к заполнению одно из полей: email или phone. Если email в списке рассылки новый, то метод сгенерирует и отправит на email Double Opt-In сообщение со ссылкой подтверждения согласия. Только после клика по ссылке в этом сообщении статус подписчика в списке изменится на Подписан и подписчик сможет получать рассылку, отправляемую по данному списку.

Параметры
apikey API-ключ доступа к вашему аккаунту
list_id Id списка рассылки для добавления
email Email
phone Номер мобильного телефона
mobilecountry Страна для валидации номера мобильного телефона подписчика (по-английски)
fname Имя подписчика
lname Фамилия подписчика
names Названия дополнительных полей подписчика. Необходимо указать через запятую
gender Пол
language Язык
dateofbirth Дата рождения
city Город проживания
zip Почтовый индекс
stateorprovince Штат или область
country Страна
interests Род интересов
occupation Род занятий
values Значения дополнительных полей подписчика. Необходимо указать через запятую
update_existing Параметр указывающий на необходимость обновить данные подписчиков ранее загруженных в аккаунт
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listSubscribeDoubleOptInNow?apikey=APIKEY&list_id=LIST_ID&email=EMAIL&phone=PHONE&mobilecountry=MOBILECOUNTRY&fname=FNAME&lname=LNAME&names=NAMES&values=VALUES&update_existing=TRUE

Возвращаемое значение содержит импортированный профиль подписчика со статусом imported. Если профиль подписчика был загружен ранее и в запросе указано значение update_existing=TRUE, то в ответе будут данные обновленного профиля со статусом updated. При совпадении в запросе одного из передаваемых значений email или phone с данными уже существующего профиля подписчика, а второго значения с данными уже существующего профиля другого подписчика, подписчик не будет добавлен или обновлен для сохранения уникальности контактов в Адресной книге вашего аккаунта и в ответе status будет содержать ошибку 'More than one profile found'.

Возвращаемое значение
success Количество успешных запросов
errors Количество ошибок при вызове метода
error Текстовое описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными подписчика
Profile Массив с данными одного подписчика
email Email подписчика
phone Телефонный номер
firstname Имя
lastname Фамилия
customfields
Массив с дополнительными полями подписчика
customfield Название и значение дополнительного поля
name Название, например «Gender»
value Значение, например «Male»
status Статус подписчика

Пример (XML)

<ResultOfProfile>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<customfields>
<CustomField>
<name>string</name>
<value>string</value>
</CustomField>
<CustomField>
<name>string</name>
<value>string</value>
</CustomField>
<status>string</status>
</Profile>
</data>
</ResultOfProfile>

Пример (JSON)

{"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"email":"string",
"phone":"string",
"firstname":"string",
"lastname":"string",
"customfields":
[{"name":"string","value":"string"},
{"name":"string","value":"string"}],
"status":"Updated"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listSubscribeDoubleOptInNow";
echo "Method: " . $method. "<br>";
//параметры
$email = "test@test.com";
$phone = urlencode("+380500000000");
$fname = "fname";
$lname = "lname";
$country = "country";
$parameters = "apikey=$api_key&list_id=$list_id&email=$email&phone=$phone&mobilecountry=$mobilecountry&fname=$fname&lname=$lname&names=&values=&update_existing=true";
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
// Ошибка получения перечня подписчиков
if(!empty($jsonObj->error))
{ echo "An error occured: " . $jsonObj->error . "<br/>";}
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>";
foreach ($custom as $one) {
echo " ->" . $one->name . ":" . $one->value . "<br/>";
}
} else {
echo $key . ":" . $custom . "<br/>";
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listSubscribeDoubleOptInNow>
<tem:apikey>string</tem:apikey>
<tem:list_id>int</tem:list_id>
<tem:email>string</tem:email>
<tem:phone>string</tem:phone>
<tem:country>string</tem:country>
<tem:fname>string</tem:fname>
<tem:lname>string</tem:lname>
<tem:names>string</tem:names>
<tem:values>string</tem:values>
<tem:update_existing>boolean</tem:update_existing>
</tem:subscriberImport>
</soapenv:Body>
</soapenv:Envelope>

listSubscribeOptIn - подписать подписчиков на рассылку

listSubscribeOptIn (string ApiKey, int listId, string emails, string phones, bool optin, bool update_existing)

Позволяет подписать подписчиков на один список рассылки. Отсылает на email подписчика уведомление о подписке. Обязательно к заполнению одно из полей: email или phone.

Параметры
apikey Ключ доступа к API вашего аккаунта
list id Номер списка рассылки (можно получить с помощью метода ListGetAll)
Emails Адреса подписчиков для подписки, через запятую
Phones Телефонные номера подписчиков для отписки, через запятую, можно без знаков «+"
optin Флаг, отвечающий за отсылку подписчику уведомления о подписке
update_existing Параметр указывающий на необходимость обновить данные подписчиков ранее загруженных в аккаунт
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Если вы используете только адреса подписчиков, то поле Phones следует оставить пустым. И наоборот.

Форма запроса: http://api.feedgee.com/1.0/listSubscribeOptIn?apikey=APIKEY&list_id=LIST_ID&emails=EMAILS&phones=PHONES&optin=TRUE/FALSE&update_existing=TRUE/FALSE

Email-адреса и номера мобильных подписчиков указываются попарно. Каждая пара относится к одному профилю подписчика. При использовании только одного из аргументов email или phone, значение второго можно оставить пустым.

Возвращаемое значение
success Количество успешных запросов
errors Количество ошибок при вызове метода
error Текстовое описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными подписчиков
Profile Массив с данными одного подписчика
email Email подписчика
phone Телефонный номер
firstname Имя
lastname Фамилия
status Статус подписчика

Пример (XML)

<ResultOfProfile>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>string</status>
</Profile>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>string</status>
</Profile>
</data>
</ResultOfProfile>

Пример (JSON)

{
"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"email":"string",
"phone":"string",
"firstname":"string",
"lastname":"string",
"status":"Undefined"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listSubscribeOptIn";
echo "Method: " . $method. "<br>";
//параметры
$emails = "test@test.com";
$phones = urlencode("+380500000000");
$list_id = "0001";
$optin="TRUE";
$parameters = "apikey=$api_key&list_id=$list_id&emails=$emails&phones=$phones&optin=$optin
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
// Ошибка получения перечня подписчиков
if(!empty($jsonObj->error))
{ echo "An error occured: " . $jsonObj->error . "<br/>";}
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>";
foreach ($custom as $one) {
echo "&nbsp;&nbsp;&nbsp;&nbsp;->" . $one->name . ":" . $one->value . "<br/>";
}
} else {
echo $key . ":" . $custom . "<br/>";
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listSubscribeOptIn>
<tem:apikey>string</tem:apikey>
<tem:list_id>int</tem:list_id>
<tem:emails>string</tem:emails>
<tem:phones>string</tem:phones>
<tem:optin>boolean</tem:optin>
</tem:listSubscribeOptIn>
</soapenv:Body>
</soapenv:Envelope>

listSubscribeDoubleOptIn - пригласить подписчиков подписаться на рассылку

listSubscribeDoubleOptIn (string ApiKey, int listId, string emails, string phones, bool double_optin, bool update_existing)

Позволяет пригласить подписчиков подписаться на один список рассылки. Отсылает на email подписчика приглашение на рассылку.

Обязательно к заполнению поле email.

Параметры
apikey Ключ доступа к API вашего аккаунта
list id Id списка рассылки, полученный командой listGetAll
Emails Адреса подписчиков для подписки, через запятую
Phones Телефонные номера подписчиков для подписки, через запятую, можно без знаков «+"
double_optin Флаг, отвечающий за отсылку подписчику приглашения подписаться на рассылку
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listSubscribeDoubleOptIn?apikey=APIKEY&list_id=LIST_ID&emails=EMAILS&phones=PHONES&double_optin=TRUE/FALSE

Email-адреса и номера мобильных подписчиков указываются попарно. Каждая пара относится к одному профилю подписчика. При использовании только аргумента email, значение аргумента phone можно оставить пустым.

Возвращаемое значение
success Количество успешных запросов
errors Количество ошибок при вызове метода
error Текстовое описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными подписчиков
Profile Массив с данными одного подписчика
email Email подписчика
phone Телефонный номер
firstname Имя
lastname Фамилия
status Статус подписчика

Пример (XML)

<ResultOfProfile>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>string</status>
</Profile>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>string</status>
</Profile>
</data>
</ResultOfProfile>

Пример (JSON)

{
"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"email":"string",
"phone":"string",
"firstname":"string",
"lastname":"string",
"status":"Undefined"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listSubscribeDoubleOptIn";
echo "Method: " . $method. "<br>";
//параметры
$emails = "test@test.com";
$phones = urlencode("+380500000000");
$list_id = "0001";
$double_optin="TRUE";
$parameters = "apikey=$api_key&list_id=$list_id&emails=$emails&phones=$phones&double_optin=$double_optin&;
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.test.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
// Ошибка получения перечня подписчиков
if(!empty($jsonObj->error))
{ echo "An error occured: " . $jsonObj->error . "<br/>";}
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>";
foreach ($custom as $one) {
echo "&nbsp;&nbsp;&nbsp;&nbsp;->" . $one->name . ":" . $one->value . "<br/>";
}
} else {
echo $key . ":" . $custom . "<br/>";
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listSubscribeDoubleOptIn>
<tem:apikey>string</tem:apikey>
<tem:list_id>int</tem:list_id>
<tem:emails>string</tem:emails>
<tem:phones>string</tem:phones>
<tem:double_optin>boolean</tem:double_optin>
</tem:listSubscribeDoubleOptIn>
</soapenv:Body>
</soapenv:Envelope>

listGetAllSubscribers — экспорт подписчиков

listGetAllSubscribers (string apikey, int start, int count, string list_id, bool include_Custom_Fields)

Метод выводит данные профилей всех подписчиков со всеми дополнительными полями. Если не указан конкретный список, то метод не возвращает значение статуса подписчика. Вместо этого выводится строка «undefined» (для совместимости).

Это один из нескольких методов, которые доступны только в платных аккаунтах.

Параметры
apikey API-ключ доступа к вашему аккаунту
start Номер первого подписчика (опционально, по умолчанию = 1)
count Количество возвращаемых записей подписчиков. Значение опционально. По умолчанию = 10000. Метод отдает не больше 10000 за один запрос.
list_id Id списка рассылки, полученный командой listsGetAll для конкретного списка, или значение ALL для выбора всех подписчиков пользователя (опционально, по умолчанию = ВСЕ СПИСКИ)
include_Custom_Fields Флаг, отвечающий за вывод дополнительных полей подписчика (опционально, по умолчанию = FALSE)
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить опциональный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listGetAllSubscribers?apikey=APIKEY&start=START&count=COUNT&list_id=LIST_ID&include_Custom_Fields=TRUE

Возвращаемое значение
success Количество успешных запросов
errors Количество ошибок при вызове метода
error Описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
total Общее количество подписчиков в списке
data Массив с данными подписчиков
Profile Массив с данными одного подписчика
email Email
phone Телефонный номер
firstname Имя
lastname Фамилия
status Статус подписчика

Пример (XML)

<ResultOfProfile>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName> 
<status>string</status>
</Profile>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName> 
<status>string</status>
</Profile>
</data>
</ResultOfProfile>

Пример (JSON)

{
"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"email":"string",
"phone":"string",
"firstname":"string",
"lastname":"string",
"status":"Undefined"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API 
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "subscribersGetAll";
echo "Method: " . $method. "<br>";
//Имя метода
$parameters = "apikey=$api_key&start=0&count=100&list_id=LISTID&INCLUDE_CUSTOM_FIELDS=TRUE";
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на 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;
} else {
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>"; 
foreach ($custom as $one) {
echo "&nbsp;&nbsp;&nbsp;&nbsp;->" . $one->name . ":" . $one->value . "<br/>"; 
}
} else {
echo $key . ":" . $custom . "<br/>"; 
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:subscribersGetAll>
<tem:apikey>string</apikey>
<tem:start>int</tem:start>
<tem:count>int</tem:count>
<tem:list_id>string</tem:list_id>
<tem:INCLUDE_CUSTOM_FIELDS>string</tem:INCLUDE_CUSTOM_FIELDS>
</tem:subscribersGetAll>
</soapenv:Body>
</soapenv:Envelope>

listUnsubscribe - отписать подписчиков от списка рассылки

listUnsubscribe (string apikey, int list_Id, string emails, string phones)

Метод позволяет отписать подписчиков от списка рассылки.

Параметры
apikey Ключ доступа к API вашего аккаунта
list_Id Id списка рассылки, полученный командой listGetAll
emails Email адреса подписчиков для поиска, через запятую
phones Мобильные телефоны подписчиков для поиска, через запятую, можно без знака +
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listUnsubscribe?apikey=APIKEY&list_id=LIST_ID&emails=EMAILS&phones=PHONES

Email-адреса и номера мобильных подписчиков указываются попарно. Каждая пара относится к одному профилю подписчика. При использовании только одного из аргументов email или phone, значение второго можно оставить пустым.

Возвращаемое значение
success Количество успешных запросов
errors Количество ошибок при вызове метода
error Текстовое описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными подписчиков
Profile Массив с данными одного подписчика
email Email подписчика
phone Телефонный номер
firstname Имя
lastname Фамилия
status Статус подписчика

Пример (XML)

<ResultOfProfile>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>unsubscribed</status>
</Profile>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>unsubscribed</status>
</Profile>
</Profile>
</data>
</ResultOfProfile>

Пример (JSON)

{"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"email":"string",
"phone":"string",
"firstname":"string",
"lastname":"string",
"status":"unsubscribed"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listUnsubscribe";
echo "Method: " . $method. "<br>";
//параметры
$emails = "test@test.com";
$phones = urlencode("+380500000000");
$list_id = "0001";
$parameters = "apikey=$api_key&list_id=$list_id&emails=$emails&phones=$phones";
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.test.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
// Ошибка получения перечня подписчиков
if(!empty($jsonObj->error))
{ echo "An error occured: " . $jsonObj->error . "<br/>";}
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>";
foreach ($custom as $one) {
echo "&nbsp;&nbsp;&nbsp;&nbsp;->" . $one->name . ":" . $one->value . "<br/>";
}
} else {
echo $key . ":" . $custom . "<br/>";
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listUnsubscribe>
<tem:apikey>string</tem:apikey>
<tem:list_id>int</tem:list_id>
<tem:emails>string</tem:emails>
<tem:phones>string</tem:phones>
</tem:listUnsubscribe>
</soapenv:Body>
</soapenv:Envelope>

listUnsubscribeFromAll - отписать подписчика от всех списков рассылки

listUnsubscribeFromAll (string apikey, string emails, string phones)

Метод позволяет отписать подписчиков сразу от всех списков рассылки.

Параметры
apikey Ключ доступа к API вашего аккаунта
emails Email адреса подписчиков для поиска, через запятую
phones Мобильные телефоны подписчиков для поиска, через запятую, можно без знака +
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listUnsubscribeFromAll?apikey=APIKEY&emails=EMAILS&phones=PHONES

Email-адреса и номера мобильных подписчиков указываются попарно. Каждая пара относится к одному профилю подписчика. При использовании только одного из аргументов email или phone, значение второго можно оставить пустым.

Возвращаемое значение: список отписанных профилей
success Количество успешных запросов
errors Количество ошибок при вызове метода
error Текстовое описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными подписчиков
Profile Массив с данными одного подписчика
email Email подписчика
phone Телефонный номер
firstname Имя
lastname Фамилия
status Статус подписчика

Пример (XML)

<ResultOfProfile>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>unsubscribed</status>
</Profile>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>unsubscribed</status>
</Profile>
</Profile>
</data>
</ResultOfProfile>

Пример (JSON)

{"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"email":"string",
"phone":"string",
"firstname":"string",
"lastname":"string",
"status":"unsubscribed"}]
}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "listUnsubscribeFromAll";
echo "Method: " . $method. "<br>";
//параметры
$emails = "test@test.com";
$phones = urlencode("+380500000000");
$parameters = "apikey=$api_key&emails=$emails&phones=$phones";
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.feedgee.com/1.0/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
// Ошибка получения перечня подписчиков
if(!empty($jsonObj->error))
{ echo "An error occured: " . $jsonObj->error . "<br/>";}
// Выводим названия и значения
echo "Here's a list of your data:<br>";
foreach ($jsonObj->data as $key => $jsons) { // This will search in the 2 jsons
foreach($jsons as $key => $custom) {
if(is_array($custom)){
echo $key . ":<br/>";
foreach ($custom as $one) {
echo "&nbsp;&nbsp;&nbsp;&nbsp;->" . $one->name . ":" . $one->value . "<br/>";
}
} else {
echo $key . ":" . $custom . "<br/>";
}
}
}
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listUnsubscribeFromAll>
<tem:apikey>string</tem:apikey>
<tem:emails>string</tem:emails>
<tem:phones>string</tem:phones>
</tem:listUnsubscribeFromAll>
</soapenv:Body>
</soapenv:Envelope>

listDelete - удаление списка рассылки

listDelete (string apikey, int list_id)

Метод позволяет удалить существующий список рассылки.

Параметры
apikey Ключ доступа к API вашего аккаунта
list_id Id списка рассылки, полученный командой listGetAll
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json

Форма запроса: http://api.feedgee.com/1.0/listDelete?apikey=APIKEY&list_id=LIST_ID

Возвращаемое значение: данные удаленного списка
success Значение 1 при успешном вызове метода, 0 при ошибке
errors Количество ошибок при вызове метода
error Текстовое описание ошибки
code Код ошибки
warning Дополнительные предупреждения, для xml не выводится при значении null
data Массив с данными списка подписчиков
MailLst Массив с номером и названием списка
id Номер списка
name

Название списка

Пример (XML)

<ResultOfMailList>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<MailList>
<id>int</id>
<name>string</name>
</MailList>
</data>
</ResultOfMailList>

Пример (JSON)

{
"success":int,
"errors":int,
"error":"string",
"warning":"string",
"code":int,
"data":
[{"id":"int",
"name":"string"},
​}

Запрос на PHP

<?
// Ваш ключ доступа к API
$api_key = "00000000000000000000000000000000";
//Имя метода
$method = "campaignEmailContent";
echo "Method: " . $method. "<br>";
//параметры
$campaign_id="00001";
$parameters = "apikey=$api_key&campaign_id=$campaign_id";
echo "Parameters: " . $parameters. "<br>";
// Создаём GET-запрос
$api_url = "http://api.feedgee.com/$method?$parameters&output=json";
echo "Url: " . $api_url . "<br><hr/>";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
//echo $result;
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
else {
if(!empty($jsonObj->error)) {
// Ошибка получения перечня подписчиков
echo "An error occured: " . $jsonObj->error; }
// Выводим названия и значения
echo "Here's a list of your data:<br>";
data_output($jsonObj->data);
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
// Выводим данные с отступами
function data_output($obj, $level = 0) {
if(is_array($obj) || is_object($obj)) {
if(is_object($obj)) {
$obj = (array)$obj;
}
echo count($obj) > 1 ? "<br/>n" : "";
foreach($obj as $key => $value) {
// it was object
if(!is_numeric($key)) {
$prefix = str_repeat("&nbsp;&nbsp;", $level - 1);
echo $prefix . $key . ":";
}
data_output($value, $level + 1);
}
}
else {
$prefix = "&nbsp;&nbsp;";
if($obj === false) $obj = 'false';
echo $prefix . $obj . "<br/>n";
}
}
​?>

SOAP Запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:listDelete>
<tem:apikey>string</tem:apikey>
<tem:list_id>int</tem:list_id>
</tem:listDelete>
</soapenv:Body>
</soapenv:Envelope>