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 та назвою списку
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:list_id>int</tem:list_id>
<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/FALSE

Значення, що повертається містить імпортований профіль підписчика зі статусом 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>