Документация

Общие принципы отправки

На определенный адрес сервера отправляются XML документы (описание XML документов, их назначение и адреса сервера приведены ниже). При этом используется POST метод.

Заголовки отправляемых данных должны содержать:

Content-type: text/xml; charset=utf-8

Кодировка XML документов UTF-8. Передаваемый XML документ не должен содержать переводов строки. Переводы строк в самих данных должны быть заменены на “\n".

Пример передачи XML документа на php

$src = '<?xml version="1.0" encoding="utf-8"?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
</security>
</request>';
// XML-документ
$href = 'https://server/script.php'; // адрес сервера
$ch = curl_init();
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-type: text/xml','charset=utf-8','Expect:'));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt ($ch, CURLOPT_POST, true);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $src);
curl_setopt ($ch, CURLOPT_URL, $href);
$result = curl_exec($ch);
curl_close($ch);
echo $result;

Отправка SMS

Адрес сервера:

https://имя_хоста/xml/

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<message type="sms">
    <sender>Отправитель 1</sender>
    <text>Текст сообщения 1</text>
    <translite>1</translite>
    <name_delivery>Рассылка 1</name_delivery>
    <abonent phone="79001234567" number_sms="1" client_id_sms="101" time_send="2020-03-31 12:34" validity_period="2020-03-31 15:34" />
    <abonent phone="79001234568" number_sms="2" client_id_sms="102" time_send="2020-03-31 12:35" />
    <abonent phone="79001234569" number_sms="10" client_id_sms="110" time_send="" />
</message>
<message>
    <sender>Отправитель 2</sender>
    <text>Текст сообщения 2</text>
    <name_delivery>Рассылка 2</name_delivery>
    <abonent phone="79001234567" number_sms="11" client_id_sms="111" />
    <abonent phone="79001234568" number_sms="12" client_id_sms="112" />
    <abonent phone="79001234569" number_sms="20" client_id_sms="120" />
</message>
</request>

Где

• type - тип отправляемого SMS сообщения:
  • sms – обычная SMS.
• sender – отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS.
• text – текст SMS.
• name_delivery – Название рассылки. По умолчанию "Шлюз";
• translite - транслитерация текста СМС с кириллицы на латиницу (не обязательный параметр). Для транслитерации данный параметр должен быть равен 1.
• phone – номер абонента, которому адресована SMS. В международном формате, например, 79001234567 (Для России), 380441234567 (Для Украины) и т.д.
• логин - ваш логин в системе.
• пароль - ваш пароль в системе.
• number_sms - номер сообщения в пределах отправляемого XML документа.
• client_id_sms - число. Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено SMS с таким номером, то повторная отправка не производится, а возвращается номер ранее отправленного SMS.
• time_send – дата и время отправки в формате: YYYY-MM-DD hh:mm где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Если не задано, то SMS отправляется сразу же.
• validity_period – дата и время, после которых не будут делаться попытки доставить SMS в формате: YYYY-MM-DD hh:mm , где YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Если не задано, то SMS имеет максимальный срок жизни.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Ваш аккаунт заблокирован
3. Неправильный логин или пароль
4. POST данные отсутствуют

В случае получения правильного XML-документа

<?xml version="1.0" encoding="utf-8" ?>
<response>
<information number_sms="1" id_sms="ID SMS в системе для проверки статуса" parts="2">Статус/сообщение об ошибке</information>
<information number_sms="2" id_sms="ID SMS в системе для проверки статуса" parts="2">Статус/сообщение об ошибке</information>
<information number_sms="3" id_sms="ID SMS в системе для проверки статуса" parts="2">Статус/сообщение об ошибке</information>
</response>

Где:

• number_sms - номер сообщения указанный при отправке XML документа.
• id_sms - номер SMS сообщения. Используется для проверки статуса SMS. Если в процессе отправки SMS произошла ошибка, то id_sms не передается.
• parts - количество частей SMS.
• information - статус сообщения («send»), если SMS была отправлена. Или сообщение об ошибке, если в процессе отправки SMS произошла ошибка:

1. У нас закончились SMS. Для разрешения проблемы свяжитесь с менеджером.
2. Закончились SMS.
3. Аккаунт заблокирован.
4. Укажите номер телефона.
5. Номер телефона присутствует в стоп-листе.
6. Данное направление закрыто для вас.
7. Данное направление закрыто.
8. Недостаточно средств для отправки SMS. SMS будет отправлена как только вы пополните счет по данному направлению.
9. Текст SMS отклонен модератором.
10. Нет отправителя.
11. Отправитель не должен превышать 15 символов для цифровых номеров и 11 символов для буквенно-числовых.
12. Номер телефона должен быть меньше 15 символов.
13. Нет текста сообщения.
14. Нет ссылки.
15. Такого отправителя Нет.
16. Отправитель не прошел модерацию.
17. Данное сообщение уже было отправлено.

Запрос статуса SMS сообщения (первый способ)

Адрес сервера:

https://имя_хоста/xml/state.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<get_state>
    <id_sms>IDSMS в системе для проверки статуса</id_sms>
    <id_sms>IDSMS в системе для проверки статуса</id_sms>
    <id_sms>IDSMS в системе для проверки статуса</id_sms>
    <id_sms>IDSMS в системе для проверки статуса</id_sms>
</get_state>
</request>

Где

• логин - ваш логин в системе.
• пароль - ваш пароль в системе.
• id_sms - номер SMS сообщения, полученный в ответном XML-документа в процессе отправки SMS сообщения.

В ответ может быть выдан один из следующих XML-документов:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или
3. POST данные отсутствуют

В случае получения правильного XML-документа:

 

<?xml version="1.0" encoding="utf-8" ?>
<response>
<state id_sms="IDSMS в системе для проверки статуса" time="2020-01-01 12:57:46" num_parts="2" price="1.15">Статус</state>
<state id_sms="IDSMS в системе для проверки статуса" time="2020-01-01 12:57:46" num_parts="2" price="1.15">Статус</state>
<state id_sms="IDSMS в системе для проверки статуса" time="2020-01-01 12:57:46" num_parts="2" price="1.15">Статус</state>
</response>

Где

• id_sms - номер SMS сообщения, полученный в ответном XML-документа в процессе отправки SMS сообщения.
• time - время изменения статуса.
• state - статус сообщения:
  1. «send» - статус сообщения не получен. В этом случае передается пустой time (time="").
  2. «not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем).
  3. «expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем.
  4. «deliver» - сообщение доставлено. Конечный статус (не меняется со временем)
  5. «partly_deliver» - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки.
• num_parts - Количество частей в СМС.
• price - Цена за одну часть СМС.

 

Получение статуса SMS сообщения (второй способ)

При использовании данного способа необходимо сообщить менеджеру адрес вашего сервера, который будет принимать статусы SMS. XML-документ будет отправлен POST методом.

К примеру, в php XML-документ будет доступен через переменную

$GLOBALS['HTTP_RAW_POST_DATA']

 

Система отправляет XML-документ серверу клиента следующего содержания:

<?xml version="1.0" encoding="utf-8"?>
<request>
    <state id_sms="ID SMS в системе для проверки статуса" time="2020-01-01 12:57:46">Статус</state>
    <state id_sms="ID SMS в системе для проверки статуса" time="2020-01-01 12:57:46">Статус</state>
</request>

 

В ответ сервер клиента должен вернуть XML-документ следующего содержания:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<id_sms>3234</id_sms>
<id_sms>3234</id_sms>
</response>

Где:

• id_sms - номер SMS сообщения, полученный в ответном XML-документа в процессе отправки SMS сообщения.
• time - время изменения статуса.

Если сервер клиента не передаст id_sms, то статус будет считаться не полученным клиентом. При этому будет сделано 5 попыток доставить статус.

 

Запрос проверки баланса

Адрес сервера:

https://имя_хоста/xml/balance.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
</request>

 

Где

• логин - ваш логин в системе.
• пароль - ваш пароль в системе.

В ответ может быть выдан один из следующих XML-документов:

1. В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

 

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют
4. В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<money currency="RUR">150</money>
<sms area="МТС" price="1.1" type_sms="sms" type_text="Рекламные" MCC="250" MNC="1">136</sms>
<sms area="Мегафон" price="2" type_sms="sms" type_text="Сервисные" MCC="250" MNC="2">75</sms>
</response>

Где:

• money - остаток средств.
• area - направление в котором может быть отправлено данное количество SMS;
• sms - количество доступных SMS сообщений для данного направления;
• price - Цена за одно сообщения;
• type_sms - Тип сообщения (sms / viber / vk / whatsapp);
• type_text - Тип текста в сообщении (Рекламные / Сервисные / Транзакционные);
• MCC - (англ. Mobile Country Code) мобильный код страны;
• MNC - (англ. Mobile Network Code) код мобильной сети.

При этом количество SMS не может быть суммировано по разным направлениям. При отправке смс в одном направлении уменьшается количество доступных SMS сообщений во всех других направлениях в соответствии с их стоимостью.

 

Запрос на получения списка отправителей

Адрес сервера:

https://имя_хоста/xml/originator.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
</request>

Где:

• логин - ваш логин в системе.
• пароль - ваш пароль в системе.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<any_originator>FALSE</any_originatоr>
<list_originator>
    <originator state="rejected">Отправитель</originator>
</list_originator>
</response>

Где

• any_originator - TRUE/FALSE - может ли клиент отправлять от любого отправителя или только от заранее одобренных. Если TRUE, то клиент может использовать любого отправителя. При этом список отправителей не возвращается. FALSE – можно использовать только отправителей со статусом «completed».
• state - статус отправителя:
  
  1. order – оформляется
  2. completed - готов к использованию
  3. rejected – отклонен

 

Запрос входящих SMS

Адрес сервера:

https://имя_хоста/xml/incoming.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
<time start="2020-01-31 12:23:00" end="2020-02-31 12:23:00" />
</request>

Где

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• time start - время (не включительно), с которого запрашиваются входящие SMS.
• time end - время (не включительно), по которое запрашиваются входящие SMS. Не обязательный параметр. Если не задан, то будут возвращены все смс.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error -

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<sms id_sms="1234" date_receive="2020-01-31 12:55:53" originator="79001234567" prefix="AKCIYA" phone="3443">ТекстСМС.</sms>
<sms id_sms="1234" date_receive="2020-01-31 12:55:53" originator="79001234568" prefix="AKCIYA" phone="3443">ТекстСМС.</sms>
</response>

Где

• id_sms - уникальный номер, состоящий только из цифр.
• date_receive - дата и время получения SMS.
• originator - номер телефона абонента, отправившего SMS.
• prefix - префикс. Начальная часть текста SMS, по которой было определено, что эта SMS принадлежит именно этому клиенту. (Используется если один и тот же номер используется разными клиентами).
• phone - номер телефона, на который бала отправлена SMS.
• sms - текст смс.

 

Запрос на получение информации по номеру телефона

Адрес сервера:

https://имя_хоста/xml/def.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<phones>
    <phone>79001234567</phone>
    <phone>79001234568</phone>
</phones>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• phone - Номер телефона.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error -

• Неправильный формат XML документа
• Неправильный логин или пароль
• POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<phone operator="Мегафон" region="Москва" time_zone="3">79001234567</phone>
<phone operator="Мегафон" region="Калининград" time_zone="-1">79001234568</phone>
</response>

Где:

• operator - Оператор.
• region - Регион.
• time_zone - Смещение времени в часах относительно времени в Москве.
• phone - номер телефона.

 

Запрос на получение списка баз

Адрес сервера:

https://имя_хоста/xml/list_bases.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<base id_base="1234" name_base="Базаглавногоофиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
<base id_base="1235" name_base="БазаМосковскогоофиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
</response>

Где:

• id_base - уникальный номер базы в системе.
• name_base - название базы.
• time_birth - время поздравления.
• local_time_birth - читать время поздравления относительно местного времени абонента(yes) или относительно времени системы (no).
• day_before - за сколько дней до дня рождения поздравлять.
• originator_birth - отправитель поздравления.
• on_birth - включены ли поздравления yes – включены, no - выключены.
• base - текст поздравления.

 

Запрос на изменение параметров/добавление/удаление баз

Адрес сервера:

https://имя_хоста/xml/bases.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<bases>
    <base id_base="1234" name_base="Базаглавногоофиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
    <base number_base="1" name_base="БазаМосковскогоофиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
</bases>
<delete_bases>
    <base id_base="1235" />
    <base id_base="1236" />
</delete_bases>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• id_base - уникальный номер базы в системе. Если не указан произойдет добавление базы. При этом нужно указать параметр number_base.
• number_base - номер базы в XML запросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе).
• name_base - название базы.
• time_birth - время поздравления.
• local_time_birth - считать время поздравления относительно местного времени абонента (yes) или относительно времени системы (no).
• originator_birth - отправитель поздравления.
• on_birth - включены ли поздравления yes – включены, no - выключены.
• base - текст поздравления.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<base id_base="1234">edit</base>
<base number_base="1" id_base="1235">insert</ base>
<base number_base="2" id_base="1236">edit</ base>
<base id_base="1235">delete</ base>
<base id_base="1235">not_found</ base>
</response>

 

Запрос на получение списка абонентов базы

Адрес сервера:

https://имя_хоста/xml/list_phones.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<base id_base="1234" page="1" last_update="2011-03-25 08:39:48"/>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• baseid_base - номер базы в системе.
• basepage - номер страницы. Весь список номеров базы делится на страницы. Запросить целиком базу нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички.
• last_update - минимальная дата и время регистрации (или последнего изменения) данных абонента, которых Вам нужно запросить.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют
4. Базы с таким номером не существует

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<phones page="1" num_pages="100">
    <phone phone="79001234567" region="Москва " operator="Мегафон" name="Иван" surname="Иванов" patronymic="Иванович" date_birth="1988-08-28" male="m" addition_1="Первоедополнительноеполе" addition_2="второе" addition_3="третье" addition_4="четвертое" addition_5="пятое" last_update="2011-03-25 08:39:48" />
    <phone phone="79001234568" region="Москва" operator="Мегафон" name="Иван" surname="Иванов" patronymic="Иванович" date_birth="1988-08-28" male="m" addition_1="Первоедополнительноеполе" addition_2="второе" addition_3="третье" addition_4="четвертое" addition_5="пятое" last_update="2011-03-25 08:39:48" />
</phones>
</response>

Где:

• page - номер страницы.
• num_pages - всего страниц.
• phone - номер телефона абонента.
• region - регион.
• operator - оператор.
• name - имя абонента.
• surname - фамилия абонента.
• patronymic - отчество абонента.
• date_birth - дата рождения.
• male - пол. «m» - мужской, «f»- женский.
• addition_1 – первое дополнительное поле.
• addition_2 – второе дополнительное поле.
• addition_3 - третье дополнительное поле.
• addition_4 - четвертое дополнительное поле.
• addition_5 - пятое дополнительное поле.
• last_update - дата и время регистрации (или последнего изменения) данных абонента.

 

Запрос на добавление/редактирование/удаление абонентов базы

Адрес сервера:

https://имя_хоста/xml/phones.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<base id_base="1234">
    <phone phone="79001234567" region="Москва " operator="Мегафон" name="Иван" surname="Иванов" patronymic="Иванович" date_birth="1988-08-28" male="мужской" addition_1="Первоедополнительноеполе" addition_2="второе" addition_3="третье" addition_4="четвертое" addition_5="пятое" number_phone="1"/>
    <phone phone="79001234568" region="Москва " operator="Мегафон" name="Иван" surname="Иванов" patronymic="Иванович" date_birth="1988-08-28" male="мужской" addition_1="Первоедополнительноеполе" addition_2="второе" addition_3="третье" addition_4="четвертое" addition_5="пятое" number_phone="2" />
    <phone phone="79001234569" action="delete" number_phone="5"/>
    <phone phone="79001234570" action="delete" number_phone="6"/>
</base>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• base id_base - номер базы в системе.
• phone - номер телефона абонента. Если абонент с таким номером уже существует, то он будет отредактирован.
• region - регион. Необязательное поле. Если не задано определяется автоматически.
• operator - оператор. Необязательное поле. Если не задано определяется автоматически.
• name - имя абонента. Необязательное поле.
• surname - фамилия абонента. Необязательное поле.
• patronymic - отчество абонента. Необязательное поле.
• date_birth - дата рождения. Необязательное поле.
• male - пол. «мужской» или «женский». Необязательное поле.
• addition_1 - первое дополнительное поле. Необязательное поле.
• addition_2 - второе дополнительное поле. Необязательное поле.
• addition_3 - третье дополнительное поле. Необязательное поле.
• addition_4 - четвертое дополнительное поле. Необязательное поле.
• addition_5 - пятое дополнительное поле. Необязательное поле.
• number_phone - порядковый номер в XML запросе. Используется для сопоставления телефонных номеров в запросе, и полученном ответе. Необязательное поле.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текстошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют
4. Базы с таким номером не существует

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<baseid_base="1234">
    <phone phone="79001234567" number_phone="1"/>insert</phone>
    <phone phone="79001234568" number_phone="2" />edit</phone>
    <phone phone="79001234569" number_phone="5"/>delete</phone>
    <phone phone="79001234570" number_phone="6" />not_found</phone>
</response>

 

Запрос на получение списка номеров из СТОП-листа

Адрес сервера:

https://имя_хоста/xml/list_stop.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" /> <password value="пароль" />
</security>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• number_phone - порядковый номер в XML запросе. Используется для сопоставления телефонных номеров в запросе, и полученном ответе.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текстошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<phone>79001234567</phone>
<phone>79001234568</phone>
</response>

Где:

• phone - номер телефона из СТОП-листа.

 

Запрос на добавление/удаление абонентов в СТОП-лист

Адрес сервера:

https://имя_хоста/xml/stop.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<add_stop>
    <phone phone="79001234567" />
    <phone phone="79001234568" />
</add_stop>
<delete_stop>
    <phone phone="79001234569" />
    <phone phone="79001234570" />
</delete_stop>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• add_stop phone - номер телефона абонента, которого нужно добавить в СТОП-лист.
• delete_stop phone - номер телефона абонента, которого нужно удалить из СТОП-листа.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<phone phone="79001234567">delete</phone>
<phone phone="79001234568">add</phone>
<phone phone="79001234569">not_found</phone>
</response>

 

Запрос на получение списка запланированных SMS

Адрес сервера:

https://имя_хоста/xml/list_scheduled.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<scheduled page="1"/>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• scheduled page - номер страницы. Весь список запланированных SMS делится на страницы. Запросить список целиком нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<phones page="1" num_pages="100">
    <scheduled id_sms="1234" time_put_turn="2020-11-14 12:42:40" originator="SENDER_1"  phone="79001234567" type_sms="sms" text_sms="ТекстSMS" count_sms="2" name_delivery="Названиерасылки" time_send="2011-11-14 21:00" validity_period="2011-11-17 21:00:00" />
    <scheduled id_sms="1235" time_put_turn="2020-11-14 12:42:40" originator="SENDER_1" phone="79001234568" type_sms="sms" text_sms="ТекстSMS" count_sms="2" name_delivery="Названиерасылки" time_send="2011-11-14 21:00" validity_period="2011-11-17 21:00:00" />
</phones>
</response>

Где:

• page - номер страницы.
• num_pages - всего страниц.
• id_sms - номерSMS. Используется для удаления запланированной SMS.
• time_put_turn - время добавления в планировщик.
• operator – отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS.
• phone - номер абонента, которому адресована SMS.
• type – тип отправляемого SMS сообщения:
  • sms – обычная SMS
  • flashsms – flash SMS
  • wappush – WAP-Push
  • vcard – визитная карточка (vCard)
• text_sms - Текст SMS-сообщения.
• count_sms –Количество частей SMS-сообщения.
• name_delivery - Название рассылки.
• time_send - дата и время отправки в формате: YYYY-MM-DDHH:MM где, YYYY-год, MM-месяц, DD-день, HH-часы, MM-минуты.
• validity_period - дата и время, после которых не будут делаться попытки доставить SMS в формате: YYYY-MM-DDHH:MM:SS где, YYYY-год, MM-месяц, DD-день, HH-часы, MM-минуты, SS-секунды.

 

Запрос на удаление запланированной SMS

Адрес сервера:

https://имя_хоста/xml/scheduled.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<delete_schedule>
    <schedule id_sms="1234" />
    <schedule id_sms="1235" />
</delete_schedule>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• delete_schedule id_sms - номер запланированной SMS, которую нужно удалить. Можно получить при запросе списка запланированных SMS.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текстошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<scheduled id_sms="1234">delete</scheduled>
<scheduled id_sms="1235">not_found</scheduled>
</response>

 

Запрос на получение времени изменения чего либо

Адрес сервера:

https://имя_хоста/xml/check_change.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<check obgect="base" id="1"/>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• obgect - base - базы данных, stop-лист.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют
4. Базы с таким номером не существует

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<obgect time_update="2012-01-01 12:12:12" />
</response>

Где

• time_update - время последнего изменения объекта.

 

Запрос проверки времени

Адрес сервера:

https://имя_хоста/xml/time.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текстошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<time>15:34:05</time>
</response>

Где:

• time - локальное время пользователя.

При этом время рассчитывается как время на сервере минус разница часовых поясов пользователя и сервера.

Пример

Сервер находится в Москве и серверное время у него московское, в момент запроса оно составляло: 15:34:27. А пользователь числился в Новосибирске и разница часовых поясов (между сервером и пользователем) у него равнялась +3. При этом вам вернется XML документ следующего содержания:

<?xml version="1.0" encoding="utf-8"?>
<response>
<time>2012-12-17 18:34:27</time>
</response>

 

Запрос на получение статистики

Статистику можно получить только за последние 3 месяца. Смс старше 3 месяцев переносятся в архив. Запросить выгрузку статистики по смс старше 3 месяцев можно через вашего менеджера.

Адрес сервера:

https://имя_хоста/xml/stats.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
  <login value="логин" />
  <password value="пароль" />
</security>
<stats date_start="2016-08-21" date_stop="2016-08-21" state="deliver" originator="SENDER_1" phone="" operator="" from_hour="00" from_minute="00" to_hour="" to_minute="" />
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• stats date_start - дата отправки СМС, не ранее указанного периода времени (по умолчанию сегодняшняя дата).
• stats date_stop – дата отправки СМС, не позднее указанного периода времени (по умолчанию сегодняшняя дата).
• stats state - cтатус сообщения:
  1. not_deliver - сообщение не было доставлено. Конечный статус (не меняется со временем).
  2. expired - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем).
  3. deliver - сообщение доставлено. Конечный статус (не меняется со временем).
  4. partly_deliver - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки.
• stats originator - имя отправителя.
• stats phone - номер телефона получателя СМС.
• stats operator - мобильный оператор получателя СМС (Beeline, Мегафон, МТС).
• stats from_hour - час отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 00).
• stats from_minute - минута отправки СМС, не ранее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 00).
• stats to_hour - час отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой (по умолчанию 59).
• stats to_minute - минута отправки СМС, не позднее указанного периода времени. Учитывается вместе с указанной датой и часом (по умолчанию 59).

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текстошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют
4. Базы с таким номером не существует
5. Некорректный формат даты
6. Такой оператор не обнаружен

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<stats num_stats="100">
    <stat id_sms="100123" id_state="2000123" operator="МТС" name_delivery="Кабинет" phone="7900123****" originator="SENDER_1" time_change_state="2016-08-10 23:04:32" time="2016-08-10 23:04:18" status="deliver" status_translate="доставлено"  text="ТЕКСТ СМС" price="1.05" part_no="1" num_parts="2"></stat>
    <stat id_sms="100124" id_state="2000124" operator="МТС" name_delivery="Кабинет" phone="7900123****" originator="SENDER_1" time_change_state="2016-08-10 23:04:32" time="2016-08-10 23:04:18" status="deliver" text="ТЕКСТ СМС ПРОДОЛЖЕНИЕ" price="1.05" part_no="2" num_parts="2"></stat>
</stats>
</response>

Где:

• num_stats - всего СМС.
• id_sms - номер SMS сообщения.
• id_state - идентификатор части СМС.
• operator - оператор.
• phone - номер телефона получателя СМС.
• originator - имя отправителя.
• time_change_state - последнее время смены состояния СМС.
• time - время отправки СМС.
• status - cтатус сообщения:
  1. not_deliver - сообщение не было доставлено. Конечный статус (не меняется со временем).
  2. expired - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем).
  3. deliver - сообщение доставлено. Конечный статус (не меняется со временем).
  4. partly_deliver - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки.
• status_translate - статус сообщения, на русском языке.
• price - Цена части СМС.
• part_no - порядковый номер части СМС.
• num_parts - количество частей СМС.

 

Запрос на получение списка шаблонов SMS

Адрес сервера:

https://имя_хоста/xml/list_patterns.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<pattern id_pattern="1234" name="ЗаголовокШаблона1">Шаблон1</pattern>
<pattern id_pattern="1235" name="ЗаголовокШаблона2">Шаблон2</pattern>
</response>

Где:

• id_pattern - идентификатор шаблона в системе.
• name - заголовок шаблона.
• pattern - текст шаблона.

 

Запрос на изменение параметров/добавление/удаление шаблонов SMS

Адрес сервера:

https://имя_хоста/xml/patterns.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<patterns>
<pattern id_pattern="1234" name="ЗаголовокШаблона1">Шаблон1</base>
<pattern id_pattern="1235" name="ЗаголовокШаблона2">Шаблон2</base>
<pattern number_pattern="1" name="ЗаголовокШаблона3">Шаблон3</pattern>
</patterns>
<delete_patterns>
    <pattern id_pattern="1236" />
    <pattern id_pattern="1237" />
</delete_patterns>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• id_pattern - уникальный номер шаблона в системе. Если не указан произойдет добавление базы. При этом нужно указать параметр number_pattern.
• number_pattern - номер шаблона в XML запросе. Используется для сопоставления ID добавленных шаблонов (если их было не сколько в запросе).
• name - заголовок шаблона.
• pattern - текст шаблона.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<pattern id_pattern="1234">edit</pattern>
<pattern id_pattern="1235">not_edit</ pattern>
<pattern number_base="1" id_pattern="1238">insert</ pattern>
<pattern id_pattern="1236">delete</ pattern>
<pattern id_pattern="1237">not_found</ pattern>
</response>

Где:

• id_pattern - уникальный номер шаблона sms в системе;
• action - действие, произведенное с шаблоном:
  1. «edit» - изменение параметров шаблона;
  2. «insert» - добавление шаблона;
  3. «not_edit» - не удалось обновить шаблон. Возможно данные идентичны с обновляемым шаблоном;
  4. «delete» - шаблон удалена;
  5. «not_found» - шаблон с указанным идентификатором не обнаружен;
• number_pattern - номер шаблона в JSON запросе. Используется для сопоставления ID добавленных шаблона(если их было не сколько в запросе).

 

Запрос на получение реестра имен отправителей

Адрес сервера:

https://имя_хоста/xml/list_registry_originator.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<registry_originator operator="Оператор" originator="Имя отправителя" inn="ИНН"></registry_originator>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• registry_originator - Фильтр вывода реестра имен отправителей:
  • operator - Оператор. Доступны такие операторы как: mts - МТС, mega - Мегафон, tele2 - Теле2. Необязательное поле.
  • originator - Имя отправителя. Необязательное поле.
  • inn - Идентификационный номер налогоплательщика. Необязательное поле.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<registry_originator>
    <operator name="mts" title="МТС">
        <originator originator="Отправитель 1" date_from="2017-05-20" legal_entity="ИП Иванов" inn="ИНН" comment="Комментраий" status="approval" status_text="Согласовано"></originator>
        <originator originator="Отправитель 2" date_from="2017-05-20" legal_entity="ИП Иванов" inn="ИНН" comment="Комментраий" status="posted_for_approval" status_text="Подано на согласование"></originator>
    </operator>
    <operator name="mega" title="Мегафон">
        <originator originator="Отправитель 1" date_from="2017-05-20" legal_entity="ИП Иванов" inn="ИНН" comment="Комментраий" status="approval" status_text="Согласовано"></originator>
        <originator originator="Отправитель 2" date_from="2017-05-20" legal_entity="ИП Иванов" inn="ИНН" comment="Комментраий" status="posted_for_approval" status_text="Подано на согласование"></originator>
    </operator>
</registry_originator>
</response>

Где:

• operator name - Оператор. mts, mega, tele2.
• operator - Заголовок оператора. МТС, Мегафон, Теле2.
• originator - Имя Отправителя.
• date_from - Дата начала.
• legal_entity - Юр.Лицо.
• inn - Идентификационный номер налогоплательщика.
• comment - Комментарий.
• status - Статус:
  1. «posted_for_approval» - Подано на согласование;
  2. «send_for_approval» - Отправлено на согласование;
  3. «approval» - Согласовано;
  4. «not_approval» - Не согласовано;
  5. «send_for_delete» - Подано на удаление;
  6. «delete» - Удалено;
• status_text - Статус, описание.

 

Запрос на добавление удаление имен отправителей в реестре имен отправителей

Адрес сервера:

https://имя_хоста/xml/registry_originator.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<registry_originator>
    <originator originator="Отправитель 1" legal_entity="ИП Иванов" operator="mts" inn="ИНН" comment="Комментарий"></originator>
    <originator originator="Отправитель 1" legal_entity="ИП Иванов" operator="tele2" inn="ИНН" comment="Комментарий"></originator>
    <originator originator="Отправитель 2" legal_entity="ИП Иванов" operator="mts" inn="ИНН"></originator>
</registry_originator>
<delete_registry_originator>
    <originator originator="Отправитель 3"></originator>
    <originator originator="Отправитель 4" operator="mega"></originator>
</delete_registry_originator>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• registry_originator - Добавление имени отправителя:
  • originator - Имя отправителя.
  • operator - Оператор. Доступны такие операторы как: mts - МТС, mega - Мегафон, tele2 - Теле2.
  • legal_entity - Юр.Лицо.
  • inn - Идентификационный номер налогоплательщика.
  • comment - Комментарий. Необязательное поле.
• delete_registry_originator - Удаление имени отправителя:
  • originator - Имя отправителя.
  • operator - Оператор. Доступны такие операторы как: mts - МТС, mega - Мегафон, tele2 - Теле2. Необязательное поле. Если отсутствует, будет удалено имя отправителя по всем операторам.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<registry_originator>
    <originator originator="Отправитель 1" operator="mts" inn="ИНН" status="add" error=""></originator>
    <originator originator="Отправитель 1" operator="tele2" inn="ИНН" status="error" error="Описание ошибки"></originator>
    <originator originator="Отправитель 2" operator="mts" inn="ИНН" status="add" error=""></originator>
</registry_originator>
<delete_registry_originator>
    <originator originator="Отправитель 3" operator="" status="delete" error=""></originator>
    <originator originator="Отправитель 4" operator="mega" status="not_found" error="Имя отправителя не обнаружено"></originator>
</delete_registry_originator>
</response>

Где:

• registry_originator - Добавленые имена отправителей:
  • originator - Имя отправителя.
  • operator - Оператор. mts, mega, tele2.
  • inn - Идентификационный номер налогоплательщика.
  • status - Статус. add - добавлено имя отправителя, error - ошибка.
  • error - Описание ошибки.
• delete_registry_originator - Удаленные имена отправителей:
  • originator - Имя отправителя.
  • operator - Оператор. mts, mega, tele2. Если отсутствует, удалено имя отправителя по всем операторам.
  • status - Статус. not_found - подано на удаление, error - ошибка.
  • error - Описание ошибки.

 

Запрос на просмотр и редактирования ссылки получения статусов СМС по XML протоколу

Адрес сервера:

https://имя_хоста/xml/get_state.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
    <login value="логин" />
    <password value="пароль" />
</security>
<get_state type="set">http://site.ru/state.php</get_state>
</request>

Где:

• login value - ваш логин в системе.
• password value - ваш пароль в системе.
• get_state - Ссылка, в случае редактирования.
  • type - Тип запроса (set - редактирование, get - просмотр).

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
<error>текст ошибки</error>
</response>

error - текст ошибки может принимать следующие значения:

1. Неправильный формат XML документа
2. Неправильный логин или пароль
3. POST данные отсутствуют

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
<get_state>http://site.ru/state.php</get_state>
</response>

Где:

• get_state - Текущая ссылка на получение статусов.