API для email и SMS-рассылок

API для обычных рассылок

Для того, чтобы использовать API, необходимо скачать библиотеку SendExpert API тут.

Все данные передаются в кодировке UTF8. Возвращаемое значение в виде ассоциативного массива закодированного в виде JSON: {"error":"","result":[...]}.

В случае ошибки в параметре «error» передается символьный код ошибки. В случае успеха данный параметр будет пустой. Результат передается в параметре «result» в зависимости от вызываемой функции.

Пример использования SendExpert API

                    
                        # подключаем библиотеку
                        require_once 'SendExpertAPI.php';

                        # ID пользователя
                        $user_id = '1';

                        # Секретный ключ, который отображается в личном кабинете
                        $user_private_key = 'e10adc3xxxxxbe56e057f20f883e';

                        # создаем объект API указав в конструкторе ключи
                        $api = new cSendExpertAPI($user_id, $user_private_key);

                        echo "Получить отчет SMS-рассылки";
                        $res = $api->getSMSReport($project_ID = 96, $ID = 83);
                        if ($res['error'] == ""){
                            print_r($res['result']);
                        } else {
                            echo "Ошибка: ".$res['error'];
                        }
                    
                

Получить список проектов текущего пользователя

Вызов

getProjects

Входные параметры

Результат возврата

Список проектов текущего пользователя:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [name] => ProjectName1
            [ID] => 1
        )

    [1] => Array
        (
            [name] => ProjectName2
            [ID] => 52
        )
}
				 
            

Получить список полей базы для проекта

Вызов

getProjectsStructure

Входные параметры

Результат возврата

Список полей базы для проекта:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [name] => Электронный адрес
            [ID] => 1
            [type] => email
        )

    [1] => Array
        (
            [name] => Имя
            [ID] => 2
            [type] => text
        )
}
				 
            

Получить всех подписчиков (экспорт)

Вызов

getSubscribers

Входные параметры

Результат возврата

Список подписчиков:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [ID] => 23
            [1] => [email protected]
            [2] => Лилия
            [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412936959
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )

    [1] => Array
        (
            [ID] => 34
            [1] => [email protected]
            [2] => Анна
	    [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412937514
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )
)
				 
            

Получить список пользователей по телефону или по его части

Вызов

getSubscribersByPhone

Входные параметры

Например

				
                    $phone = '38(067)';
				
            

Результат возврата

Список пользователей:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [ID] => 1
            [1] => [email protected]
            [2] => Евгений
            [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412937697
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )

    [1] => Array
        (
            [ID] => 12
            [1] => [email protected]
            [2] => Ольга
            [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412937023
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )
}
				 
            

Получить список пользователей по email или по его части

Вызов

getSubscribersByEmail

Входные параметры

Например

				
                    $email = '@gmail.com';
				
            

Результат возврата

Список пользователей:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [ID] => 23
            [1] => [email protected]
            [2] => Василий
            [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412936959
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )

    [1] => Array
        (
            [ID] => 34
            [1] => [email protected]
            [2] => Иван
	    [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412937514
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )
}
				 
            

Добавить подписчика

Вызов

addSubscriber

Входные параметры

Например

				
$subscriber = array();
$subscriber[100] = '[email protected]';
$subscriber[500] = 'Тарас';
$subscriber["groups"] = array('31','54');
$responder = array(123,124);
				
            

Результат возврата

Массив:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [ID] => 23
            [1] => [email protected]
            [2] => Василий
            [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412936959
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )

    [1] => Array
        (
            [ID] => 34
            [1] => [email protected]
            [2] => Иван
	    [GROUPS] => Array
                (
                    [0] => Array
                        (
                            [ID] => 31
                            [name] => ProjectName1
                        )

                )

            [DATE] => 1412937514
            [UNSUBSCRIBED] => 0
            [DISABLE] => 0
            [ACTIVATED] => 1
        )
}
				 
            

Редактировать подписчика

Вызов

editSubscriber

Входные параметры

Например

				
$subscriber = array();
$subscriber[2] = 'Тарас1';
$subscriber["GROUPS"] = array();
				
            

Результат

“OK” в случае успешного изменения данных

Удалить подписчика

Вызов

deleteSubscriber

Входные параметры

Результат

“OK” в случае успешного изменения данных

Получить обратные адреса электронной почты

Вызов

getSenderEmails

Входные параметры

Результат возврата

Массив элементов:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [email] => [email protected]
            [ID] => 6
            [checked] => 1
        )

    [1] => Array
        (
            [email] => [email protected]
            [ID] => 23
            [checked] => 1
        )
)
				 
            

Получить список групп

Вызов

getGroupsList

Входные параметры

Результат возврата

Список групп:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [name] => Группа 1
            [ID] => 100
        )
    [1] => Array
        (
            [name] => Группа 2
            [ID] => 500
        )

)
				 
            

Добавить группу

Вызов

addGroup

Входные параметры

Результат возврата

В случае успешного результата:

Список возможных ошибок:

Пример ответа

				  
Array
(
    [ID] => 100
)
				 
            

Получить список Альфа-имен для SMS

Вызов

getAlphaNames

Входные параметры

Результат возврата

Список Альфа-имен:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [name] => SENDEXPERT
            [ID] => 29
            [checked] => 1
        )

)
				 
            

Отправить SMS-сообщение подписчикам

Вызов

sendSMS

Входные параметры

Например

				
$subscribers = array();
$subscribers[] = 337361;
$subscribers[] = 43235;
$message = "Привет {{Имя}}! Это тест API!";
$date = mktime();
$res = $api->sendSMS($project_ID = 96, $alphaname_id = 29, $subscribers, $message, $date);
				
            

Результат возврата

Массив:

Пример ответа

				  
Array
(
    [ID] => 84
)
				 
            

Получить список SMS-рассылок

Вызов

getSMSList

Входные параметры

Например

				
$time_start = strtotime("-2 days");
$time_end = time();
$res = $api->getSMSList($project_ID = 96, $time_start, $time_end);
				
            

Результат возврата

Список SMS-рассылок в формате:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [ID] => 84
            [alphanameID] => 29
            [body] => SMS работает!
            [time_start] => 1437135207
            [type] => in_proccess
            [date_create] => 2015-07-17 12:13:28
            [price] => 0.023399
        )

    [1] => Array
        (
            [ID] => 83
            [alphanameID] => 29
            [body] => Привет {{Имя}}! Это тест API!
            [time_start] => 1436799595
            [type] => sended
            [date_create] => 2015-07-13 15:00:23
            [price] => 0.023399
        )
)
				 
            

Получить отчёт SMS-рассылки

Вызов

getSMSReport

Входные параметры

Результат возврата

Список SMS-рассылок в формате:

Пример ответа

				  
Array
(
    [total] => 1
    [sended] => 1
    [delivered] => 0
    [not_delivered] => 0
    [not_exist] => 0
    [alphanameID] => 29
    [body] => Привет {{Имя}}! Это тест API!
    [time_start] => 1436799595
    [type] => sended
    [date_create] => 2015-07-13 15:00:23
    [price] => 0.023399
)
				 
            

Получить список email-рассылок

Вызов

getMailList

Входные параметры

Например

				
$time_start = strtotime("-2 days");
$time_end = time();
$res = $api->getMailList($project_ID = 96, $time_start, $time_end);
				
            

Результат возврата

Список email-рассылок в формате:

Пример ответа

				  
Array
(
    [0] => Array
        (
            [ID] => 827
            [fromID] => 160
            [sender_name] => ИмяОтправителя
            [subject] => Тема письма для {{Имя}}!
            [body] => Привет {{Имя}}! Это тест API!
            [alternate_body] => Привет {{Имя}}! Это тест API!
            [images_place] => server
            [time_start] => 1436883244
            [type] => sended
            [date_create] => 2015-07-14 14:14:29
        )

    [1] => Array
        (
            [ID] => 826
            [fromID] => 160
            [sender_name] => Апи
            [subject] => Тема письма!
            [body] => Тест работает. Ура!
            [alternate_body] => Тест работает. Ура!
            [images_place] => server
            [time_start] => 1436883216
            [type] => sended
            [date_create] => 2015-07-14 14:14:28
        )
)
				 
            

Получить отчёт email-рассылки

Вызов

getMailReport

Входные параметры

Результат возврата

Список email-рассылок в формате:

Пример ответа

				  
Array
(
    [total] => 2
    [sended] => 2
    [delivered] => 2
    [opened] => 1
    [with_moving] => 0
    [moved] => 0
    [not_delivered] => 0
    [unsubscribed] => 0
    [unsubscribed_as_spam] => 0
    [fromID] => 160
    [sender_name] => Тест
    [subject] => Привет {{Имя}} - {{Номер телефона}} - {{Электронный адрес}}
    [body] => Тело письма
    [alternate_body] =>
    [images_place] => server
    [time_start] => 1432044523
    [type] => sended
    [date_create] => 2015-05-19 14:13:17
}
				 
            

Получить список автоответчиков для API

Вызов

getResponderList

Входные параметры

Результат возврата

Список email-рассылок в формате:

                                  
Array
(
    [days] — количество дней до старта автоответчика;
    [time_hour] — количество часов;
    [time_minutes] — количество минут.
)
                                
                            

Пример ответа

				  
Array
(
    [0] => Array
        (
            [ID] => 19
            [mailID] => 819
            [time_type] => timeleft
            [time_send] => Array
                (
                    [days] => 0
                    [time_hour] => 0
                    [time_minutes] => 5
                )

        )

)
				 
            

Отправить Email-сообщение подписчикам

Вызов

sendMail

Входные параметры

Например

				
$subscribers = array();
$subscribers[] = 337361;
$subscribers[] = 438106;
$subject = "Тема письма для {{Имя}}!";
$message = "Привет {{Имя}}! Это тест API!";
$sender_id = 160;
$sender_name = "Имя Отправителя";
$date = mktime();
$filter_id = 0;
$group_id = 0;
$res = $api->sendMail($project_ID = 96, $subscribers, $subject, $message, $sender_id, $sender_name, $date, $filter_id, $group_id);
				
            

Результат возврата

Массив:

Пример ответа

				  
Array
(
    [ID] => 828
)