API-callbacks

Обратные вызовы (callbacks) - это специализированный набор функций API, с помощью которого вы можете удалённо отслеживать различные изменения в вашем аккаунте на MassDelivery в режиме реального времени.

Простыми словами, вместо того чтобы посылать запросы на наш сервер, как бы вы это делали в случае с API, вы наоборот будете принимать запросы от нас и обрабатывать их на своей стороне.

Для реализации работы обратных вызовов вам необходимо перейти в настройки аккаунта во вкладку "API-ключ" и указать URL скрипта, который будет обрабатывать запросы от нашего сервера. При первом сохранении URL-адреса нами будет отправлен GET-запрос к вашему скрипту с параметрами "action=test". Для принятия и успешной работы скрипта, он должен вернуть строку "TEST:OK" (в верхнем регистре). После этого настройка завершена.

Работа с API-callbacks

После того как созданный вами скрипт принят и включен в работу, к нему начнут поступать POST-запросы от нашего сервера такого типа:

http://yoursite/your_script.php?request_id=123&action=subscriber_added

После каждого вызова ваш скрипт должен возвращать строку, включающую в себя ID запроса, код действия и статус ОК, разделены эти данные должны быть двоеточием ( : ).

123:subscriber_added:ok

При получении любых других данных запрос будет расценен как неудачный, и в течение 24 часов каждые 5 минут будет выполняться попытка повторного вызовы вашего скрипта.

Список передаваемых нами параметров в каждом запросе

Абсолютно каждый запрос от нас будет содержать данные параметры.

request_id Уникальный ID запроса. Желательно сохранять его на своей стороне и всегда проверять, чтобы не дублировать события.
date_tstamp Дата события в формате UNIX-времени. Часовой пояс (GMT) Москвы.
date Дата события в формате "ДД/ММ/ГГГГ ЧЧ:ММ:CC". Часовой пояс (GMT) Москвы.
subscriber_id ID подписчика в сервисе MassDelivery
email Электронный адрес подписчика
action Код действия. Могут передаваться дополнительные параметры.

Все значения параметра action

1. Подписчик отписался action=subscriber_unsubscribed. Дополнительно передается параметр delivery_id.

delivery_id ID рассылки, от которой произошла отписка

2. Подписка на рассылку action=subscriber_subscribed. Дополнительно передается параметр delivery_id.

delivery_id ID рассылки, на которую подписчик подписался

3. Подписчик удалил себя из списка автора action=subscriber_deleted.

4. Подписчик активирован action=subscriber_activated.

Значения для action будут дополнятся. Если вам необходимо получать от нас какие то действия которых нет в списке, то вы можете написать нам и нужные действия будут добавлены.

2024 MassDelivery