callbacks

Оповещение об отписке, подтверждении обратного адреса

Данный метод является уже устаревшим, мы сделали новую возможность оповещать вас о разных системных событиях - Webhook. Мы настоятельно рекомендуем вам перейти на использование webhooks, так как данная модель является менее затратной в плане ресурсов, в силу использования модели push, а не pull. Тоесть не вы опрашиваете наш сервис, а мы вам сообщим когда наступит событие. К тому же хуки доступны теперь всем пользователям, а не только реселлерам.

Реселлер может обратиться в техподдержку и зарегистрировать URL для одного или нескольких событий, при возникновении которых наша система будет обращаться по этим URL и с помощью HTTPS GET запроса передавать аргументы, уведомляющие о событии. В системе хранится очередь таких сообщений, и если Ваш сервер не был доступен, в течение суток будут производиться дополнительные попытки вызова позднее.

  • email_check_callback - уведомление о подтверждении обратного адреса
  • unsubscribe_callback - уведомление об отписке адресата
  • campaign_status_callback - уведомление о запуске рассылки
  • user_registration_callback - уведомление о новом пользователе
  • user_payment_callback - уведомление о новом поступлении на счёт
  • user_info_callback - уведомление об изменении данных профиля пользователя

Email Check Callback

Вызывается после подтверждения отправителем обратного адреса путём перехода по ссылке из отправленного ему письма.

Аргументы
api_key Ключ доступа к API пользователя, который подтвердил обратный адрес. Т.к. он известен только нашей и вашей системе, можно его использовать для проверки правомочности вызова. Кроме того, он уникален для каждого пользователя, и его можно использовать как альтернтативу идентификации по полю login.
login Логин пользователя, который подтвердил обратный адрес.
email E-mail, право использования которого в качестве обратного адреса подтверждено пользователем.

Unsubscribe Callback

Вызывается после отписки адресата.

Аргументы
api_key Ключ доступа к API пользователя, чей адресат отписался. Т.к. ключ известен только нашей и вашей системе, можно его использовать для проверки правомочности вызова. Кроме того, он уникален для каждого пользователя, и его можно использовать как альтернтативу идентификации по полю login.
login Логин пользователя, чей адресат отписался.
email E-mail отписавшегося.
list_id Код списка, от которого отписались. 0 означает, что отписались от всех списков.
reason Причина отписки, если адресат её указал.

Campaign Status Callback

Вызывается не при любых сменах статуса рассылки. Гарантируется вызов только в следующих случаях:

  • После попытки отправки "отложенной" рассылки (см. аргумент "defer" метода createCampaign)
  • После рассмотрения отложенной из-за модерации рассылки.
  • После смены статуса рассылки на 'completed' или 'analysed'
Аргументы
api_key Ключ доступа к API пользователя, чья рассылка. Т.к. он известен только нашей и вашей системе, можно его использовать для проверки правомочности вызова. Кроме того, он уникален для каждого пользователя, и его можно использовать как альтернтативу идентификации по полю login.
login Логин пользователя, чья рассылка.
campaign_id Идентификатор рассылки, который был возвращён вызовом метода createCampaign.
status Статус рассылки. Возможные варианты:
  • waits_censor - рассылка ожидает проверки
  • censor_hold - фактически эквивалентна waits_censor: рассмотрена администратором, но отложена для дальнейшей проверки
  • declined - рассылка отклонена администратором
  • waits_schedule - задание на постановку рассылки в очередь получено и рассылка ждёт постановки в очередь. Обычно рассылка в этом состоянии находится одну-две минуты перед тем, как перейти в состояние scheduled.
  • scheduled - рассылка запланирована к запуску. Как только настанет время отправки, она будет запущена.
  • in_progress - рассылка выполняется.
  • analysed - все сообщения отправлены, идёт анализ результатов.
  • completed - все сообщения отправлены и анализ результатов закончен.
  • stopped - рассылка поставлена "на паузу".
  • canceled - рассылка отменена (обычно из-за нехватки денег или по желанию пользователя).
contact_count Количество контактов в рассылке.
period_messages Количество сообщений, отправленных за счёт включённых в период. Для SMS-сообщений всегда равно 0.
prepaid_messages Количество сообщений, отправленных за счёт ранее купленных. Для SMS-сообщений всегда равно 0.
pay_sum Сумма за отправку писем.
currency Трёхбуквенный международный код валюты, в которой посчитана сумма за отправку писем (RUB, USD, EUR, UAH).

User Registration Callback

Вызывается после регистрации нового пользователя.

Аргументы
api_key Ключ доступа к API зарегистрировавшегося пользователя. Т.к. он известен только нашей и вашей системе, можно его использовать для проверки правомочности вызова. Кроме того, он уникален для каждого пользователя, и его можно использовать как альтернтативу идентификации по полю login.
login Логин зарегистрировавшегося пользователя.

User Payment Callback

Вызывается после поступления новых средств на счёт пользователя или их списания. Для реселлеров возможны два вызова подряд - сначала операция со счётом пользователя, затем операция со счётом самого реселлера.

Аргументы
api_key Ключ доступа к API пользователя, на счёт которого поступили/со счёта которого были списаны средства. Т.к. он известен только нашей и вашей системе, можно его использовать для проверки правомочности вызова. Кроме того, он уникален для каждого пользователя, и его можно использовать как альтернтативу идентификации по полю login.
login Логин пользователя, на счёт которого поступили средства.
sum Сумма поступивших/списанных средств, число с десятичной точкой с точностью до 4 знаков. Положительное в случае поступления и отрицательное в случае списания.
sum_bonus Сумма поступивших/списанных бонусных средств, число с десятичной точкой с точностью до 4 знаков. Положительное в случае поступления и отрицательное в случае списания. Бонус начисляется, например, при вводе купона. Если у пользователя положительный и основной, и бонусный баланс, то списание средств выполняется сначала с бонусного счёта.
currency Код валюты. На момент написания документации возможны RUB, USD, EUR, UAH.
description Описание платежа.
new_balance Новый баланс пользователя после поступления средств, число с десятичной точкой с точностью до 4 знаков.
new_balance_bonus Новый бонусный баланс пользователя после поступления средств, число с десятичной точкой с точностью до 4 знаков.

User Info Callback

Вызывается при изменении данных в профиле самим пользователем, а так же при изменении данных пользователя Администратором (сотрудниками компании).
Передаются только те аргументы, значения которых были изменены пользователем или Администратором.

Аргументы
api_key Ключ доступа к API пользователя, данные которого были изменены. Т.к. он известен только нашей и вашей системе, можно его использовать для проверки правомочности вызова. Кроме того, он уникален для каждого пользователя, и его можно использовать как альтернтативу идентификации по полю login.
login Логин пользователя.
email Адрес электронной почты пользователя
firstname Имя пользователя
middlename Отчество пользователя
firstname Фамилия пользователя
phone Контактный телефон пользователя
company Название организации, указанное пользователем
timezone Часовой пояс пользователя
master Указан логин основного пользователя, если пользователь является дополнительным.
country Трехсимвольный код страны пользователя (например: RUS, ENG, FJI и т.п.)
language Двухсимвольный код языка пользователя (например: ru, eng, de и т.п.)
rights Права пользователя в системе