Получение списка запланированных сообщений

Спецификации для получение списка запланированных сообщений: XML

Метод отправки POST

Кодировка XML-документов: UTF-8

Обязательный заголовок: Content-type: text/xml; charset=utf-8;

Адрес для запроса: https://my3.webcom.mobi/xml/list_scheduled.php

Параметры запроса на отправку сообщения

Параметр

Тип

Описание

request

.security

.login

[value]*

String

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

request

.security

.password

[value]*

String

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

request

.security

.token

[value]*

String

Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру

request

.scheduled

.[page]

Int

Номер страницы.

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

*- обязательный параметр

В случае получения правильного 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>

Параметр

Тип

Описание

response

.phones

[page]

Int

Номер страницы

response

.phones

[num_pages]

Int

Всего страниц

response

.phones

.scheduled

[id_sms]

Int

Номер сообщения.

Используется для удаления запланированного сообщения

response

.phones

.scheduled

[time_put_turn]

Date

Время добавления в планировщик

response

.phones

.scheduled

[originator]

String

Отправитель сообщения.

Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение

response

.phones

.scheduled

[phone]

Int

Номер абонента, которому адресовано сообщение

response

.phones

.scheduled

[type_sms]

String

Тип SMS сообщения:

viber
sms
flashcall
hlr

response

.phones

.scheduled

[text_sms]

String

Текст сообщения

response

.phones

.scheduled

[count_sms]

Int

Количество частей сообщения

response

.phones

.scheduled

[name_delivery]

String

Название рассылки

response

.phones

.scheduled

[time_send]

Date

Дата и время отправки в формате:

YYYY-MM-DD HH:MM

где, YYYY-год, MM-месяц, DD-день, HH-часы,

MM-минуты

response

.phones

.scheduled

[validity_period]

Date

Дата и время, после которых не будут делаться попытки доставить SMS в формате:

YYYY-MM-DD HH:MM:SS

где, YYYY-год, MM-месяц, DD-день, HH-часы,

MM-минуты

SS-секунды

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

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

Параметр

Тип

Описание

response

.error

String

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

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

Пример XML запроса

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

Last updated 1 year ago