subscriberImport — додати/оновити підписчика

subscriberImport (string apikey, string email, string phone, string mobilecountry, string fname, string lname, string names, string values, bool update_existing)

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

Параметри
apikey API-ключ доступу до вашого аккаунту
email Email
phone Номер мобільного телефону
mobilecountry Країна для валідації номера мобільного телефону пдписчика (по-англійськи)
fname Ім'я підписчика
lname Прізвище підписчика
names Назви додаткових полів підписчика. Необхідно додавати через кому
gender Стать
language Мова
dateofbirth Дата народження
city Місто проживання
zip Поштовий індекс
stateorprovince Штат або область
country Країна
interests Вид інтересів
occupation Вид занять
values Значення додаткових полів підписчика. Необхідно додавати через кому
update_existing Параметр, що вказує на необхідність оновлення даних підписчика раніше збереженого у Адресну книгу.
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: api.feedgee.com/1.0/subscriberImport?apikey=APIKEY&email=EMAIL&phone=PHONE&mobilecountry=COUNTRY&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 = "subscriberImport";
echo "Method: " . $method. "<br>";
//параметри
$email = "test@test.com";
$phone = urlencode("+380500000000");
$fname = "fname";
$lname = "lname";
$parameters = "apikey=$api_key&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:subscriberImport>
<tem:apikey>string</tem:apikey>
<tem:email>string</tem:email>
<tem:phone>string</tem:phone>
<tem:mobilecountry>string</tem:mobilecountry>
<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>

subscribersGetByEmail — пошук підписчика за email адресою

subscribersGetByEmail (string apikey, string email, bool include_Custom_Fields)

Метод для пошуку підписчика та даних профілю підписчика за значенням Email. Цей метод не повертає значення статусу підписчика, замість цього виводиться рядок «undefined» (для сумісності).

Цей один з декількох методів, який можливо використовувати лише в платних аккаунтах.

Параметри
apikey API-ключ доступу до вашого аккаунту
email Email підписчика для пошуку
include_Custom_Fields Параметр, який відповідає за виведення додаткових полів підписчика (опціонально, за замовчуванням = FALSE)
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр &output=json

Форма запиту: http://api.feedgee.com/1.0/subscribersGetByEmail?apikey=API_KEY&email=EMAIL_ADDRESS&include_Custom_Fields=TRUE/FALSE

Значення, що повертається
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":"Undefined"}]
}

Запит на PHP

<?
// Ваш ключ доступу до API
$api_key = "00000000000000000000000000000000";
//Ім'я методу
$method = "subscribersGetByEmail";
echo "Method: " . $method. "<br>";
//Ім'я методу
$parameters = "apikey=$api_key&email=BA9E956C-3C3E-441B-B2C7-6082C771A86D&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:subscribersGetByEmail>
<tem:apikey>string</tem:apikey>
<tem:email>string</tem:email>
<tem:INCLUDE_CUSTOM_FIELDS>string</tem:INCLUDE_CUSTOM_FIELDS>
</tem:subscribersGetByEmail>
</soapenv:Body>
</soapenv:Envelope>

subscribersGetByMobile — пошук підписчика за номером мобільного

subscribersGetByMobile (string apikey, string phone, bool include_Custom_Fields)

Метод для пошуку підписчика та отримання даних профілю підписчика за значенням номера мобільного телефону — phone. Цей метод не повертає значення статусу підписчика, натомість виводиться рядок «undefined» (для сумісності).

Це один з декількох методів, які доступні тільки в платних акаунтах.

Параметри
apikey API-ключ доступу до вашого аккаунту
phone Номер мобільного телефону підписчика для пошуку. Номер повинен бути в повному міжнародному форматі. Значення номерів допускаються без знака +
include_Custom_Fields Параметр, який відповідає за виведення додаткових полів підписчика (опціонально, за замовчуванням = FALSE)
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр &output=json

Форма запиту: http://api.feedgee.com/1.0/subscribersGetByMobile?apikey=API_KEY&phone=PHONE_NUMBER&include_Custom_Fields=TRUE/FALSE

Значення, що повертається
success 1 при успішному виклику методу, 0 при помилкі
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":"Undefined"}]
}

Запит на PHP

<?
// Ваш ключ доступу до API
$api_key = "00000000000000000000000000000000";
//Ім'я методу
$method = "subscribersGetByMobile";
echo "Method: " . $method. "<br>";
//параметри
$phone = urlencode("+380500000000");
$parameters = "apikey=$api_key&phone=$phone&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:subscribersGetByMobile>
<tem:apikey>string</tem:apikey>
<tem:phone>string</tem:phone>
<tem:INCLUDE_CUSTOM_FIELDS>string</tem:INCLUDE_CUSTOM_FIELDS>
</tem:subscribersGetByMobile>
</soapenv:Body>
</soapenv:Envelope>

subscribersDelete — видалення підписчиків

subscribersDelete (string apikey, string emails, string phones)

Метод видаляє підписчиків з адресної книги вашого аккаунту.

Параметри
apikey API-ключ доступу до вашого аккаунту
emails Email адреси підписчиків для пошуку. Якщо декілька, то через кому
phones Мобільні номери підписчиків для пошуку. Якщо декілька, то через кому. Значення номерів треба вказувати у повному міжнародному форматі, але можна без +

За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр &output=json

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

При пошуку підписчика одночасно за значенням emails і phones, метод вибере тільки профілі підписчиків у яких обидва зазначених значення збігаються. При використанні тільки одного з аргументів emails і phones, значення іншого залишайте порожнім і пошук буде здійснюватися за вказаним не пустим значенням.

Відповідь методу містить список видалених профілів зі статусом 'deleted'. Якщо підписчика не було знайдено, то метод поверне помилку такого виду «example@exampleemail.com profile not found».

Значення, що повертається
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>deleted</status>
</Profile>
<Profile>
<email>string</email>
<phone>string</phone>
<firstname>string</firstname>
<lastName>string</lastName>
<status>deleted</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":"deleted"}]
}

Запит на PHP

<?
// Ваш ключ доступу к API
$api_key = "00000000000000000000000000000000";
//Ім'я методу
$method = "subscribersDelete";
echo "Method: " . $method. "<br>";
//параметри
$email = "test@test.com";
$phone = urlencode("+380500000000");
$parameters = "apikey=$api_key&emails=$email&phones=$phone";
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:subscribersDelete>
<tem:apikey>string</tem:apikey>
<tem:phones>string</tem:phones>
<tem:emails>string</tem:emails>
</tem:subscribersDelete>
</soapenv:Body>
</soapenv:Envelope>