SMS-ассистент — документация для разработчиков
Пакетная (массовая) отправка SMS. XML API
Запрос для отправки пакета SMS
Параметры запроса
чёрный — обязательные параметры
серый — необязательные параметры
серый — необязательные параметры
Тело запроса
<?xml version="1.0" encoding="utf-8" ?>
<package login="login" password="123456" name="Название рассылки" webhook_url="http://callback.yourdomain.by/">
<message>
<default sender="TEST-assist"/>
<msg recipient="295363600" sender="notdefault" validity_period="86400">text</msg>
<msg recipient="8(029)326-26-25" template_id="1" tags_replace="{TAG1}::подстановка1;;{TAG2}"></msg>
<msg recipient="8(029)536-36-00">text</msg>
</message>
</package>
В случае отправки запросов с количеством SMS больше 3000, в запрос необходимо вставлять строчку: <!DOCTYPE package SYSTEM «send_sms.dtd»>
Описание тегов в запросе
package
тег, в котором указываются основные параметры запроса:
login
ваш логин, для доступа в Личный кабинет (ЛК)
password
ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»
name
наименование, которое необходимо присвоить рассылке. По наименованию в последующем можно фильтровать рассылки в разделе «Отправленные». Параметр необязательный.
date_send
дата отправки SMS (передается только в том случае, если необходимо отправить запланированную рассылку).
Формат: ГГГГММДДЧЧММ. Например, передаем значение 201612250159 для того, чтобы запланировать рассылку на 25 декабря 2016 г. на 1ч 59 м. Дата запланированной рассылки должна быть не меньше, чем текущая дата +10 минут
Формат: ГГГГММДДЧЧММ. Например, передаем значение 201612250159 для того, чтобы запланировать рассылку на 25 декабря 2016 г. на 1ч 59 м. Дата запланированной рассылки должна быть не меньше, чем текущая дата +10 минут
webhook_url
адрес (URL) вашего сайта, на который будет отправлен отчёт о доставке SMS после того, как статус доставки у этого SMS поменяется. Подробнее про формат отчёта о доставке см. здесь
default
тег, в котором определяются общие атрибуты, указываемые для всех отправляемых SMS. Если какой-либо атрибут указан в SMS, то атрибут данного тега игнорируется. В качестве содержимого можно также указать общий текст для всех SMS.
msg
тег SMS, в качестве параметра указывается текст отправляемого SMS, может содержать атрибуты:
recipient
номер получателя (в возможном формате)
sender
отправитель SMS (подпись SMS)
validity_period
срок жизни SMS в часах, значения >48 часов не обрабатываются (в этом случае выставляется значение равное 48)
- Происходят следующие проверки:значение параметра в диапазоне от 1 до 48 воспринимается как часы;
- значение параметра в диапазоне от 49 до 3600 воспринимается как ошибочное, по умолчанию присваивается 48 ч;
- в диапазоне от 3600 до 172 800 воспринимается как передача данных в секундах;
- значение больше, чем 172 800, воспринимается как ошибочное и выставляется по умолчанию 48 ч.
template_id
код шаблона текста SMS, который создается в ЛК. В шаблоне текста SMS можно использовать собственные теги. Тогда, при отправке SMS по API, вместо тегов можно передать параметры на подстановку. Это позволит вам в ЛК менять текст SMS без изменения программного кода выполнения запросов по API. Получить код шаблона можно по json запросу get_templates или по запросу в службу технической поддержки.
tags_replace
параметр, в котором передаются значения на замену пользовательских метатегов. Работает только при использовании template_id. Формат: ПАРАМЕТР1:ЗНАЧЕНИЕ_ПАРАМЕТРА1;;ПАРАМЕТР2:ЗНАЧЕНИЕ_ПАРАМЕТРА2
Ответ в случае успешной отправки SMS
Тело ответа
<?xml version="1.0" encoding="utf-8" ?>
<package>
<message>
<msg sms_id="0" sms_count="1">-5</msg>
<msg sms_id="1234568" sms_count="1" operator="2" />
</message>
</package>
Описание тегов в ответе
msg
тег SMS, в качестве параметра возвращается код ошибки (если не удалось обработать SMS), может содержать атрибуты:
sms_id
числовой идентификатор SMS, который вы получили в момент отправки
sms_count
фактическое количество SMS к отправке
recipient
номер получателя в международном формате
operator
код мобильного оператора
Ответ в случае ошибки при отправке SMS
Тело ответа
<?xml version="1.0" encoding="utf-8" ?>
<package>
<error>-2</error>
</package>Описание тегов в ответе
error
содержит код ошибки
Ещё в этом разделе