xmlGateDoc

Owned by Алексей Киричек
Last updated: Oct 28, 2022
17 min read

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

На определенный адрес сервера отправляются 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://clk.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_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://clk.prontosms.ru/xml/

XML-документ:

Где

  • type

    • тип отправляемого SMS сообщения:

    • sms – обычная SMS.

  • sender – отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS.

  • text – текст SMS.

  • name_delivery – Название рассылки. По умолчанию "Шлюз";

  • translite

    • транслитерация текста СМС с кириллицы на латиницу (не обязательный параметр). Для транслитерации данный параметр должен быть равен 1.

  • phone – номер абонента, которому адресована SMS. В международном формате, например, 79000000001 (Для России), 380442589632 (Для Украины) и т.д.

  • логин

    • ваш логин в системе.

  • пароль

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

  • 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-документе

error

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

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

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

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

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

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

Где:

  • number_sms

    • номер сообщения указанный при отправке XML документа.

  • id_sms

    • номер SMS сообщения. Используется для проверки статуса SMS. Если в процессе отправки SMS произошла ошибка, то id_sms не передается.

  • parts

    • количество частей SMS.

  • information

    • статус сообщения («send»), если SMS была отправлена. Или сообщение об ошибке, если в процессе отправки SMS произошла ошибка:

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

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

XML-документ:

Где

  • логин

    • ваш логин в системе.

  • пароль

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

  • id_sms

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

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

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

error

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

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

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

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

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

Где

  • 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-документ будет доступен через переменную

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

Где:

  • id_sms

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

  • state

    • статус сообщения:

    1. «send» - статус сообщения не получен. В этом случае передается пустой time (time="").

    2. «not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем).

    3. «expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный Статус (не меняется со временем).

    4. «deliver» - сообщение доставлено. Конечный статус (не меняется со временем).

    5. «partly_deliver» - сообщение было отправлено, но статус так и не был получен. Конечный статус (не меняется со временем). В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки.

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

Где:

  • id_sms

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

  • time

    • время изменения статуса.

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

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

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

XML-документ:

Где

  • логин

    • ваш логин в системе.

  • пароль

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

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

error

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

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

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

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

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

Где:

  • money

    • остаток средств.

  • area

    • направление в котором может быть отправлено данное количество SMS.

  • sms

    • количество доступных SMS сообщений для данного направления.

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

Пример

У вас на балансе 10 y.e.

Стоимость SMS сообщения отправленного в Россию составляет 1 y.e.

Стоимость SMS сообщения отправленного в Украину составляет 2 y.e.

При этом вам вернется XML документ следующего содержания.

Если вы отправите две смс в Россию, то XML-документ изменится следующим образом:

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

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

XML-документ:

Где:

  • логин

    • ваш логин в системе.

  • пароль

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

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

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

error

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

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

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

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

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

Где

  • any_originator

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

  • state

    • статус отправителя: 1. order – оформляется 2. completed - готов к использованию 3. rejected – отклонен

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

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

XML-документ:

Где

  • login value

    • ваш логин в системе.

  • password value

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

  • time start

    • время (не включительно), с которого запрашиваются входящие SMS.

  • time end

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

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

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

error

  •  

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

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

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

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

Где

  • id_sms

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

  • date_receive

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

  • originator

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

  • prefix

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

  • phone

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

  • sms

    • текст смс.

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • phone

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

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

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

error

  •  

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

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

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

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

Где:

  • operator

    • Оператор.

  • region

    • Регион.

  • time_zone

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

  • phone

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

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

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

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

error

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

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

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

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

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

Где:

  • id_base

    • уникальный номер базы в системе.

  • name_base

    • название базы.

  • time_birth

    • время поздравления.

  • local_time_birth

    • читать время поздравления относительно местного времени абонента(yes) или относительно времени системы (no).

  • day_before

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

  • originator_birth

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

  • on_birth

    • включены ли поздравления yes – включены, no - выключены.

  • base

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

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

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

XML-документ:

Где:

  • 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-документе:

error

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

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

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

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

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

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • baseid_base

    • номер базы в системе.

  • basepage

    • номер страницы. Весь список номеров базы делится на страницы. Запросить целиком базу нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички.

  • last_update

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

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

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

error

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

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

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

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

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

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

Где:

  • 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

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

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

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

XML-документ:

Где:

  • 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-документе:

error

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

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

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

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

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

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

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • number_phone

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

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

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

error

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

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

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

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

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

Где:

  • phone

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

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • add_stop phone

    • номер телефона абонента, которого нужно добавить в СТОП-лист.

  • delete_stop phone

    • номер телефона абонента, которого нужно удалить из СТОП-листа.

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

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

error

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

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

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

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

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

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • scheduled page

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

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

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

error

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

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

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

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

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

Где:

  • 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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • delete_schedule id_sms

    • номер запланированной SMS, которую нужно удалить. Можно получить при запросе списка запланированных SMS.

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

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

error

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

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

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

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

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

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • obgect - base

    • базы данных, stop-лист.

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

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

error

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

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

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

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

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

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

Где

  • time_update

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

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

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

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

error

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

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

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

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

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

Где:

  • time

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

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

Пример

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

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

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

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

XML-документ:

Где:

  • 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-документе:

error

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

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

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

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

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

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

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

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

Где:

  • 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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

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

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

error

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

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

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

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

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

Где:

  • id_pattern

    • идентификатор шаблона в системе.

  • name

    • заголовок шаблона.

  • pattern

    • текст шаблона.

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • id_pattern

    • уникальный номер шаблона в системе. Если не указан произойдет добавление базы. При этом нужно указать параметр number_pattern.

  • number_pattern

    • номер шаблона в XML запросе. Используется для сопоставления ID добавленных шаблонов (если их было не сколько в запросе).

  • name

    • заголовок шаблона.

  • pattern

    • текст шаблона.

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

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

error

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

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

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

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

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

Где:

  • id_pattern

    • уникальный номер шаблона sms в системе;

  • action

    • действие, произведенное с шаблоном:

    1. «edit» - изменение параметров шаблона;

    2. «insert» - добавление шаблона;

    3. «not_edit» - не удалось обновить шаблон. Возможно данные идентичны с обновляемым шаблоном;

    4. «delete» - шаблон удалена;

    5. «not_found» - шаблон с указанным идентификатором не обнаружен;

  • number_pattern

    • номер шаблона в JSON запросе. Используется для сопоставления ID добавленных шаблона(если их было не сколько в запросе).

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

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • registry_originator

    • Фильтр вывода реестра имен отправителей:

    • operator

      • Оператор. Доступны такие операторы как: 

      mts

      • МТС, 

      mega

      • Мегафон, 

      tele2

      • Теле2. Необязательное поле.

    • originator

      • Имя отправителя. Необязательное поле.

    • inn

      • Идентификационный номер налогоплательщика. Необязательное поле.

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

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

error

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

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

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

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

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

Где:

  • 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

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

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

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

XML-документ:

Где:

  • 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-документе:

error

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

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

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

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

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

Где:

  • 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 протоколу

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

XML-документ:

Где:

  • login value

    • ваш логин в системе.

  • password value

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

  • get_state

    • Ссылка, в случае редактирования.

    • type

      • Тип запроса (

      set

      • редактирование, 

      get

      • просмотр).

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

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

error

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

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

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

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

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

Где:

  • get_state

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