• Главная
• Ресурсы
• Документация
• API
• Callbacks

Обратные вызовы (callbacks)

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

• email_check_callback — уведомление о подтверждении обратного адреса;
• unsubscribe_callback — уведомление об отписке адресата;
• activate_callback — уведомление об активации адресов;
• reject_callback — уведомление об отказе в активации адресов;
• campaign_status_callback — уведомление о запуске рассылки.
• user_registration_callback - уведомление о новом пользователе
• user_payment_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 означает, что отписались от всех списков.

Activate Callback

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

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

Reject Callback

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

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

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 знаков. Положительное в случае поступления и отрицательное в случае списания.
currency	Код валюты. На момент написания документации возможны RUB, USD, EUR, UAH.
description	Описание платежа.
new_balance	Новый баланс пользователя после поступления средств, число с десятичной точкой с точностью до 4 знаков.