SMS-ACTIVATE
Browser
- В чем разница обычного запроса и Webhook
- Как работает Webhook
- Как начать использовать Webhook
Мы усовершенствовали Webhook — самое время напомнить, что при использовании API Webhook поможет значительно ускорить работу. Это касается и активаций, и аренды.
Webhook — современный и удобный механизм интеграции, который оптимизирует использование нашего API. В контексте SMS-активации вебхук используется для автоматической передачи содержимого входящих SMS на указанный вами URL-адрес. Простыми словами, он позволяет передавать информацию с нашего сервера на ваш POST-запросом.
В чем разница обычного запроса и Webhook
Как происходит запрос СМС без Webhook в случае с активацией:
- На вашей стороне формируется запрос на получение СМС;
- Запрос отправляется постоянно до тех пор, пока СМС не будет получено. Частоту запросов настраивает пользователь, но в любом случае, вы либо расходуете лимит RPS, либо тратите лишнее время. По достижении лимита регистрации остановятся (= простой).
Как работает Webhook
Активация:
- Пользователь настраивает адрес, куда будут отправляться вебхуки;
- Происходит покупка номера;
- После прихода СМС на номер на адрес пользователя поступает код — без дополнительных действий со стороны пользователя;
- Ваш сервер должен ответить HTTP-кодом 200, чтобы подтвердить успешное получение данных.
Аренда:
Тот же алгоритм, небольшая разница: клиент явно передает адрес при каждой покупке номера.
В чем польза:
Вы не отправляете запрос, а принимаете POST-запрос. При этом RPS не расходуются.
Как начать использовать Webhook
Если вы используете самописное ПО для регистрации или бота:
- Получите URL-адреса для вебхука: создайте сервер, который будет принимать HTTP-запросы. Это может быть ваш собственный сервер или сервис, предоставляющий возможность принимать вебхуки.
-
Активируйте вебхуки в аккаунте SMS-Activate: в правом верхнем углу
сайта кликните
«Профиль», проксрольте
страницы до пункта «Адреса Webhook активаций», кликните «Адреса
Webhook активаций». Введите адрес.
Ваш сервер должен быть настроен для обработки входящих POST-запросов. Пример данных, которые вы получите, может выглядеть следующим образом:
{
"activationId": 123456,
"service": "go",
"text": "Sms text",
"code": "12345",
"country": 0,
"receivedAt": "2023-01-01 12:00:00"
}
Обратите внимание на поля:
- activationId: идентификатор активации, на которую пришла SMS.
- text: текст полученной SMS.
- receivedAt: время получения SMS в формате YYYY-MM-DD HH:mm:ss
- code: код из SMS.
- service: сервис активации.
- country: страна активации.
Если вы используете сторонний софт, запросите добавление webhook SMS-Activate. Работа станет быстрее.
На любые вопросы касательно интеграции по API ответит специально подготовленный сотрудник нашей техподдержки.
