API документация
campaignSmsNew (string ApiKey, array int list_id, string title, string message, string senderName, bool isTransactional)
Метод создает новую смс-рассылку.
Параметры | ||
apikey | Ключ доступа к API вашего аккаунта | |
list_id |
Id списка рассылки, полученный командой listsGetAll — для конкретного списка, или несколько значений через запятую (только для платных пользователей). |
|
title | Название сообщения рассылки | |
message | Содержание сообщения рассылки | |
senderName | Альфа-имя (имя отправителя смс) | |
isTransactional | Тип sms-рассылки: обычная или транзакционная (true/false) | |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json |
Возвращаемое значение: Данные созданной рассылки | ||||
success | Значение 1 при успешном вызове метода, 0 при ошибке | |||
errors | Количество ошибок при вызове метода | |||
error | Текстовое описание ошибки | |||
code | Код ошибки | |||
warning | Дополнительные предупреждения, для xml не выводится при значении null | |||
data | Массив с поставленной в расписание рассылкой | |||
SmsCampaign | Массив с данными рассылки | |||
id | номер рассылки | |||
title | название рассылки | |||
senderName | альфа-имя (имя отправителя смс) | |||
maillist_id | массив с номерами списков, на которые отправлена рассылка | |||
int | Номер списка | |||
count_sms | количество sms, необходимых для отправки | |||
count_subscribers | количество подписчиков в рассылке | |||
message | содержание sms | |||
status | статус рассылки | |||
isTransactonal | транзакционная рассылка | |||
isPublic | публичная рассылка | |||
create | дата и время создания рассылки | |||
schedule | запланированное время отправки смс-рассылки |
<ResultOfCampaign> <success>int</success> <errors>int</errors> <code>int</code> <warning>string</warning> <data> <SmsCampaign> <id>int</id> <title>string</title> <senderName>string</senderName> <maillist_id>string</maillist_id> <count_sms>string</count_sms> <count_subscribers>string</count_subscribers> <message>string</message> <status>string</status> <isTransactional>string</isTransactional> <isPublic>string</isPublic> <create>string</create> </SmsCampaign> </data> </ResultOfSmsCampaign>
{ "success":1, "errors":0, "error":"", "warning":"", "data": [{"id":int, "title":"string", "senderName":"string", "maillist_id":[int], "count_sms": int, "count_subscribers":int; "message":"string", "status":"string", "isTransactonal": boolean, "isPublic": boolean, "create":datetime, "schedule":datetime }] }
<? //Ваш ключ доступа к API $api_key="00000000000000000000000000000000"; //Имя метода $method="campaignSmsNew"; echo"Method:".$method."<br>"; //параметры $list_id="0001"; $subject="test"; $html=urlencode("<html>test</html>"); $parameters="apikey=$api_key&list_id=$list_ids&title=$title&message=$message &senderNames=$senderNames&isTransactional=$isTransactonal"; 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"; } } ?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:campaignSmsNew> <tem:apikey>string</tem:apikey> <tem:list_id>string</tem:list_id> <tem:title>string</tem:title> <tem:message>string</tem:message> <tem:senderNames>string</tem:senderNames> <tem:isTransactional>string</tem:isTransactional> </tem:campaignSmsNew> </soapenv:Body> </soapenv:Envelope>
campaignSmsSendNow (string ApiKey, int campaign_Id)
Метод отправляет созданную ранее смс-рассылку.
Параметры | |
apikey | Ключ доступа к API вашего аккаунта |
campaign_Id | Номер рассылки, полученный командой campaignSmsNew |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json |
Форма запроса: https://api.feedgee.com/1.0/campaignSmsSendNow?apikey=API_KEY&campaign_Id=CAMPAIGN_ID
Возвращаемое значение: Данные отправленной рассылки | ||||
success | Значение 1 при успешном вызове метода, 0 при ошибке | |||
errors | Количество ошибок при вызове метода | |||
error | Текстовое описание ошибки | |||
code | Код ошибки | |||
warning | Дополнительные предупреждения, для xml не выводится при значении null | |||
data | Массив с поставленной в расписание рассылкой | |||
SmsCampaign | Массив с данными рассылки | |||
id | номер рассылки | |||
title | название рассылки | |||
senderName | альфа-имя (имя отправителя смс) | |||
maillist_id | массив с номерами списков, на которые отправлена рассылка | |||
int | Номер списка | |||
count_sms | количество sms, необходимых для отправки | |||
count_subscribers | количество подписчиков в рассылке | |||
message | содержание sms | |||
status | статус рассылки | |||
isTransactonal | транзакционная рассылка | |||
isPublic | публичная рассылка | |||
create | дата и время создания рассылки | |||
schedule | запланированное время отправки смс-рассылки |
<ResultOfSmsCampaign> <success>int</success> <errors>int</errors> <error>string</error> <code>int</code> <warning>string</warning> <data> <SmsCampaign> <id>int</id> <title>string</title> <senderName>string</senderName> <maillist_id>string</maillist_id> <count_sms>string</count_sms> <count_subscribers>string</count_subscribers> <message>int</message> <status>string</status> <isTransactional>string</isTransactional> <isPublic>string</isPublic> <create>string</create> <schedule>string</schedule> </SmsCampaign> </data> </ResultOfSmsCampaign>
{ "success":1, "errors":0, "error":"", "warning":"", "data": [{"id":int, "title":"string", "senderName":"string", "maillist_id":[int], "count_sms": int, "count_subscribers":int; "message":"string", "status":"string", "isTransactonal": boolean, "isPublic": boolean, "create":datetime, "schedule":datetime }] }
<? //Ваш ключ доступа к API $api_key="00000000000000000000000000000000"; //Имя метода $method="campaignSmsSendNow"; 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" ; }
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:campaignSmsSendNow> <tem:apikey>string</tem:apikey> <tem:campaign_id>int</tem:campaign_id> </tem:campaignSmsSendNow> </soapenv:Body> </soapenv:Envelope>
campaignSmsSchedule (string ApiKey, int campaign_Id, stringdate_time)
Метод позволяет поставить в расписание созданную ранее смс-рассылку.
Параметры | |
apikey | Ключ доступа к API вашего аккаунта |
campaign_Id | Номер рассылки, полученный командой campaignSmsNew |
date_time |
Запланированные дата и время отправки в формате MM/DD/YYYY HH: MM: SS |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить дополнительный параметр &output=json |
Форма запроса: https://api.feedgee.com/1.0/campaignSmsSchedule?apikey=API_KEY&campaign_Id=CAMPAIGN_ID&date_time=DATE_TIME
Возвращаемое значение: Данные поставленной в расписание рассылки | ||||
success | Значение 1 при успешном вызове метода, 0 при ошибке | |||
errors | Количество ошибок при вызове метода | |||
error | Текстовое описание ошибки | |||
code | Код ошибки | |||
warning | Дополнительные предупреждения, для xml не выводится при значении null | |||
data | Массив с поставленной в расписание рассылкой | |||
SmsCampaign | Массив с данными рассылки | |||
id | Номер рассылки | |||
title | Название рассылки | |||
senderName | Альфа-имя (имя отправителя смс) | |||
maillist_id | Массив с номерами списков, на которые отправлена рассылка | |||
int | Номер списка | |||
count_sms | Количество sms, необходимых для отправки | |||
count_subscribers | Количество подписчиков в рассылке | |||
message | Содержание sms | |||
status | Статус рассылки | |||
isTransactonal | Транзакционная рассылка | |||
isPublic | Публичная рассылка | |||
create | Дата и время создания рассылки | |||
schedule | Запланированное время отправки смс-рассылки |
<ResultOfSmsCampaign> <success>int</success> <errors>int</errors> <error>string</error> <code>int</code> <warning>string</warning> <data> <SmsCampaign> <id>int</id> <title>string</title> <senderName>string</senderName> <maillist_id>string</maillist_id> <count_sms>string</count_sms> <count_subscribers>string</count_subscribers> <message>string</message> <status>string</status> <isTransactional>string</isTransactional> <isPublic>string</isPublic> <create>string</create> <schedule>string</schedule> </SmsCampaign> </data> </ResultOfSmsCampaign>
{ "success":1, "errors":0, "error":"", "warning":"", "data": [{"id":int, "title":"string", "senderName":"string", "maillist_id":[int], "count_sms": int, "count_subscribers":int; "message":"string", "status":"string", "isTransactonal": boolean, "isPublic": boolean, "create":datetime, "schedule":datetime }] }
<? //Ваш ключ доступа к API $api_key="00000000000000000000000000000000"; //Имя метода $method="campaignSmsSchedule"; 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(" ",$level-1); echo$prefix.$key.":"; } data_output($value,$level+1); } } else{ $prefix=" "; if($obj===false)$obj='false'; echo$prefix.$obj."<br/>n"; } } ?>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:campaignSmsSchedule> <tem:apikey>string</tem:apikey> <tem:campaign_id>int</tem:campaign_id> <tem:date_time>string</tem:date_time> </tem:campaignSmsSchedule> </soapenv:Body> </soapenv:Envelope>
analyticsSmsGetResults (string apikey, int campaign_id)
Метод выводит основные показатели аналитики смс-рассылки.
Параметры | |
apikey | Ключ доступа к API вашего аккаунта |
campaign_id | Номер рассылки |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить опциональный параметр &output=json |
Форма запроса: https://api.feedgee.com/1.0/analyticsSmsGetResults?apikey=APIKEY&campaign_Id=CAMPAIGN_ID
Возвращаемое значение | |||||
success | Количество успешных запросов | ||||
errors | Количество ошибок при вызове метода | ||||
error | Текстовое описание ошибки | ||||
code | Код ошибки | ||||
warning | Дополнительные предупреждения, для xml не выводится при значении null | ||||
data | Массив с данными аналитики | ||||
analyticsSmsGetResults | Массив с основными показателями рассылки | ||||
campaign_name | Название рассылки | ||||
campaign_subject | Тема рассылки | ||||
sent | Количество подписчиков, которым рассылка была отправлена | ||||
delivered | Количество подписчиков, получивших рассылку | ||||
undelivered | Количество подписчиков, не получивших рассылку | ||||
pending | Количество подписчиков, ожидающих получения рассылки |
<ResultOfSmsAnalyticsAbuseReports> <success>int</success> <errors>int</errors> <error>string</error> <code>int</code> <warning>string</warning> <data> <analyticsSmsGetResults> <campaign_name>string</campaign_name> <campaign_subject>string</campaign_subject> <campaign_sentdate>string</campaign_sentdate> <sent>int</sent> <delivered>int</delivered> <undelivered>int</undelivered> <pending>int</pending> </SmsAnalyticsAbuseReports> </data> </ResultOfSmsAnalyticsAbuseReports>
{ "success":1, "errors":0, "error":"", "warning":"" "data": [{"campaign_name":"string", "campaign_subject":"string", "campaign_sentdate":"string", "sent":"2", "delivered":"1", "undelivered":"1", "pending":"0",}] }
<? //Ваш ключ доступа к API $api_key=""; //Имя метода $method="analyticsSmsGetResults"; echo"Method:".$method."<br>"; //параметры $campaign_id=""; $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); if($result){ //Раскодируем ответ API-сервера $jsonObj=json_decode($result); if(null===$jsonObj){ //Ошибка в полученном ответе echo"InvalidJSON"; } else{ //Ошибка получения перечня подписчиков if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";} //Выводим названия и значения echo"Here'salistofyourdata:<br>"; foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons foreach($jsonsas$key=>$custom){ if(is_array($custom)){ echo$key.":<br/>"; foreach($customas$one){ echo" ->".$one->name.":".$one->value."<br/>"; } }else{ echo$key.":".$custom."<br/>"; } } } } }else{ //Ошибка соединения с API-сервером echo"APIaccesserror"; } ?>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:analyticsSmsGetResults> <tem:apikey>string</tem:apikey> <tem:campaign_id>int</tem:campaign_id> </tem:analyticsSmsGetResults> </soapenv:Body> </soapenv:Envelope>
analyticsSmsSent (string apikey, int campaign_id, int start, int count, string filterPhoneNumbers)
Метод выводит из аналитики смс-рассылки список подписчиков, которым рассылка отправлена.
Параметры | |
apikey | Ключ доступа к API вашего аккаунта |
campaign_id | Номер рассылки |
start | Номер первого подписчика (по умолчанию = 1, значение опционально — может быть пустым) |
count | Количество возвращаемых записей подписчиков (по умолчанию = 10000, не больше 10000 за один запрос, значение опционально — может быть пустым) |
filterPhoneNumbers | Список телефонных номеров подписчиков (значение опционально — может быть пустым). |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить опциональный параметр &output=json |
Возвращаемое значение | |||||
success | Количество успешных запросов | ||||
errors | Количество ошибок при вызове метода | ||||
error | Текстовое описание ошибки | ||||
code | Код ошибки | ||||
warning | Дополнительные предупреждения, для xml не выводится при значении null | ||||
data | Массив с данными подписчиков, которым рассылка отправлена | ||||
AnalyticsSmsSent | Массив с данными подписчиков, которым рассылка отправлена | ||||
phone_number | Номер телефона подписчика |
<ResultOfAnalyticsSmsSent> <success>int</success> <errors>int</errors> <error>string</error> <code>int</code> <warning>string</warning> <data> <AnalyticsSmsSent> <phone_number>string</phone_number> </AnalyticsSmsSent> </data> </ResultOfAnalyticsSmsSent>
{ "success":1, "errors":0, "error":"", "code":0, "warning":"", "data": [{"pnone_number":"string",}] }
<? //Ваш ключ доступа к API $api_key=""; //Имя метода $method="analyticsSmsSent"; echo"Method:".$method."<br>"; //параметры $campaign_id=""; $start="1"; $count="10"; $filterPhoneNumbers="..." $parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterPhoneNumbers=$filterPhoneNumbers"; 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"InvalidJSON"; } else{ //Ошибка получения перечня подписчиков if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";} //Выводим названия и значения echo"Here'salistofyourdata:<br>"; foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons foreach($jsonsas$key=>$custom){ if(is_array($custom)){ echo$key.":<br/>"; foreach($customas$one){ echo" ->".$one->name.":".$one->value."<br/>"; } }else{ echo$key.":".$custom."<br/>"; } } } } }else{ //Ошибка соединения с API-сервером echo"APIaccesserror"; } ?>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:analyticsSmsSent> <tem:apikey>string</tem:apikey> <tem:campaign_id>int</tem:campaign_id> <tem:start>int</tem:start> <tem:count>int</tem:count> <tem:filterPhoneNumbers>string</tem:filterPhoneNumbers> </tem:analyticsSmsSent> </soapenv:Body> </soapenv:Envelope>
analyticsSmsPending (string apikey, int campaign_id, int start, int count, string filterPhoneNumbers)
Метод выводит из аналитики смс-рассылки список подписчиков, ожидающих доставки сообщения.
Параметры | |
apikey | Ключ доступа к API вашего аккаунта |
campaign_id | Номер рассылки |
start | Номер первого подписчика (по умолчанию = 1, значение опционально — может быть пустым) |
count | Количество возвращаемых записей подписчиков (по умолчанию = 10000, не больше 10000 за один запрос, значение опционально — может быть пустым) |
filterPhoneNumbers | Список телефонных номеров подписчиков (значение опционально — может быть пустым). |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить опциональный параметр &output=json |
Возвращаемое значение | |||||
success | Количество успешных запросов | ||||
errors | Количество ошибок при вызове метода | ||||
error | Текстовое описание ошибки | ||||
code | Код ошибки | ||||
warning | Дополнительные предупреждения, для xml не выводится при значении null | ||||
data | Массив с данными подписчиков, ожидающих доставки sms-рассылки | ||||
AnalyticsSmsPending | Массив с данными подписчиков, ожидающих доставки sms-рассылки | ||||
phone_number | Номер телефона подписчика |
<ResultOfAnalyticsSmsPending> <success>int</success> <errors>int</errors> <error>string</error> <code>int</code> <warning>string</warning> <data> <AnalyticsSmsPending> <phone_number>string</phone_number> </AnalyticsSmsPending> </data> </ResultOfAnalyticsSmsPending>
{ "success":1, "errors":0, "error":"", "code":0, "warning":"", "data": [{"pnone_number":"string",}] }
<? //Ваш ключ доступа к API $api_key=""; //Имя метода $method="analyticsSmsPending"; echo"Method:".$method."<br>"; //параметры $campaign_id=""; $start="1"; $count="10"; $filterPhoneNumbers="..." $parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterPhoneNumbers=$filterPhoneNumbers"; 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"InvalidJSON"; } else{ //Ошибка получения перечня подписчиков if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";} //Выводим названия и значения echo"Here'salistofyourdata:<br>"; foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons foreach($jsonsas$key=>$custom){ if(is_array($custom)){ echo$key.":<br/>"; foreach($customas$one){ echo" ->".$one->name.":".$one->value."<br/>"; } }else{ echo$key.":".$custom."<br/>"; } } } } }else{ //Ошибка соединения с API-сервером echo"APIaccesserror"; } ?>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:analyticsSmsPending> <tem:apikey>string</tem:apikey> <tem:campaign_id>int</tem:campaign_id> <tem:start>int</tem:start> <tem:count>int</tem:count> <tem:filterPhoneNumbers>string</tem:filterPhoneNumbers> </tem:analyticsSmsPending> </soapenv:Body> </soapenv:Envelope>
analyticsSmsDelivered (string apikey, int campaign_id, int start, int count, string filterPhoneNumbers)
Метод выводит из аналитики рассылкисписок подписчиков, получивших смс-рассылки.
Параметры | |
apikey | Ключ доступа к API вашего аккаунта |
campaign_id | Номер рассылки |
start | Номер первого подписчика (по умолчанию = 1, значение опционально — может быть пустым) |
count | Количество возвращаемых записей подписчиков (по умолчанию = 10000, не больше 10000 за один запрос, значение опционально — может быть пустым) |
filterPhoneNumbers | Список телефонных номеров подписчиков (значение опционально — может быть пустым). |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить опциональный параметр &output=json |
Возвращаемое значение | |||||
success | Количество успешных запросов | ||||
errors | Количество ошибок при вызове метода | ||||
error | Текстовое описание ошибки | ||||
code | Код ошибки | ||||
warning | Дополнительные предупреждения, для xml не выводится при значении null | ||||
data | Массив с данными подписчиков, получивших sms-рассылку | ||||
AnalyticsSmsDelivered | Массив с данными подписчиков, получивших sms-рассылку | ||||
phone_number | Номер телефона подписчика |
<ResultOfAnalyticsSmsDelivered> <success>int</success> <errors>int</errors> <error>string</error> <code>int</code> <warning>string</warning> <data> <AnalyticsSmsDelivered> <phone_number>string</phone_number> </AnalyticsSmsDelivered> </data> </ResultOfAnalyticsSmsDelivered>
{ "success":1, "errors":0, "error":"", "code":0, "warning":"", "data": [{"pnone_number":"string",}] }
<? //Ваш ключ доступа к API $api_key=""; //Имя метода $method="analyticsSmsDelivered"; echo"Method:".$method."<br>"; //параметры $campaign_id=""; $start="1"; $count="10"; $filterPhoneNumbers="..." $parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterPhoneNumbers=$filterPhoneNumbers"; 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"InvalidJSON"; } else{ //Ошибка получения перечня подписчиков if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";} //Выводим названия и значения echo"Here'salistofyourdata:<br>"; foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons foreach($jsonsas$key=>$custom){ if(is_array($custom)){ echo$key.":<br/>"; foreach($customas$one){ echo" ->".$one->name.":".$one->value."<br/>"; } }else{ echo$key.":".$custom."<br/>"; } } } } }else{ //Ошибка соединения с API-сервером echo"APIaccesserror"; } ?>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:analyticsSmsDelivered> <tem:apikey>string</tem:apikey> <tem:campaign_id>int</tem:campaign_id> <tem:start>int</tem:start> <tem:count>int</tem:count> <tem:filterPhoneNumbers>string</tem:filterPhoneNumbers> </tem:analyticsSmsDelivered> </soapenv:Body> </soapenv:Envelope>
analyticsSmsUndelivered (string apikey, int campaign_id, int start, int count, string filterPhoneNumbers)
Метод выводит из аналитики смс-рассылки список подписчиков, не получивших сообщение рассылки.
Параметры | |
apikey | Ключ доступа к API вашего аккаунта |
campaign_id | Номер рассылки |
start | Номер первого подписчика (по умолчанию = 1, значение опционально — может быть пустым) |
count | Количество возвращаемых записей подписчиков (по умолчанию = 10000, не больше 10000 за один запрос, значение опционально — может быть пустым) |
filterPhoneNumbers | Список телефонных номеров подписчиков (значение опционально — может быть пустым). |
По умолчанию результат возвращается в формате XML, для получения результата в JSON нужно добавить опциональный параметр &output=json |
Возвращаемое значение | |||||
success | Количество успешных запросов | ||||
errors | Количество ошибок при вызове метода | ||||
error | Текстовое описание ошибки | ||||
code | Код ошибки | ||||
warning | Дополнительные предупреждения, для xml не выводится при значении null | ||||
data | Массив с данными подписчиков, не получивших рассылку | ||||
AnalyticsSmsUndelivered | Массив с данными одного подписчика и причиной недоставки | ||||
phone_number | Номер телефона подписчика | ||||
reason | Причина недоставки | ||||
timestamp | Время регистрации информации про недоставку |
<ResultOfAnalyticsSmsUndelivered> <success>int</success> <errors>int</errors> <error>string</error> <code>int</code> <warning>string</warning> <data> <AnalyticsSmsUndelivered> <phone_number>string</phone_number> <reason>string</reason> </AnalyticsSmsUndelivered> </data> </ResultOfAnalyticsSmsUndelivered>
{ "success":1, "errors":0, "error":"", "code":0, "warning":"", "data": [{"pnone_number":"string", "reason":"string",}] }
<? //Ваш ключ доступа к API $api_key=""; //Имя метода $method="analyticsSmsUndelivered"; echo"Method:".$method."<br>"; //параметры $campaign_id=""; $start="1"; $count="10"; $filterPhoneNumbers="..." $parameters="apikey=$api_key&campaign_id=$campaign_id&start=$start&count=$count&filterPhoneNumbers=$filterPhoneNumbers"; 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"InvalidJSON"; } else{ //Ошибка получения перечня подписчиков if(!empty($jsonObj->error)){echo"Anerroroccured:".$jsonObj->error."<br/>";} //Выводим названия и значения echo"Here'salistofyourdata:<br>"; foreach($jsonObj->dataas$key=>$jsons){//Thiswillsearchinthe2jsons foreach($jsonsas$key=>$custom){ if(is_array($custom)){ echo$key.":<br/>"; foreach($customas$one){ echo" ->".$one->name.":".$one->value."<br/>"; } }else{ echo$key.":".$custom."<br/>"; } } } } }else{ //Ошибка соединения с API-сервером echo"APIaccesserror"; } ?>
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:tem="http://tempuri.org/"> <soapenv:Header/> <soapenv:Body> <tem:analyticsSmsUndelivered> <tem:apikey>string</tem:apikey> <tem:campaign_id>int</tem:campaign_id> <tem:start>int</tem:start> <tem:count>int</tem:count> <tem:filterPhoneNumbers>string</tem:filterPhoneNumbers> <tem:reason>int</tem:reason> </tem:analyticsSmsUndelivered> </soapenv:Body> </soapenv:Envelope>