Versions Compared

Old Version 2

changes.mady.by.user Alex Kirichek

Saved on

compared with

New Version Current

changes.mady.by.user Alex Kirichek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

...

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

Текущие адреса серверов для отправки запросов (в зависимости от того, где зарегистрирован пользователь):

Code Block
https://clk.prontosms.ru/

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

Code Block
languagephp
$src = '<?xml version="1.0" encoding="utf-8"?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
</security>
</request>';
// XML-документ
$href = 'https://serverclk.prontosms.ru/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_CRLF, true);
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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/

XML-документ:

Code Block
languagexml
<?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="79033256699" number_sms="1" client_id_sms="101" time_send="2001-12-31 12:34" validity_period="2001-12-31 15:34" />
    <abonent phone="79033256699" number_sms="2" client_id_sms="102" time_send="2001-12-31 12:35" />
    <abonent phone="79033256699" number_sms="10" client_id_sms="110" time_send="" />
</message>
<message>
    <sender>Отправитель 2</sender>
    <text>Текст сообщения 2</text>
    <name_delivery>Рассылка 2</name_delivery>
    <abonent phone="79033256699" number_sms="11" client_id_sms="111" />
    <abonent phone="79033256699" number_sms="12" client_id_sms="112" />
    <abonent phone="79033256699" number_sms="20" client_id_sms="120" />
</message>
</request>

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Ваш аккаунт заблокирован

  3. Неправильный логин или пароль

  4. POST данные отсутствуют

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

Code Block
languagexml
<?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>

...

Code Block
    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 сообщения (первый способ)

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/state.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или

  3. POST данные отсутствуют

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
<state id_sms="IDSMS в системе для проверки статуса" time="2011-01-01 12:57:46" num_parts="2" price="1.15">Статус</state>
<state id_sms="IDSMS в системе для проверки статуса" time="2011-01-01 12:57:46" num_parts="2" price="1.15">Статус</state>
<state id_sms="IDSMS в системе для проверки статуса" time="2011-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 методом.

...

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

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/balance.php

XML-документ:

...

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <money>8</money>
    <sms area="Россия">8</sms>
    <sms area="Украина">4</sms>
</response>

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/originator.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/incoming.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
<sms id_sms="1234" date_receive="2012-01-31 12:55:55" originator="79612242243" prefix="IGRA" phone="79611111111">ТекстСМС.</sms>
<sms id_sms="1234" date_receive="2012-01-31 12:55:55" originator="79612242243" prefix="IGRA" phone="79611111111">ТекстСМС.</sms>
</response>

...

  • id_sms

    • уникальный номер, состоящий только из цифр.

  • date_receive

    • дата и время получения SMS.

  • originator

    • номер телефона абонента, отправившего SMS.

  • prefix

    • префикс. Начальная часть текста SMS, по которой было определено, что эта SMS принадлежит именно этому клиенту. (Используется если один и тот же номер используется разными клиентами).

  • phone

    • номер телефона, на который бала отправлена SMS.

  • sms

    • текст смс.

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/def.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <phone operator="Вымпелтелеком" region="Новосибирскаяобласть" time_zone="3">79612242243</phone>
    <phone operator="Вымпелтелеком" region="Калининград" time_zone="-1">79612242244</phone>
</response>

...

  • operator

    • Оператор.

  • region

    • Регион.

  • time_zone

    • Смещение времени в часах относительно времени в Москве.

  • phone

    • номер телефона.

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/list_bases.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?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

    • текст поздравления.

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/bases.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?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>

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/list_phones.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

  4. Базы с таким номером не существует

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
<phones page="1" num_pages="100">
<phone phone="79612242243" region="Новосибирск " operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="m" addition_1="Первоедополнительноеполе" addition_2="второе" addition_3="третье" addition_4="четвертое" addition_5="пятое" last_update="2011-03-25 08:39:48" />
<phone phone="79612242244" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" 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

    • дата и время регистрации (или последнего изменения) данных абонента.

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/phones.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

  4. Базы с таким номером не существует

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
<baseid_base="1234">
<phone phone="79612242243" number_phone="1"/>insert</phone>
<phone phone="79612242244" number_phone="2" />edit</phone>
<phone phone="79612242243" number_phone="5"/>delete</phone>
<phone phone="79612242244" number_phone="6" />not_found</phone>
</response>

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/list_stop.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
<phone>79612242243</phone>
<phone>79612242244</phone>
</response>

...

  • phone

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

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/stop.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <phone phone="79612242243">delete</phone>
    <phone phone="79612242244">add</phone>
    <phone phone="79612242245">not_found</phone>
</response>

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/list_scheduled.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
<phones page="1" num_pages="100">
<scheduled id_sms="1234" time_put_turn="2011-11-14 12:42:40" originator="kosty"  phone="79612242243" 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="2011-11-14 12:42:40" originator="kosty" phone="79612242244" 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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/scheduled.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

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

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/check_change.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

  4. Базы с таким номером не существует

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

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

...

  • time_update

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

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/time.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

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

...

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

Пример

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

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

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

...

списка шаблонов SMS

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/statslist_patterns.php

XML-документ:

Code Block
languagexml
<?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="TELECOM-SMS" 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-документе:

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

error

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

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

  4. Базы с таким номером не существует

  5. Некорректный формат даты

  6. Такой оператор не обнаружен

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

Code Block
languagexml
<?xml version="1.0" encoding="utf-8" ?>
<response>
<stats num_stats="100">
<stat id_sms="324044392" id_state="1229469388" operator="МТС" name_delivery="Кабинет" phone="7980536****" originator="TELECOM-SMS" 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="324044392" id_state="1229469389" operator="МТС" name_delivery="Кабинет" phone="7980536****" originator="TELECOM-SMS" 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

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

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

XML-документ:

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

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/patterns.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?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 добавленных шаблона(если их было не сколько в запросе).

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/list_registry_originator.php

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?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

    • Статус, описание.

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

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/registry_originator.php

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

Code Block
languagexml
<?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 протоколу

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

Code Block
https://имя_хостаclk.prontosms.ru/xml/get_state.php

XML-документ:

...

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

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

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

...

  1. Неправильный формат XML документа

  2. Неправильный логин или пароль

  3. POST данные отсутствуют

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

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

...