Пакетная (массовая) отправка SMS. JSON API

Запрос для отправки пакета SMS


Параметры запроса

Тело запроса
{
    "login":"username",
    "password":"password",
    "command":"sms_send",
    "date_send" : "date_send_sms",
    "webhook_url" : "http://callback.yourdomain.by/",
    "message": {
        "default": {
            "sender":"SMS-assist",
            "validity_period":24,
            "name":"Наименование рассылки"
        },
        "msg":[
            {
                "recepient":"295363600",
                "validity_period":10,
                "sms_text": "текст SMS 1"
            },{
                "recipient":"295363600",
                "template_id":29,
                "tags_replace":{
                    "{TAG1}":"замена 1"
                }
            },{
                "sender":"TEST-assist",
                "recipient":"293262625",
                "sms_text":"test sms"
            }
        ]
    }
}
Описание параметров и тегов в запросе
login
ваш логин, для доступа в Личный кабинет (ЛК)

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

date_send
дата отправки SMS (передается только в том случае, если необходимо отправить запланированную рассылку).
Формат: ГГГГММДДЧЧММ. Например, передаем значение 201612250159 для того, чтобы запланировать рассылку на 25 декабря 2016 г. на 1ч 59м.
Дата запланированной рассылки должна быть не меньше, чем текущая дата +10 минут

name
наименование, которое необходимо присвоить рассылке. По наименованию в последующем можно фильтровать рассылки в разделе «Отправленные».
Необязательный параметр

webhook_url
адрес (URL) вашего сайта, на который будет отправлен отчёт о доставке SMS после того, как статус доставки у этого SMS поменяется.
Подробнее по формату отчёта о доставке см. здесь.

default
параметры по умолчанию для всех отправляемых сообщений. Применяется только в том случае, если параметры опущены из тега msg для конкретных сообщений. Можно указывать параметры: sender, validity_period, sms_text (значение параметров ниже в описании тега msg)

msg
тег-массив с получателями SMS. Можно указывать персональные параметры для каждого абонента:
recipient
номер получателя (в возможном формате)
sender
отправитель SMS (подпись SMS)
validity_period
срок жизни SMS в часах, значения >48 часов не обрабатываются (в этом случае выставляется значение равное 48)

Происходят следующие проверки:
  • значение параметра в диапазоне от 1 до 48 воспринимается как часы;
  • значение параметра в диапазоне от 49 до 3600 воспринимается как ошибочное, по умолчанию присваивается 48 ч;
  • в диапазоне от 3600 до 172800 воспринимается как передача данных в секундах;
  • значение больше, чем 172800, воспринимается как ошибочное и выставляется по умолчанию 48 ч.
sms_text
текст SMS
template_id
код шаблона текста SMS, который создается в ЛК. В шаблоне текста SMS можно использовать собственные теги. Тогда, при отправке SMS по API, вместо тегов можно передать параметры на подстановку. Это позволит вам в ЛК менять текст SMS без изменения программного кода выполнения запросов по API. Получить код шаблона можно по json запросу get_templates или по запросу в службу технической поддержки.
tags_replace
параметр, в котором передаются значения на замену пользовательских метатегов. Работает только при использовании template_id. Формат: ПАРАМЕТР1::ЗНАЧЕНИЕ_ПАРАМЕТРА1;;ПАРАМЕТР2::ЗНАЧЕНИЕ_ПАРАМЕТРА2
Ответ в случае успешной отправки SMS

Тело ответа
{
"message":
	{"msg":[
		{"sms_id":12345678,"sms_count":1,"error_code":0, "operator":2},
		{"sms_id":0,"sms_count":1,"error_code":-5}
	]}
}
Описание тегов в ответе
msg
массив с информацией по отправленным SMS-сообщениям. В качестве параметров указываются:
sms_id
числовой идентификатор SMS, который вы получили в момент отправки
sms_count
фактическое количество SMS к отправке
error_code
код ошибки. В случае успешного ответа значение 0
operator
код мобильного оператора
Ответ в случае ошибки отправки SMS

Тело ответа
{"error":КОД_ОШИБКИ}
Описание тегов в ответе
error
содержит код ошибки
Ещё в этом разделе