campaignEmailNew - створення нової розсилки

campaignEmailNew (string ApiKey, array int list_ids, string subject, string html, string names, string values)

Метод створює нову розсилку.

Параметри
apikey Ключ доступу до API вашого аккаунта
list_ids

Id списку розсилки, отриманий командою listsGetAll — для конкретного списку, або кілька значень через кому (тільки для платних користувачів).

isTransactional Тип email-розсилки: звичайна чи транзакційна (true/false)
subject Тема повідомлення розсилки
html Зміст повідомлення розсилки в HTML
names Додатковий параметр: назви додаткових полів через кому
from_email Email адреса відправника
from_name Ім'я відправника
reply_to Email адреса для відповідей
campaign_name Назва розсилки (за замовчуванням збігається з назвою теми)
lang Мова локалі (написів, автоматично додаються в повідомлення)
google_analytics Використання google analytics
authorization Авторизація (значення: on, off)
values Додатковий параметр: значення додаткових полів через кому
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту:
http://api.feedgee.com/1.0/campaignEmailNew?apikey=APIKEY&list_ids=LIST_IDS&subject=SUBJECT&html=HTML&names=NAMES&values=VALUE&isTransactional=(TRUE/FALSE)

Значення, що повертається
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив із створеною розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
}

Запит на PHP

<?
//Ваш ключ доступу к API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignEmailNew";
echo"Method:".$method."<br>";
//параметри
$list_ids="0001";
$subject="test";
$html=urlencode("<html>test</html>");
$parameters="apikey=$api_key&list_ids=$list_ids&subject=$subject&html=$html&names=&values=";
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);
//echo$result;
if($result){
//Розкодуємо відповідь API-сервера
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Помилка в отриманій відповіди
echo"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
if(!is_numeric($key)){
$prefix=str_repeat(" ",$level-1);
echo$prefix.$key.":";
}
data_output($value,$level+1);
}
}
else{
$prefix=" ";
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:campaignEmailNew>
<tem:apikey>string</tem:apikey>
<tem:list_ids>string</tem:list_ids>
<tem:subject>string</tem:subject>
<tem:html>string</tem:html>
<tem:names>string</tem:names>
<tem:values>string</tem:values>
</tem:campaignEmailNew>
</soapenv:Body>
</soapenv:Envelope>

campaignGetAll - виведення всіх розсилок

campaignGetAll (string ApiKey)

Метод виводить перелік всіх розсилок (кампаній) з їх номерами, назвами і повними відомостями про них.

Параметри
apikey Ключ доступу до API вашого аккаунта
sentDateFrom Дата після якої вибирати відправлені розсилки. Якщо значення порожнє, то будуть обрані розсилки починаючи з першої відправленої розсилки
sentDateTo Дата до якої вибирати відправлені розсилки. Якщо значення порожнє, то будуть обрані розсилки до останньої відправленої
Для зниження часу очікування відповідей на API запит і скорочення вашого машинного часу на повторну обробку даних отриманих раніше, радимо використовувати обидва фільтра для отримання даних про відправлені розсилки за певний період або sentDateFrom для отримання даних за період з певної дати, до якої ви вже могли отримати аналогічні дані для раніше відправлених розсилок
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignGetAll?apikey=API_KEY&sentDateFrom=SENT_DATE_FROM&sentDateTo=SENT_DATE_TO

Значення, що повертається
success Значення 1 при успішному виклику методу, 0 разі помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
total Кількість розсилок (в залежності від обраного періоду)
data Масив з переліком розсилок
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата і час створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
</Campaign>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

<?
//Вашключ доступу до API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignGetAll";
echo"Method:".$method."<br>";
//Ім'я методу
$parameters="apikey=$api_key;
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);
//echo$result;
if($result){
//Розкодуємо відповідь API-серверу
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Помилка в отриманій відповіді
echo"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значеня
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
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:campaignGetAll>
<tem:apikey>string</tem:apikey>
</tem:campaignGetAll>
</soapenv:Body>
</soapenv:Envelope>

campaignEmailContent - отримання даних про розсилку

campaignEmailContent (string ApiKey, int campaign_Id)

Метод дозволяє отримати дані про будь-яку розсилку.

Параметри
apikey Ключ доступу до API вашого аккаунта
campaign_Id Номер розсилки, получений командою сampaignGetAll
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignEmailContent?apikey=API_KEY&campaign_Id=CAMPAIGN_ID

Значення, що повертається: Дані розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з запрошеною розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата і час створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на 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/1.0/$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"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
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:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:campaignEmailContent>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
</tem:campaignEmailContent>
</soapenv:Body>
</soapenv:Envelope>

campaignEmailUpdate - оновлення даних розсилки

campaignEmailUpdate (string ApiKey, int campaign_id, array int list_ids, string subject, string html, string names, string values)

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

Параметри
apikey Ключ доступу до API вашого аккаунта
campaign_id Номер змінюваною розсилки, отриманий командою сampaignGetAll
list_ids

Id списку розсилки, отриманий командою listGetAll — для конкретного списку, або кілька значень через кому (тільки для платних користувачів).

subject Тема повідомлення розсилки
html Зміст повідомлення розсилки в HTML, закодоване для передачі в рядку запиту (докладніше дивись запит на PHP)
names Додатковий параметр: назви додаткових полів через кому
from_email Email адреса відправника
from_name Ім'я відправника
reply_to Email адреса для відповідей
campaign_name Назва розсилки (за замовчуванням збігається з назвою теми)
lang Мова локалі (написів, автоматично додаються в повідомлення)
google_analytics Використання google analytics
authorization Авторизація (значення on, off)
values Додатковий параметр: значення додаткових полів через кому
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignEmailUpdate?apikey=APIKEY&campaign_id=CAMPAIGN_ID&list_ids=LIST_IDS&subject=SUBJECT&html=HTML&names=NAMES&values=VALUES

Значення, що повертається: Дані відредагованої розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з відредагованою розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблон повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule


Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

<?
//Ваш ключ доступу до API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignEmailUpdate";
echo"Method:".$method."<br>";
//параметри
$list_ids="00001";
$subject="test";
$html=urlencode("<html>test</html>");
$campaign_id="000001";
$parameters="apikey=$api_key&list_ids=$list_ids&campaign_id=$campaign_id&subject=$subject&html=$html&names=&values=";
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);
//echo$result;
if($result){
//Розкодуємо відповідь API-сервера
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Помилка в отриманній відповіді
echo"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
if(!is_numeric($key)){
$prefix=str_repeat(" ",$level-1);
echo$prefix.$key.":";
}
data_output($value,$level+1);
}
}
else{
$prefix=" ";
if($obj===false)$obj='false';
echo$prefix.$obj."<br/>n";
}
}
?>

SOAP Запит

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:campaignEmailUpdate>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:list_ids>string</tem:list_ids>
<tem:subject>string</tem:subject>
<tem:html>string</tem:html>
<tem:names>string</tem:names>
<tem:values>string</tem:values>
</tem:campaignEmailUpdate>
</soapenv:Body>
</soapenv:Envelope>

campaignClone - клонування розсилки

campaignClone (string ApiKey, int campaign_Id)

Метод дозволяє клонувати обрану розсилку.

Параметри
apikey Ключ доступу до API вашого аккаунта
campaign_Id Номер розсилки, отриманий командою сampaignGetAll
name_prefix Додатковий параметр: текст, який додається перед назвою розсилки (за замовчуванням 'copy of')
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignClone?apikey=API_KEY&campaign_Id=CAMPAIGN_ID&name_prefix=name_prefix

Значення, що повертається: Дані копії розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з клонованої розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата і час створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

<?
//Ваш ключ доступу до API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignClone";
echo"Method:".$method."<br>";
//параметри
$name_prefix="test";
$campaign_id="00001";
$parameters="apikey=$api_key&name_prefix=$name_prefix&campaign_id=$campaign_id";
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);
//echo$result;
if($result){
//Розкодуємо відповідь API-сервера
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Помилка в отриманій відповіді
echo"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
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:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:campaignClone>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:name_prefix>string</tem:name_prefix>
</tem:campaignClone>
</soapenv:Body>
</soapenv:Envelope>

campaignEmailSendTest - відправка тестового повідомлення розсилки

campaignEmailSendTest (string ApiKey, int campaign_Id, string email)

Метод відсилає тестове повідомлення розсилки на вказаний email адресу.

Параметри
apikey Ключ доступу до API вашого аккаунта
campaign_Id Номер розсилки, отриманий командою campaignGetAll
email Додатковий параметр: адреса одержувача тестового повідомлення (за замовчуванням адреса акаунта)
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignEmailSendTest?apikey=API_KEY&campaign_Id=CAMPAIGN_ID&email=EMAIL

Значення, що повертається: Дані тестової розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з тестовою розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule



Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

<?
//Ваш ключ доступу до API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignEmailSendTest";
echo"Method:".$method."<br>";
//параметри
$email="test@test.com";
$campaign_id="0001";
$parameters="apikey=$api_key&email=$email&campaign_id=$campaign_id";
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);
//echo$result;
if($result){
//Розкодуємо відповідь API-сервера
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Помилка в отриманій відповіді
echo"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
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:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:campaignEmailSendTest>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:email>string</tem:email>
</tem:campaignEmailSendTest>
</soapenv:Body>
</soapenv:Envelope>

campaignEmailSendNow - відправка розсилки

campaignEmailSendNow (string ApiKey, int campaign_Id)

Метод відсилає створену раніше розсилку.

Параметри
apikey Ключ доступу до API вашого аккаунта
campaign_Id Номер розсилки, получений командою сampaignGetAll
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignEmailSendNow?apikey=API_KEY&campaign_Id=CAMPAIGN_ID

Значення, що повертається: Дані відправленої розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з відправленою розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule



Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

<?
//Ваш ключ доступу до API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignEmailSendNow";
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/1.0/$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"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccess error";
}

SOAP Запит

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

campaignEmailSchedule - постановка розсилки в розклад

campaignEmailSchedule (string ApiKey, int campaign_Id, stringdate_time)

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

Параметри
apikey Ключ доступу до API вашого аккаунта
campaign_Id Номер розсилки, отриманий командою сampaignGetAll
date_time

Заплановані дата та час відправлення в форматі MM/DD/YYYY HH: MM: SS

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

Форма запиту: http://api.feedgee.com/1.0/campaignEmailSchedule?apikey=API_KEY&campaign_Id=CAMPAIGN_ID&date_time=DATE_TIME

Значення, що повертається: Дані поставленої в розклад розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з поставленим в розклад розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule


Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

<?
//Ваш ключ доступу до API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignEmailSchedule";
echo"Method:".$method."<br>";
//параметри
$date_time=urlencode("12/12/201302:02:02");
$campaign_id="17703";
$parameters="apikey=$api_key&date_time=$date_time&campaign_id=$campaign_id";
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);
//echo$result;
if($result){
//Розкодуємо відповідь API-сервера
$jsonObj=json_decode($result);
if(null===$jsonObj){
//Помилка в отриманій відповіді
echo"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
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:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:campaignEmailSchedule>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
<tem:date_time>string</tem:date_time>
</tem:campaignEmailSchedule>
</soapenv:Body>
</soapenv:Envelope>

campaignPause - призупинення розсилки, що стоїть в розкладі

campaignPause (string ApiKey, int campaign_Id)

Метод призупиняє (ставить на паузу) створену раніше і поставлену в розклад розсилку.

Параметры
apikey Ключ доступу до API вашого аккаунта
campaign_Id Номер розсилки, отриманий командою сampaignGetAll
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignPause?apikey=API_KEY&campaign_Id=CAMPAIGN_ID

Значення, що повертається: Дані призупиненої розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з призупиненою розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule



Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

?>
//Ваш ключ доступу до API
$api_key="00000000000000000000000000000000";
//Ім'я методу
$method="campaignPause";
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/1.0/$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"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
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:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:campaignPause>
<tem:apikey>string</tem:apikey>
<tem:campaign_id>int</tem:campaign_id>
</tem:campaignPause>
</soapenv:Body>
</soapenv:Envelope>

campaignDelete - видалення розсилки

campaignDelete (string ApiKey, int campaign_Id)

Метод дозволяє видалити розсилку. Діє тільки для невідправлених розсилок.

Параметри
apikey Ключ доступу до API вашого аккаунта
campaign_Id Номер розсилки, получений командою campaignGetAll
За замовчуванням результат повертається в форматі XML, для отримання результату в JSON потрібно додати додатковий параметр & output = json

Форма запиту: http://api.feedgee.com/1.0/campaignDelete?apikey=API_KEY&campaign_Id=CAMPAIGN_ID

Значення, що повертається: Дані видаленої розсилки
success Значення 1 при успішному виклику методу, 0 при помилці
errors Кількість помилок при виклику методу
error Текстовий опис помилки
code Код помилки
warning Додаткові попередження, для xml не виводиться при значенні null
data Масив з відаленою розсилкою
Campaign Масив з даними розсилки
id Номер розсилки
name Назва розсилки
from_title Ім'я відправника
from_email Email адреса відправника
reply_to Email адреса для відповідей
maillist_ids Масив з номерами списків, на які відправлена ​​розсилка
int Номер списку
subject Тема повідомлення
social_links Використання соціальних посилань
status Статус розсилки
template_id Номер шаблону повідомлення
google_analytics Використання google analytics
locale Мова локалі (написів, автоматично додаються в повідомлення)
schedule Масив з даними про розклад розсилки (якщо розсилка поставлена ​​в розклад)
STATUS Статус розсилки
RUNDATETIME Дата та час відправлення розсилки
SENDONLYTESTEMAIL Відправлення тільки тестового повідомлення
TESTEMAILDESTINATION Адреса одержувача тестового повідомлення
CREATED Дата і час створення розсилки
CAMPAIGNID Номер розсилки

Приклад (XML)

<ResultOfCampaign>
<success>int</success>
<errors>int</errors>
<error>string</error>
<code>int</code>
<warning>string</warning>
<data>
<Campaign>
<id>int</id>
<name>string</name>
<from_title>string</from_title>
<from_email>string</from_email>
<reply_to/>
<maillist_ids>
<int>int</int>
</maillist_ids>
<subject>string</subject>
<social_links>bool</social_links>
<status>string</status>
<template_id>int</template_id>
<google_analytics>bool</google_analytics>
<locale>string</locale>
<schedule>
<STATUS>string</STATUS>
<RUNDATETIME>string</RUNDATETIME>
<SENDONLYTESTEMAIL>bool</SENDONLYTESTEMAIL>
<TESTEMAILDESTINATION/>
<CREATED>string</CREATED>
<CAMPAIGNID>int</CAMPAIGNID>
</schedule>
</Campaign>
</data>
</ResultOfCampaign>

Приклад (JSON)

{
"success":1,
"errors":0,
"error":"",
"warning":"",
"data":
[{"id":int,
"name":"string",
"from_title":"string",
"from_email":"string",
"reply_to":"string",
"maillist_ids":[int],
"subject":"string",
"body":"string",
"social_links":bool,
"status":"string",
"template_id":int,
"google_analytics":bool,
"locale":"string",
"schedule":
{"STATUS":"string",
"RUNDATETIME":"string",
"SENDONLYTESTEMAIL":bool,
"TESTEMAILDESTINATION":"string",
"CREATED":"string",
"CAMPAIGNID":int}}]
}

Запит на PHP

<?
//Ваш ключ доступу к API
$api_key="00000000000000000000000000000000";
//Ім'я метода
$method="campaignDelete";
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/1.0/$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"InvalidJSON";
}
else{
if(!empty($jsonObj->error)){
//Помилка отримання переліку підписчиків
echo"Anerroroccured:".$jsonObj->error;}
//Виводимо назву та значення
echo"Here'salistofyourdata:<br>";
data_output($jsonObj->data);
}
}else{
//Помилка з'єднання з API-сервером
echo"APIaccesserror";
}
//Виводимо дані з відступами
functiondata_output($obj,$level=0){
if(is_array($obj)||is_object($obj)){
if(is_object($obj)){
$obj=(array)$obj;
}
echocount($obj)>1?"<br/>n":"";
foreach($objas$key=>$value){
//itwasobject
if(!is_numeric($key)){
$prefix=str_repeat(" ",$level-1);
echo$prefix.$key.":";
}
data_output($value,$level+1);
}
}
else{
$prefix=" ";
if($obj===false)$obj='false';
echo$prefix.$obj."<br/>n";
}
}
?>

SOAP Запит

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