8 (800) 500-80-16
  • Межгород 8 (800) 500-80-16
  • Санкт-Петербург 7 (812) 426-13-66
  • Москва 7 (495) 374-80-34
  • Новосибирск 7 (383) 207-54-38
  • Екатеринбург 7 (343) 351-75-20
  • Челябинск 7 (351) 799-57-70
  • Воронеж 7 (473) 300-30-34
  • Нижний Новгород 7 (831) 280-98-15
  • Казань 7 (843) 212-20-24
  • Самара 7 (846) 212-98-95
  • Краснодар 7 (861) 201-83-82
  • Ростов-на-Дону 7 (863) 322-03-92

Спецификация XML шлюза

Оглавление
Общие принципы отправки.
Пример передачи XML документа на php:
Отправка SMS, Flash SMS, WAP-Push.
Запрос статуса SMS сообщения (первый способ).
Получение статуса SMS сообщения (второй способ).
Запрос проверки баланса.
Запрос на получения списка отправителей.
Запрос версии программы.
Запрос входящих SMS.
Запрос на получение информации по номеру телефона.
Запрос на получение списка баз.
Запрос на изменение параметров баз.
Запрос на получение списка абонентов базы.
Запрос на добавление/редактирование абонентов базы.
Запрос на удаление абонентов базы.
Запрос на добавление абонентов в СТОП-лист.
Запрос на получение списка запланированных SMS.


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

На определенный адрес сервера отправляются 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 = 'http://gt.smsgold.ru/script.php'; // адрес сервера
$res = '';

$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-type: text/xml; charset=utf-8'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
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);
$res = $result;
curl_close($ch);
echo $res;

Отправка SMS, Flash SMS, WAP-Push.

Адрес сервера:
http://gt.smsgold.ru/xml/

XML-документ:
<?xml version="1.0" encoding="utf-8" ?>
<request>
<message type="flashsms или sms или wappush или vcard">
<sender>Отправитель 1</sender>
<text>Текст сообщения 1</text>

<url>Адрес для WAP Push или vCard</url>
<name>Имя для vCard</name>
<phone cell="79811609807" work="79811609807" fax="79811609807"/>
<email>E-mail vCard</email>
<position>Должность vCard</position>
<organization>Организация vCard</organization>
<address post_office_box="абонентский ящик" street="Улица" city="город" region="Область" postal_code="Индекс" country="Страна"/>
<additional>Дополнительная информация vCard</additional>

<abonent phone="79811609807" number_sms="1" client_id_sms="101" time_send="2001-12-31 12:34" validity_period="2001-12-31 15:34"/>
<abonent phone="79811609807" number_sms="2" client_id_sms="102" time_send="2001-12-31 12:35"/>
...
<abonent phone="79811609807" number_sms="10" client_id_sms="110" time_send=""/>
</message>
<message>
<sender>Отправитель 2</sender>
<text>Текст сообщения 2</text>
<abonent phone="79811609807" number_sms="11" client_id_sms="111"/>
<abonent phone="79811609807" number_sms="12" client_id_sms="112"/>
...
<abonent phone="79811609807" number_sms="20" client_id_sms="120"/>
</message>
...
<security>
<login value="логин" />
<password value="пароль" />
</security>
</request>

Где,
type – тип отправляемого SMS сообщения:
flashsms – flash SMS
sms – обычная SMS
wappush – WAP-Push
vcard – визитная карточка (vCard)

sender – отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS.
phone – номер абонента, которому адресована SMS.
login value - ваш логин в системе
password value - ваш пароль в системе
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 имеет максимальный срок жизни.

Далее поля выбираются в зависимости от типа отправляемого SMS (type):
text – текст обычного SMS или описание WAP ссылки.
url – ссылка для WAP Push или vCard
name - имя для vCard
cell – номер телефона для vCard
work - номер рабочего телефона для vCard
fax - номер факса для vCard
email - e-mail для vCard
position – должность контакта для vCard
organization - организация для vCard
post_office_box - абонентский ящик для vCard
street – улица для vCard
city – город для vCard
region – область для vCard
postal_code – индекс для vCard
country - страна для vCard
additional - дополнительная информация для vCard

В ответ может быть выдан один из следующих 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 отклонен модератором.
  9. Нет отправителя.
  10. Отправитель не должен превышать 15 символов для цифровых номеров и 11 символов для буквенно-числовых.
  11. Номер телефона должен быть меньше 15 символов.
  12. Нет текста сообщения.
  13. Нет ссылки.
  14. Укажите название контакта и хотя бы один параметр для визитной карточки.
  15. Такого отправителя нет.
  16. Отправитель не прошел модерацию.

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

Адрес сервера:
http://gt.smsgold.ru/xml/state.php

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

Где,
login value - ваш логин в системе
password value - ваш пароль в системе
id_sms - номер SMS сообщения, полученный в ответном XML-документа в процессе отправки 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>
<state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46">Статус</state>
<state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46">Статус</state>
<state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46">Статус</state>
</response>

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

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

Получение статуса 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 в системе для проверки статуса">Статус</state>
<state id_sms="ID SMS в системе для проверки статуса">Статус</state>
</request>

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

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

В ответ сервер клиента должен вернуть 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 сообщения.

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

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

Адрес сервера:
http://gt.smsgold.ru/xml/balance.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>
<money>150</money>
<sms area="Россия">111</sms>
<sms area="Украина">111</sms>
</response>

Где,
money – остаток средств.
area – направление в котором может быть отправлено данное количество SMS.
sms – количество доступных SMS сообщений для данного направления.

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

Пример
У вас на балансе 10 руб.
Стоимость SMS сообщения отправленного в Россию составляет 0,5 руб.
Стоимость SMS сообщения отправленного в Украину составляет 1,5 руб.

При этом вам вернется XML документ следующего содержания.
<?xml version="1.0" encoding="utf-8" ?>
<response>
<money>10</money>
<sms area="Россия">20</sms>
<sms area="Украина">6</sms>
</response>

Если вы отправите две смс в Россию, то XML-документ изменится следующим образом:
<?xml version="1.0" encoding="utf-8" ?>
<response>
<money>8</money>
<sms area="Россия">10</sms>
<sms area="Украина">3</sms>
</response>

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

Адрес сервера:
http://gt.smsgold.ru/xml/originator.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>
<any_originator>FALSE</any_originator>
<list_originator>
<originator state="rejected">Отправитель</originator>
</list_originator>
</response>

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

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

 

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

Адрес сервера:
http://gt.smsgold.ru/xml/incoming.php

XML-документ:
<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
<time start="2012-01-31 12:23:00" end="2012-02-31 12:23:00" />
</security>
</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="2012-01-31 12:55:55" originator="79811609807" prefix="IGRA" phone="79811609807">Текст СМС.</sms>
<sms id_sms="1234" date_receive="2012-01-31 12:55:55" originator="79811609807" prefix="IGRA" phone="79811609807">Текст СМС.</sms>

</response>

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

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

Адрес сервера:
http://gt.smsgold.ru/xml/def.php

XML-документ:
<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
</security>
<phones>
<phone>79811609807</phone>
<phone>79811609807</phone>
</phones>
</request>

Где,
login value - ваш логин в системе
password value - ваш пароль в системе
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 operator="МТС" region="Санкт Петербург" time_zone="3">79811609807</phone>
<phone operator="Вымпел телеком" region="Калининград " time_zone="-1">79811609807</phone>

</response>

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

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

Адрес сервера:
http://gt.smsgold.ru/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" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
<base id_base="1235" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>

</response>

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

Запрос на изменение параметров баз.

Адрес сервера:
http://gt.smsgold.ru/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" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
<base number_base="1" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>

</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>

</response>

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

Адрес сервера:
http://gt.smsgold.ru/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”/>
</request>

Где,
login value - ваш логин в системе
password value - ваш пароль в системе
base id_base – Номер базы в системе.
base page – Номер страницы. Весь список номеров базы делится на страницы. Запросить целиком базу нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички.

 

В ответ может быть выдан один из следующих 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="79119302990" region="Санкт-Петербург " operator="МТС" name="Виталий" surname="Иванов" patronymic="Михайлович" date_birth="1984-08-21" male="m" addition_1="Первое дополнительное поле" addition_2="второе" />
<phone phone="79119302990" region="Москва " operator="Вымпелком" name="Виталий" surname="Иванов" patronymic="Михайлович" date_birth="1984-08-21" male="m" addition_1="Первое дополнительное поле" addition_2="второе" />

</phones>
</response>

Где,
page – номер страницы
num_pages – всего страниц

phone – номер телефона абонента
region – регион
operator – оператор
name – Имя абонента
surname – Фамилия абонента
patronymic – Отчество абонента
date_birth – Дата рождения
male – Пол. «m» - мужской, «f» - женский
addition_1 – Первое дополнительное поле.
addition_2 – Второе дополнительное поле.

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

Адрес сервера:
http://gt.smsgold.ru/xml/phones.php

XML-документ:
<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
</security>
<base id_base="1234">
<phone phone="79811609807" region="Новосибирск " operator="Вымпелком" name="Виталий" surname="Иванов" patronymic="Михайлович" date_birth="1975-04-26" male="m" addition_1="Первое дополнительное поле" addition_2="второе" />
<phone phone="79811609807" region="Новосибирск " operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1975-04-26" male="m" addition_1="Первое дополнительное поле" addition_2="второе" />

</base>
</request>

Где,
login value - ваш логин в системе
password value - ваш пароль в системе
base id_base – Номер базы в системе.
phone – номер телефона абонента. Если абонент с таким номером уже существует, то он будет отредактирован.
region – регион. Необязательное поле. Если не задано определяется автоматически.
operator – оператор. Необязательное поле. Если не задано определяется автоматически.
name – Имя абонента. Необязательное поле.
surname – Фамилия абонента. Необязательное поле.
patronymic – Отчество абонента. Необязательное поле.
date_birth – Дата рождения. Необязательное поле.
male – Пол. «m» - мужской, «f» - женский. Необязательное поле.
addition_1 – Первое дополнительное поле. Необязательное поле.
addition_2 – Второе дополнительное поле. Необязательное поле.

 

В ответ может быть выдан один из следующих 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>
</response>

Где,

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

Адрес сервера:
http://gt.smsgold.ru/xml/delete_phones.php

XML-документ:
<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
</security>
<base id_base="1234">
<phone phone="79811609807" />
<phone phone="79811609807" />

</base>
</request>

Где,
login value - ваш логин в системе
password value - ваш пароль в системе
base id_base – Номер базы в системе.
phone – номер телефона абонента, которого нужно удалить.

В ответ может быть выдан один из следующих 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>
<phone phone="79811609807">delete</phone>
<phone phone="79811609807">not_found</phone>

</response>

Где,

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

Адрес сервера:
http://gt.smsgold.ru/xml/stop.php

XML-документ:
<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
</security>
<add_stop>
<phone phone="79811609807” />
<phone phone="79811609807" />

</add_stop>
<delete_stop>
<phone phone="79811609807” />
<phone phone="79811609807" />

</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="79811609807">delete</phone>
<phone phone="79811609807">add</phone>
<phone phone="79811609807">not_found</phone>

</response>

Где,

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

Адрес сервера:
http://gt.smsgold.ru/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="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-DD HH:MM
где, YYYY-год, MM-месяц, DD-день, HH-часы, MM-минуты.
validity_period – дата и время, после которых не будут делаться попытки доставить SMS в формате:
YYYY-MM-DD HH:MM:SS
где, YYYY-год, MM-месяц, DD-день, HH-часы, MM-минуты, SS-секунды.

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

Адрес сервера:
http://gt.smsgold.ru/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>