SMS-ассистент — документация для разработчиков
Отправка одиночных SMS. API PLAIN
Получение статуса доставки SMS
Получить статус доставки SMS можно двумя способами:
1
С помощью API/PLAIN-запроса на получение статуса доставки нужного SMS, инициируемого с вашей стороны. Т. е. вы отправляете запрос — мы в ответ на него отправляем вам статус доставки SMS.
2
С помощью вебхука (webhook)
Webhook — это механизм оповещения системы о событиях. Используя вебхуки, после отправки SMS, вам не нужно самостоятельно дополнительно запрашивать статус доставки SMS, отслеживать его изменение, а также учитывать срок жизни SMS и контролировать интервалы отправки запросов. Как только мы получим конечный статус доставки SMS (или его изменение) от телефонного аппарата абонента, мы отправим этот статус вам.
Webhook — это механизм оповещения системы о событиях. Используя вебхуки, после отправки SMS, вам не нужно самостоятельно дополнительно запрашивать статус доставки SMS, отслеживать его изменение, а также учитывать срок жизни SMS и контролировать интервалы отправки запросов. Как только мы получим конечный статус доставки SMS (или его изменение) от телефонного аппарата абонента, мы отправим этот статус вам.
Получение статуса доставки SMS с помощью API/PLAIN-запроса
Статусы доставки SMS содержат информацию о текущем состоянии SMS. В течение срока жизни SMS, до момента получения конечного статуса, статусы регулярно обновляются, и могут быть запрошены пользователем в любое время
URL
https://userarea.sms-assistent.by/api/v1/statuses/plain
Пример GET запроса
https://userarea.sms-assistent.by/api/v1/statuses/plain?user=ваш_логин&password=пароль_для_API&id=ИД_сообщенияОписание параметров в запросе
user
ваш логин, для доступа в Личный кабинет (ЛК)
password
ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»
id
числовой идентификатор SMS, который вы получили в момент отправки
Ответ на запрос
возвращаются статусы доставки SMS
Получение статуса доставки SMS с помощью вебхука (webhook)
Вы можете получать на ваш адрес (URL) информацию по статусу доставки SMS-сообщения в момент его изменения на нашей платформе. Отправка информации (отчёт о доставке) происходит на URL, который вы передаете в параметре webhook_url API-запроса на отправку SMS.
В ответ на отчёт о доставке, наш сервис должен получить от вас HTTP-код 200. В противном случае, отправку отчёта о доставке мы считаем недоставленной и повторяем попытку в течение суток с интервалом в 10 минут.
В ответ на отчёт о доставке, наш сервис должен получить от вас HTTP-код 200. В противном случае, отправку отчёта о доставке мы считаем недоставленной и повторяем попытку в течение суток с интервалом в 10 минут.
Тело отчёта о доставке
array(
key => value,
key2 => value2,
key3 => value3,
...
)Описание элементов в отчёте
key
числовой идентификатор SMS, присвоенный шлюзом
value
Ещё в этом разделе