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 и phone, метод выберет только профили подписчиков у которых оба указанных значения совпали. При использовании только одного из аргументов emails и phone, значение второго оставьте пустым и поиск будет осуществляться по указанному не пустому значению.

Ответ метода содержит список удаленных профилей со статусом '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>