SMS-ассистент — документация для разработчиков
Пакетная (массовая) отправка SMS. XML API
Получение статуса доставки SMS
Получить статус доставки SMS можно двумя способами:
1
С помощью API/XML–запроса на получение статуса доставки нужного SMS, инициируемого с вашей стороны. Т. е. вы отправляете запрос — мы в ответ на него отправляем вам статус доставки SMS.
2
С помощью вебхука (webhook)
Webhook — это механизм оповещения системы о событиях. Используя вебхуки, после отправки SMS, вам не нужно самостоятельно дополнительно запрашивать статус доставки SMS, отслеживать его изменение, а также учитывать срок жизни SMS и контролировать интервалы отправки запросов. Как только мы получим конечный статус доставки SMS (или его изменение) от телефонного аппарата абонента, мы отправим этот статус вам.
Webhook — это механизм оповещения системы о событиях. Используя вебхуки, после отправки SMS, вам не нужно самостоятельно дополнительно запрашивать статус доставки SMS, отслеживать его изменение, а также учитывать срок жизни SMS и контролировать интервалы отправки запросов. Как только мы получим конечный статус доставки SMS (или его изменение) от телефонного аппарата абонента, мы отправим этот статус вам.
Получение статуса доставки SMS с помощью API/XML–запроса
Статусы доставки SMS содержат информацию о текущем состоянии SMS. В течение срока жизни SMS, до момента получения конечного статуса, статусы регулярно обновляются, и могут быть запрошены пользователем в любое время
Тело запроса
<?xml version="1.0" encoding="utf-8" ?>
<package login="login" password="123456">
<status>
<msg sms_id="1234568"/>
</status>
</package>
Описание параметров и тегов в запросе
user
ваш логин, для доступа в Личный кабинет (ЛК)
password
ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»
msg
тег SMS, для которого происходит запрос статуса. Может содержать атрибуты:
sms_id
числовой идентификатор SMS, который вы получили в момент отправки
Тело ответа
<?xml version="1.0" encoding="utf-8" ?>
<package>
<status>
<msg sms_id="1234568" sms_count="1" operator="3" recipient="+375293262625">Delivered</msg>
</status>
</package>
Описание тегов в ответе
msg
тег SMS, для которого происходит запрос статуса. Содержит атрибуты:
sms_id
числовой идентификатор SMS, который вы получили в момент отправки
sms_count
количество SMS
status
recipient
номер телефона абонента, по которому считываем статус
operator
код мобильного оператора
Получение статуса доставки SMS с помощью вебхука (webhook)
Вы можете получать на ваш адрес (URL) информацию по статусу доставки SMS-сообщения в момент его изменения на нашей платформе. Отправка информации (отчёт о доставке) происходит на URL, который вы передаете в параметре webhook_url API-запроса на отправку SMS.
В ответ на отчёт о доставке, наш сервис должен получить от вас HTTP-код 200. В противном случае, отправку отчёта о доставке мы считаем недоставленной и повторяем попытку в течение суток с интервалом в 10 минут.
В ответ на отчёт о доставке, наш сервис должен получить от вас HTTP-код 200. В противном случае, отправку отчёта о доставке мы считаем недоставленной и повторяем попытку в течение суток с интервалом в 10 минут.
Тело отчёта о доставке
<?xml version="1.0" encoding="utf-8" ?>
<package>
<status>
<msg sms_id="1234568" sms_count="1" operator="3" recipient="+375293262625">Delivered</msg>
</status>
</package>
Описание тегов в ответе
msg
тег SMS, для которого происходит запрос статуса. Содержит атрибуты:
sms_id
числовой идентификатор SMS, который вы получили в момент отправки
sms_count
количество SMS
status
recipient
номер телефона абонента, по которому считываем статус
operator
код мобильного оператора
Ещё в этом разделе