Получение статуса доставки SMS

Получение статуса доставки SMS с помощью API/JSON-запроса →

Получение статуса доставки SMS с помощью вебхука (webhook) →

Получить статус доставки SMS можно двумя способами:

С помощью API/JSON–запроса на получение статуса доставки нужного SMS, инициируемого с вашей стороны. Т. е. вы отправляете запрос — мы в ответ на него отправляем вам статус доставки SMS.

С помощью вебхука (webhook)
Webhook — это механизм оповещения системы о событиях. Используя вебхуки, после отправки SMS, вам не нужно самостоятельно дополнительно запрашивать статус доставки SMS, отслеживать его изменение, а также учитывать срок жизни SMS и контролировать интервалы отправки запросов. Как только мы получим конечный статус доставки SMS (или его изменение) от телефонного аппарата абонента, мы отправим этот статус вам.

Получение статуса доставки SMS с помощью API/JSON-запроса

Статусы доставки SMS содержат информацию о текущем состоянии SMS. В течение срока жизни SMS, до момента получения конечного статуса, статусы регулярно обновляются, и могут быть запрошены пользователем в любое время

Тело запроса


{
        "login" : "username",
        "password" : "password",
        "command" : "statuses",
        "status" : {
                "msg" : [
                                {
                                        "sms_id" : "sms1_id_for_get_status"
                                },
                                {
                                        "sms_id" : "smsN_id_for_get_status"
                                }
                ]
        }
}

Описание параметров и тегов в запросе

ваш логин, для доступа в Личный кабинет (ЛК)

password

ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»

msg

массив идентификаторов сообщений, для которых происходит запрос статуса, может содержать следующие атрибуты:

sms_id

числовой идентификатор SMS, который вы получили в момент отправки

Тело ответа


{
	"status": {
	         "msg":[
		{"sms_id":12345678,"sms_count":"1","sms_status":"Delivered", "operator":"3", "recipient":"+375293262625"}
	         ]
	}
}

Описание тегов в ответе

msg

массив с информацией по статусам сообщений. Элементы могут содержать следующие параметры:

sms_id

числовой идентификатор SMS, который вы получили в момент отправки

sms_count

количество SMS

status

статус SMS

recipient

номер телефона абонента в международном формате, по которому считываем статус

operator

код мобильного оператора

Получение статуса доставки SMS с помощью вебхука (webhook)

Вы можете получать на ваш адрес (URL) информацию по статусу доставки SMS-сообщения в момент его изменения на нашей платформе. Отправка информации (отчёт о доставке) происходит на URL, который вы передаете в параметре webhook_url API-запроса на отправку SMS.
В ответ на отчёт о доставке, наш сервис должен получить от вас HTTP-код 200. В противном случае, отправку отчёта о доставке мы считаем недоставленной и повторяем попытку в течение суток с интервалом в 10 минут.

Тело отчёта о доставке


{
	"status": {
	         "msg":[
		{"sms_id":12345678,"sms_count":"1","sms_status":"Delivered", "operator":"3", "recipient":"+375293262625"}
	         ]
	}
}

Описание тегов в ответе

msg

массив с информацией по статусам сообщений. Элементы могут содержать следующие параметры:

sms_id

числовой идентификатор SMS, который вы получили в момент отправки

sms_count

количество SMS

status

статус SMS

recipient

номер телефона абонента в международном формате, по которому считываем статус

operator