Versions Compared

Old Version 3

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;

...

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

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>

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

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

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

XML-документ:

...

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

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

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>

...

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

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>

...

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

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>

...

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

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>

...

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

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>

...