Бесплатно по России 8 800 100-81-46 Пн-Пт: 09:00-18:00 Сб: 09:00-12:00

API для SMS-рассылки

Для подключения доступа к сервису смс рассылки. 

Доступен круглосуточно, 7 дней в неделю.

ТОЧКА ДОСТУПА

http://service.itakazan.ru/index.php?r=xmlService/default

Обязательные параметры в запросе (LOGIN, PASSWORD)

Чтобы получить логин и пароль, необходимо зарегистрироваться на нашем сайте. Получить доступ

Тестирование:

Запрос:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
login>LOGIN</login>
    <
pass>PASSWORD</pass>
    <
action>smsSendTest</action>
    <
signature>test</signature>
    <
phone>PHONE</phone>
</
data>

PHONE— номер телефона;

Ответ:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
code>CODE</code>
    <
sendid>SENDID</sendid>
</
data>

SENDID – номер рассылки, для запроса статуса смс;

Проверка баланса

Запрос:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
login>LOGIN</login>
    <
pass>PASSWORD</pass>
    <
action>balance</action>
</
data>

Ответ:

<?xml version='1.0' encoding='UTF-8'?>
<data>
      <code>CODE</code>
      <balance>BALANCE</balance>
      <signatures>
            <signature
                  beeline="OPERATOR"
                  megafon="OPERATOR"
                  mts="OPERATOR"
                  tele="OPERATOR"
                  other="OPERATOR">SIGNATURE</signature>
      </signatures>
      <price
            beeline="SUMMA"
            megafon="SUMMA"
            mts="SUMMA"
            tele="SUMMA"
            other="SUMMA">
      </price>
</data>

OPERATOR - 1 — рассылать на данного оператора, 0 — рассылка запрещена.

SIGNATURE - подпись;

SUMMA — стоимость рассылки на оператора. 

 

 Архив сообщений(archive)

Запрос:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
login>LOGIN</login>
    <
pass>PASSWORD</pass>
    <
action>archive</action>
</
data>

Ответ:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
code>CODE</code>
    <
smsArchives>
        <
smsArchive>
            <
date>DATE</date>
            <
signature>SIGNATURE</signature>
            <
text>TEXT</text>
            <
numbParts>numbParts</numbParts>
            <
numbContacts>numbContacts</numbContacts>
            <
statuses>
                <
delivered>DELIVERED</delivered>
                <
expired>EXPIRED</expired>
                <
deleted>DELETED</deleted>
                <
undelivered>UNDELIVERED</undelivered>
                <
null>NULL</null>
                <
rejected>REJECTED</ rejected>
            </
statuses>
        </
smsArchive>
        ...
        ...
   
</smsArchives>
</
data>

DATE — дата рассылки;

SIGNATURE — подпись;

TEXT — текст;

numbParts — количество частей;

numbContacts — количество получателей;

DELIVERED — количество доставленных;

EXPIRED — количество просроченных;

DELETED — количество удаленных;

UNDELIVERED — количество не доставленных;

NULL — количество не зарегистрированных номеров у операторов;

REJECTED — количество отклоненных.

Рассылка(smsSendSameText)

Запрос:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
login>LOGIN</login>
    <
pass>PASSWORD</pass>
    <
action>smsSendSameText</action>
    <
unixTime>unixTime</unixTime>
    <
signature>SIGNATURE</signature>
    <
text>TEXT</text>
    <
phone>PHONE</phone>
</
data>

signature — подпись отправителя;

text — текст сообщения;

phone — номера телефонов, записанных через разделитель '/'. Максимум контактов — 5000; (79000000000/79000000001);

signature — подпись;

unixTime — unix время формирования рассылки, без учета миллисекунд. Если поле будет пустым то рассылка отправляется стразу;

Ответ:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
code>CODE</code>
    <
sendid>SENDID</sendid>
</
data>

SENDID – номер рассылки, для запроса статуса смс;

 Рассылка ШАБЛОН(smsSendPATTERN)

Запрос:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
login>LOGIN</login>
    <
pass>PASSWORD</pass>
    <
action>smsSendPattern</action>
    <
signature>SIGNATURE</signature>
    <
text>TEXT</text>
    <
phones>
      <
phone cont_extra_1=”name1

             …

             cont_extra_8=”name8>PHONE

      </phone>

       …
    </
phones >
</
data>

signature — подпись отправителя;

text — текст сообщения с вставкой полей от 1 до 8 полей  в квадратных скобках в виде [cont_extra_1]… [cont_extra_8], которые во время отправки, будут заменены соответствующими значениями атрибутов в элементе phone для каждого номера;

phone — сотовый номер в виде 79ХХХХХХХХХ, с атрибутами соответствующие полям в тексте сообщения. Если атрибут соответствующий полю в тексте, будет отсутствовать, то поле в тексте сообщения для этого номера, будет удалено.

Ответ:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
code>CODE</code>
    <
sendid>SENDID</sendid>
</
data>

SENDID – номер рассылки, для запроса статуса смс;

Получение статусов рассылки(getSmsStatus)

Запрос:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
login>LOGIN</login>
    <
pass>PASSWORD</pass>
    <
action>getSmsStatus</action>
    <
sendid>SENDID</sendid>
</
data>

Ответ:

<?xml version='1.0' encoding='UTF-8'?>
<data>
    <
code>CODE</code>
    <
details>
        <
delivered>
            <
number>NUMBER</number>
        </
delivered>
        <
notDelivered>
            <
number>NUMBER</number>
        </
notDelivered>
        <
waiting>
            <
number>NUMBER</number>
        </
waiting>
        <
enqueued>
            <
number>NUMBER</number>
        </
enqueued>
        <
cancel>
            <
number>NUMBER</number>
        </
cancel>
    </
details>
</
data>

delivered  - Список абонентов, получивших СМС;

notDelivered - Список абонентов, не получивших СМС;

waiting - Список абонентов, СМС для которых находится в статусе "В ожидании";

enqueued - Список абонентов, отчет о доставке по которым еще не сформирован;

cancel  - Список отмененных номеров;

NUMBER – номер телефона;

 Результат обработки

CODE:

  • 1 — удачная операция;
  • 800 — ошибка парсера (кривая xml);
  • 801 — не найден xml  документ;
  • 700 — action указан неверно;

Обязательные параметры (login, pass, mac):

  • 499 — не достаточно переданных параметров, пустые значения xml или нет обязательных параметров;
  • 500 — логин или пароль неверны;
  • 501 — доступ не разрешен, обратитесь в техподдержку;
  • 502 — ваш IP не совпадает с разрешенным;
  • 505 — пользователь заблокирован;

Подпись:

  • 600 — не определен signature;

Рассылка смс с одним текстом:

  • 610 — не определен numbParts;
  • 611 — не определен part;
  • 612 — не определен signature;
  • 613 — не определен text;
  • 614 — не определен phone;
  • 615 — не определен onlyDelivery;
  • 616 — не определен unixTime;
  • 617 — нет предыдущих xml частей;
  • 618 — превышено допустимое количество получателей;
  • 619 — нет ни одного валидного телефонного номера получателя;

Запрос статусов:

  • 701 — не найдена рассылка;
  • 702 — рассылка еще формируется;